RuleDataSetKeys

This component runs the Rule Data Set Keys (RDK) function.

Methods

Closed
Driver Type: SASI
Use this method to change the status to Closed.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more rule data set keys.
Delete
Driver Type: SASI
Use this method to delete a rule data set key.
Hidden
Driver Type: SASI
Use this method to change the status to Hidden.
Open
Driver Type: SASI
Use this method to change the status to Open.
Query
Driver Type: Export
Use this method to obtain rule data set key details or to extract rule data set key data from SunSystems.
Suspended/Held
Driver Type: SASI
Use this method to change the status to Suspended/Held.

Mandatory fields

When creating or amending a rule data set key, you must be supply the Lookup Code - payload element <LookUpCode>

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

  • Standard Text
  • Standard Text Language

The attachment of Standard Text is supported by the CreateOrAmend method. If the standard text supplied in the payload does not exist then it is created. However, it is not possible to amend existing standard text by this means; existing standard text is attached by key only, and any non-key fields in the SSC payload are ignored. Standard text can be amended using the Standard Text Language Variants function from SunSystems or the SSC component StandardTextLanguageVariants.

The standard text to be attached is language specific and therefore must be included within the StandardTextLang part of the payload in order to be detected by the SSC component, as shown in the following example:

<RuleDataSetKeys>
	...
		<StandardText>
			<StandardTextLang>
				<Description>Delivery</Description>
				<LanguageCode>1</LanguageCode>
				<Paragraph1>Follow the special Instructions on the Invoice</Paragraph1>
				<ShortHeading>Delivery</ShortHeading>
				<StandardTextClassCode>SALES</StandardTextClassCode>
				<StandardTextCode>DELIVERY</StandardTextCode>
			</StandardTextLang>
		</StandardText>
</RuleDataSetKeys>