AnalysisCodes

This component runs the Analysis Codes (ANC) function.

Note: If running a Create method you must supply an existing analysis dimension code and a new unique analysis code.

From version 5.1.5 onwards the Analysis Dimension Short Heading is used to identify the analysis dimension rather than the analysis dimension code.

Methods

Amend
Driver Type: SASI
Use this method to amend one or more analysis codes. If an analysis code does not exist, an error message is produced and the payload is rejected.
BulkCreateOrAmend
Driver Type: DJI
Use this method for the bulk loading of data or bulk amendment of data, or where performance is critical.
Note: Although the SASI method accepts dates and periods with slashes, the DJI method does not and expects dates in ddmmyyyy format and periods in pppyyyy format.
Closed
Driver Type: SASI
Use this method to change the status of one or more analysis codes to Closed.
Create
Driver Type: SASI
Use this method to create one or more analysis codes. If an analysis code 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 analysis codes.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more analysis codes. If an analysis code does not exist it is created and if it does it exist it is amended. Both the Create and Amend methods require you to know in advance if an analysis code exists or not, whereas this method can be used if you are unsure.
CreateReplaceOrDelete
Driver Type: SASI
Use this method to synchronize analysis codes. An analysis code is created if it does not exist already and replaced if it does. If an analysis code does not exist in the originating business unit, it is deleted.
Delete
Driver Type: SASI
Use this method to delete one or more analysis codes.
Hidden
Driver Type: SASI
Use this method to change the status of one or more analysis codes to Hidden.
Open
Driver Type: SASI
Use this method to change the status of one or more analysis codes to Open.
Query
Driver Type: Export
Use this method to obtain analysis code details or to extract analysis code data from SunSystems.
SuspendedHeld
Driver Type: SASI
Use this method to change the status of one or more analysis codes to Suspended/Held.

Mandatory fields

When creating or amending analysis codes, the following must be supplied:

  • Analysis Code - payload element <AnalysisCode>

  • Analysis Dimension ID Short Heading - payload element <AnalysisCatID.AnlCat_SHead>

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

  • DAG
  • Analysis Dimension ID
  • Standard Text
  • Standard Text Language
The attachment of Standard Text is supported by these methods:
  • Amend
  • BulkCreateOrAmend
  • Create
  • CreateAsDraft
  • CreateOrAmend
  • CreateReplaceOrDelete
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:

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