StandardTextLanguageVariant

This component runs the Standard Text Language Variants (STL) function.

Note: Standard text is set up using the Standard Text Classes and Standard Text Language functions. If your system is serialized for Multi-Lingual functionality, you must specify a language code for the standard text. This enables you to apply the correct language of the text for the operator.

Methods

Amend
Driver Type: SASI
Use this method to amend standard text. This method only amends standard text. If the standard text does not exist, an error message is produced and the payload is rejected.
Create
Driver Type: SASI
Use this method to create standard text. This method only creates standard text. If the standard text already exists, an error message is produced and the payload is rejected.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend standard text. Standard text is created if it does not exist and amended if it does. Both the Create and Amend methods depend on you to know whether the data does or does not exist in advance, whereas this method can be used if you are unsure.
Delete
Driver Type: SASI
Use this method to delete standard text.
Query
Driver Type: Export
Use this method to obtain standard text details or to extract standard text data from SunSystems.

Mandatory fields

When creating, amending or deleting a standard text language variant, values for the following must be supplied.

  • Standard Text Class Code - payload element <StandardTextClassCode>
  • Standard Text Code - payload element <StandardTextCode>
  • Language Code - payload element <LanguageCode>
Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

None.