ApprovalTables

This component runs the Approval Tables (ATS) function used within approvals.

Methods

Closed
Driver Type: SASI
Use this method to change the status of one or more approval tables to Closed.
CreateAsDraft
Driver Type: SASI
Use this method to create one or more draft approval tables.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more approval tables. An approval table is created if it does not exist and amended if it does.
If the payload values for these fields do not match existing record values then a new record is created. Therefore to amend one of the identifying values, for example, LimitAmount, you must delete the existing record then create a new one.
The CreateOrAmend method identifies existing records using these fields:
  • ApprovalTables.Levels.LimitAmount
  • ApprovalTables.Levels.AnalysisCodeBasis1From
  • ApprovalTables.Levels.AnalysisCodeBasis1To
  • ApprovalTables.Levels.AnalysisCodeBasis2From
  • ApprovalTables.Levels.AnalysisCodeBasis2To
  • ApprovalTables.Levels.AnalysisCodeBasis3From
  • ApprovalTables.Levels.AnalysisCodeBasis3To
Hidden
Driver Type: SASI
Use this method to change the status of one or more approval table to Hidden.
Open
Driver Type: SASI
Use this method to change the status of one or more approval table to Open.
Query
Driver Type: Export
Use this method to obtain approval table details or to extract approval table data from SunSystems.
SuspendedHeld
Driver Type: SASI
Use this method to change the status of one or more approval tables to Suspended/Held.

Mandatory fields

When creating or amending approval tables, the following must be supplied:

  • Approval Tables Short Heading - payload element <ShortHeading>
  • Approval Tables Limit Amount - payload element <LimitAmount>.
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

  • Analysis Dimension Heading 1
  • Analysis Dimension Heading 2
  • Analysis Dimension Heading 3
  • Levels
  • Value Label
  • Standard Text
  • Standard Text Language

The attachment of Standard Text is supported by the CreateAsDraft and CreateOrAmend methods. 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:

<ApprovalTables>
	...
		<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>
</ApprovalTables>