StandardTextClasses

This component runs the Standard Text Classes Setup (STC) 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 a standard text class. This method is only amends a standard text class. If the standard text class does not exist, an error message is produced and the payload is rejected.
Closed
Driver Type: SASI
Use this method to change the status of one or more standard text classes to Closed.
Create
Driver Type: SASI
Use this method to create a standard text class. This method only creates a standard text class. If the standard text class already exists, an error message is produced and the payload is rejected.
CreateAsDraft
Driver Type: SASI
Use this method to create one or more draft standard text classes.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more standard text classes. A standard text class is created if it does not exist and amended if it does. Both the Create and Amend methods require you to know in advance if the standard text class exists, whereas this method can be used if you are unsure.
Delete
Driver Type: SASI
Use this method to delete standard text classes.
Hidden
Driver Type: SASI
Use this method to change the status of one or more standard text classes to Hidden.
Open
Driver Type: SASI
Use this method to change the status of one or more standard text classes to Open.
Query
Driver Type: Export
Use this method to obtain standard text class details or to extract standard text class data from SunSystems.
Suspended/Held
Driver Type: SASI
Use this method to change the status of one or more standard text classes to SuspendedHeld.

Mandatory fields

  • When creating, amending or deleting a standard text class, a value must be supplied for the Standard Text Class Code - payload element <StandardTextClassCode>.
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.