This component runs the Analysis Dimensions (AND) function.
Methods
- Amend
- Driver Type: SASI
- Use this method to amend one or more analysis dimensions. If an analysis dimension
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 analysis dimensions to Closed.
- Create
- Driver Type: SASI
- Use this method to create one or more analysis dimensions. If an analysis dimension
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 dimensions.
- CreateOrAmend
- Driver Type: SASI
- Use this method to create or amend one or more analysis dimensions. An analysis
dimension is created if it does not exist and amended it if does. Both the Create and
Amend methods require you to know in advance if the analysis dimension exists, whereas
this method can be used if you are unsure.
-
Note: In SunSystems, you have the
option of copying across existing analysis codes. You can specify whether the
component is to do this within the payload method context.
- CreateReplaceOrDelete
- Driver Type: SASI
- Use this method to synchronize analysis dimensions. An analysis dimension is created
if it does not exist already and replaced if it does. If an analysis dimension does not
exist in the originating business unit, it is deleted.
- Hidden
- Driver Type: SASI
- Use this method to change the status of one or more analysis dimensions to Hidden.
- Open
- Driver Type: SASI
- Use this method to change the status of one or more analysis dimensions to Open.
- Query
- Driver Type: Export
- You can use this method to obtain analysis dimension details or to extract analysis
dimension data from SunSystems.
- SuspendedHeld
- Driver Type: SASI
- Use this method to change the status of one or more analysis dimensions to Suspended/Held.
Mandatory fields
For all methods, except for the Query method where it is optional, a value
must be supplied for the Analysis Dimension Short Heading - payload element <AnlCat_SHead>.
Note: This element
identifies to which analysis dimension the method is to be applied. Do not use the Analysis
Category ID (payload element <AnlCat_AnlCatId>) as
it is not used for this purpose.
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.