Analysis Hierarchy Labels - Input Payload Element Definitions
Payload elements are defined as follows:
| Element | Data Type | Description |
| <SSC> | Top-level element | |
| <User> | User element | |
| <Name> | Alphanumeric, length 3. Must be a valid SunSystems user. | User Name Specify the User Id for the payload. This User Id must already be set up in SunSystems using Security Console or User Manager prior to executing the payload. |
| <SunSystemsContext> | Used to specify high-level information that is used at runtime to identify which Business Unit is to be used. | |
| <BusinessUnit> | Alphanumeric, length 3. Must be a valid SunSystems Business Unit. | Business Unit Specify the Business Unit that you wish to
use.
Note: If this element value is blank, the component defaults to
the demonstration PKP Business Unit.
|
| <Payload> | High-level element that is used to flag the start of the data. A payload file must only contain one <Payload> element. | |
| <AnalysisHierarchyLabels> | High-level element that is used to flag the start of an Analysis Hierarchy Labels data element. A payload file must contain at least one of these. There is no limit to the number of <AnalysisHierarchyLabels> that can be present within a <Payload> element. | |
| <AnalysisDimension> | Optional. Numeric, length 2. Must be a valid SunSystems Analysis Dimension. | Analysis Dimension Specify the Analysis Dimension
applicable for the Analysis Hierarchy Labels and Codes. This element is
provided for
SunSystems
developers as the value specified here is the internal
SunSystems
database representation, for example, 13.
Note: If you are not a developer, you should specify the Analysis
Dimension using the <AnlCat_SHead> element and remove this element from
your payload. See <AnlCat_SHead>.
|
| <AnalysisHierarchyLabel> | Mandatory. Alphanumeric, length 15. | Analysis Hierarchy Label - User definable code used to identify an Analysis Hierarchy Label within an Analysis Dimension. |
| <DateTimeLastUpdated> | Used only for output. Any value present in an input payload is ignored. | |
| <Description> | Optional. Alphanumeric, length 40. | Label description. If <Description> is omitted, the <ShortHeading> value is copied to <Description>. An error is generated if values for both <Description> and <ShortHeading> are missing from the payload. |
| <LookupCode> | Optional. Alphanumeric, length 15. | An alternative user-defined identifying code for a Label.Converted to uppercase at runtime. |
| <ShortHeading> | Optional. Alphanumeric, length 15. | User-definable abbreviated description for use on reporting or forms where the full description is too long. If <ShortHeading> is omitted, the first 15 characters of <Description> are copied to <ShortHeading>. An error is generated if values for both <Description> and <ShortHeading> are missing from the payload. |
| <Status> | Optional. Numeric, length 1. | Label status. Must be one of the following: 0=Open (default) 1=Hidden 2=Suspended/Held 3=Closed. |
| <UpdateCount> | Used only for output. Any value present in an input payload is ignored. | |
| <UserIdLastUpdated> | Used only for output. Any value present in an input payload is ignored. | |
| <AnalysisCatID> | High level element used to specify an Analysis Dimension in its text equivalent. | |
| <AnlCat_SHead> | Optional. Alphanumeric, length 15. Must be a valid document.write(product_line) SunSystems Analysis Dimension. | Analysis Dimension Specify the Analysis Dimension applicable for the Analysis Hierarchy Labels and Codes. This element is provided for SunSystems users. The value specified here is the text representation displayed on the SunSystems NHS function, Analysis Hierarchy Labels, for example PROJECT'. |
| <AnalysisHierarchyCodes> | High-level element that is used to flag the start of an Analysis Hierarchy Codes data element. A payload file must contain at least one of these. There is no limit to the number of <AnalysisHierarchyCodes> that can be present within an <AnalysisHierarchyLabels> element. | |
| <AnalysisDimension> | Optional. Numeric, length 2. | Analysis Dimension Specify the Analysis Dimension applicable for the Analysis Hierarchy Code. Must be the same Analysis Dimension as that specified for the parent Label. If omitted, the <AnalysisDimension> value for the parent Label is used. |
| <AnalysisHierarchyCode> | Mandatory. Alphanumeric, length 15. | Analysis Hierarchy Code - user-definable code for an Analysis Hierarchy Label. |
| <AnalysisHierarchyLabel> | Optional. Alphanumeric, length 15. | Analysis Hierarchy Label - User-definable code used to identify an Analysis Hierarchy Label within an Analysis Dimension. If omitted, the <AnalysisHierarchyLabel> value for the parent Label is used. |
| <DateTimeLastUpdated> | Used only for output. Any value present in an input payload is ignored. | |
| <Description> | Optional. Alphanumeric, length 40. | Analysis Hierarchy Code description. If <Description> is omitted, the <ShortHeading> value is copied to <Description>. An error is generated if values for both <Description> and <ShortHeading> are missing from the payload. |
| <LookupCode> | Optional. Alphanumeric, length 15. | An alternative user-defined identifying code for an Analysis Hierarchy Code. Converted to uppercase at runtime. |
| <ShortHeading> | Optional. Alphanumeric, length 15. | User-definable abbreviated description for the Analysis Hierarchy Code and used on reporting or forms where the full description is too long. If <ShortHeading> is omitted, the first 15 characters of <Description> are copied to <ShortHeading>. An error is generated if values for both <Description> and <ShortHeading> are missing from the payload. |
| <Status> | Optional. Numeric, length 1. | Analysis Hierarchy Code status. Must be one of the following: 0=Open (default) 1=Hidden 2=Suspended/Held 3=Closed. |
| <UpdateCount> | Used only for output. Any value present in an input payload is ignored. | |
| <UserIdLastUpdated> | Used only for output. Any value present in an input payload is ignored. |