XML Legend
Color Codes
XML elements and attributes are geometrically color-coded to quickly signal whether or not they are required.
Elements
🟥 Required
(Type)
🟦 Optional
(Type, Default)
*
Asterisk means "multiple elements are allowed".
- "Type" is a top-level explanation of the function of the data element (explained in the first table below).
- "Multiple" means that the element may occur more than once.
Attributes
- 🔸
Required
(Format) - 🔹
Optional
(Format, Default)
Types
XML elements and attributes are classified as one of the following types:
Type | Description |
---|---|
Module | The root level element that functions as an empty parent element that signals the Module request for calculation |
Parent | An empty element with child elements and attributes |
Child | Element is a child element of a parent |
Empty | An element whose data is packaged solely as attributes |
Format | Data is to be provided within strict formatting requirements. Please see the Formats table below. |
Formats
Data sent to the SCEX via element and attribute values is parsed according to the expected format, each of which is described below:
Format | data | example | description |
---|---|---|---|
boolean | true, false, 1, 0 | false | Used when data requires only a true or false result |
range | Contiguous data | [1..120] | A contiguous set of numeric values captured in brackets, such as the exemplified "all integers from 1 to 120." |
enum | Set of labels | [nearest, up, down] | An 'enum' is an enumeration of isolated values often defined with a linked table |
date | YYYY-MM-DD | 2024-01-23 | Dates are packaged as standard xml dates (See the <Format> element for other options.) |
currency | Cash values | 10021.31 | A number appropriate for a country's currency is expected |
decimal | decimal data | 5.321 | A generic designation for a number that may contain decimals. e.g. An interest rate |
integer | whole number | 120 | A generic designation for a non-negative integer |
text | A sequence of characters | "DocFee" or "" | Pure text, often for names |
char | A single character | "." or "" | A single character or the absence of a character |