Analysis Hierarchy Assign Codes - Input Payload Overview

The input payload is divided into three sections:

  • <User> identifies the User.
  • <SunSystemsContext> identifies the Business Unit.
  • <AnalysisHierarchyAssignCodes> contains the data items that identify the Analysis Code to be assigned and which particular Analysis Hierarchy Label and Code it is to be assigned to.

For further information, refer to Input Payload Element Definitions section.

Specifying the Analysis Hierarchy

You must first ensure the Analysis Codes, the Analysis Hierarchy Labels and the Analysis Hierarchy Codes that you wish to use have been set up already, and that they are all set up for the same Analysis Dimension.

In the payload, you can specify the Analysis Dimension as either the text equivalent that is displayed in SunSystems, for example, 'ACCOUNT CODE' or its internal document.write(product_line) SunSystems database representation, '18'. (This feature is intended for use by developers.)

The following table shows the values for Analysis Dimensions, with the SunSystems database representation and the matching text equivalent:

Database Representation Text Equivalent
02 BUSINESS TYPE
03 LEAD SOURCE
04 REPORT GROUP
05 ACCOUNT MANAGER
06 ASSET CLASS
07 ASSET LOCATION
08 ASSET SUPPLIER
09 ASSET INSURER
10 ASSET MAINTAIN
11 PRODUCT DEPARTMENT
12 DEPARTMENT
13 PROJECT
14 EMPLOYEE
15 CUSTOMER
16 TAX
17 LOCATION (ANL)
18 ACCOUNT CODE
19 ASSET
20 CURRENCY
21 ZONE
22 WAREHOUSE
23 SUPPLIER
24 SALES TYPE
25 MOVEMENT TYPE
26 REPORT LOCAL
27 ITEMCODE
28 CUST TYPE
29 CUST VAT
30 UNIT LABEL

Analysis Hierarchy Relationships

It may help to think of the Analysis Dimension as a parent of an AnalysisHierarchyLabel and an AnalysisHierarchyLabel as the parent of an AnalysisHierarchyCode. That is, an AnalysisHierarchyCode 'belongs' to an AnalysisHierarchyLabel that in its turn 'belongs' to an Analysis Dimension.

When assigning Analysis Codes, you must ensure that the correct AnalysisDimension or AnlCat_SHead payload value is the correct one for the AnalysisHierarchyLabel payload value, and that the AnalysisHierarchyLabel value is the correct one for the AnalysisHierarchyCode payload value.

Case Conversion

Any character you type in the following fields is automatically converted on the screen into upper case:

  • Analysis Dimension
  • Analysis Hierarchy Label
  • Analysis Hierarchy Code
  • Analysis Code.

SASI/DJI Differences

Whilst this DJI method replicates (as far as possible) the SunSystems Connect SASI AnalysisHierarchyLabels CreateOrAmend method, there are the following differences:

  • In the DJI method some error messages have been clarified.
  • The DJI method issues an error message if an invalid Analysis Dimension ( <AnalysisDimension>) value is specified. The SASI method ignores the Analysis Dimension ( <AnalysisDimension>) value and uses the <AnlCat_SHead> value instead.
  • The DJI method does not issue an error message if the <AnlCat_SHead> value is omitted from the payload and instead uses the Analysis Dimension ( <AnalysisDimension>) value if specified, (this feature is intended for use by developers). The SASI method requires a value for the <AnlCat_SHead> element to be present and ignores the <AnalysisDimension> value.
  • The DJI method issues an error message if the <AnlCat_SHead> value and the Analysis Dimension ( <AnalysisDimension>) value refer to different Analysis Dimensions. For example, where <AnalysisDimension> is specified as '11', (corresponding to 'PRODUCT') and <AnlCat_SHead> is specified as 'ACCOUNT CODE', (corresponding to Analysis Dimension '18'). This feature is designed for developers. The SASI method ignores the inconsistency of the data and uses the <AnlCat_SHead> value instead.