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:

TypeDescription
ModuleThe root level element that functions as an empty parent element that signals the Module request for calculation
ParentAn empty element with child elements and attributes
ChildElement is a child element of a parent
EmptyAn element whose data is packaged solely as attributes
FormatData 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:

Formatdataexampledescription
booleantrue, false, 1, 0falseUsed when data requires only a true or false result
rangeContiguous data[1..120]A contiguous set of numeric values captured in brackets, such as the exemplified "all integers from 1 to 120."
enumSet of labels[nearest, up, down]An 'enum' is an enumeration of isolated values often defined with a linked table
dateYYYY-MM-DD2024-01-23Dates are packaged as standard xml dates (See the <Format> element for other options.)
currencyCash values10021.31A number appropriate for a country's currency is expected
decimaldecimal data5.321A generic designation for a number that may contain decimals. e.g. An interest rate
integerwhole number120A generic designation for a non-negative integer
textA sequence of characters"DocFee" or ""Pure text, often for names
charA single character"." or ""A single character or the absence of a character