i4SCADA Knowledge Base

WCF Symbolic TextService Documentation

Abstract

The WCF Symbolic TextService handles all the Symbolic Texts related operations. This article describes all the available methods.

This WCF web service handles all the Symbolic Texts related operations. The following methods are available:

GetSymbolicTextTranslations

Syntax

GetSymbolicTextTranslations(int[] languageIDs, int startIndex, int count, IncludedSymbolicTexts includedSymbolicTexts);

Description

Retrieves the text translations, based on the provided language id's, index and count, for all symbolic texts of the specified type

Parameters

  • languageIDs (int[]) - the list of ids of the languages in which the text translations to be retrieved

  • startIndex (int ) - the starting index from where the text translations are retrieved

  • count (int ) - the number of text translations to be retrieved

  • includedSymbolicTexts (IncludedSymbolicTexts ) - the enumeration of symbolic texts types for which to retrieve the translations. Can be:

    • SymbolicTexts = 0

    • InternallyUsed = 1

    • AlarmGroups = 2

    • AlarmTypes = 4

    • Alarms = 8

    • AlarmHelpTexts = 16

    • ExtendedAlarmProperties = 32

    • Signals = 64

    • SignalGroups = 128

    • Logs = 256

    • DiscreteValues = 512

    • All = 1024

Return Value

A list of SymbolicTextDTO objects, each containing:

  • SymbolicText (string) - the symbolic text to which the translation is associated

  • Translations (List<SymbolicTextTranslationDTO>) - the list of symbolic text translations data transfer objects, each containing:

    • LanguageID (int) - the id of the language of the translation

    • Tranlsation (string) - the translated text

GetSpecificSymbolicTextTranslations

Syntax

GetSpecificSymbolicTextTranslations(int[] languageIDs, string[] symbolicTexts);

Description

Retrieves the translation texts for the provided symbolic texts, based on the specified language

Parameters

  • languageIDs (int[]) - the list of ids of the languages in which the text translations to be retrieved

  • symbolicTexts (string[]) - the list of symbolic texts for which the translations to be retrieved

Return Value

A list of SymbolicTextDTO objects, each containing:

  • SymbolicText (string) - the symbolic text to which the translation is associated

  • Translations (List<SymbolicTextTranslationDTO>) - the list of symbolic text translations data transfer objects, each containing:

    • LanguageID (int) - the id of the language of the translation

    • Tranlsation (string) - the translated text

GetActiveLanguageIDs

Syntax

GetActiveLanguageIDs();

Description

Retrieves the ids of the active languages

Parameters

None

Return Value

A list of ids corresponding to the languages set as active in the system

GetAllLanguages

Syntax

GetAllLanguages();

Description

Retrieves all available languages in the system

Parameters

None

Return Value

A list of LanguageDTO objects, each containing:

  • Id (int) - the id of the language

  • Name (string) - the name of the language

  • IsActive (bool) - the flag that indicates if the language is active or not

  • IsDefault (bool) - the flag that indicates if the language is the default language or not