Use the Mapping Function to describe the purpose of the
function, set valid input parameters and syntax, and set what the
function returns.
Mapping function topic descriptions include the following:
Mapping functions can process the following datatypes:
- anysimpletype
- Any type of data is allowed including numbers, strings, dates,
or boolean.
- boolean
- Either true or false.
- date
- A string representing a date in the format YYYY-MM-DD (see datetime for
the component descriptions).
- datetime
- A string representing a date and time in the format:YYYY-MM-DDThh:mm:ss.ssss
Where:
- YYYY = year
- MM = month
- DD = day
- T = date/time separator character
- hh = hour
- mm = minute
- ss = second
- ssss = optional millisecond
- day
- A string representing the day portion of a date in the format:
DD
- dt
- Several different date or time datatypes can be supplied. See
the description of the parameter for a list of the datatypes that
are valid.
- duration
- A string representing a time interval in the form [-]PnYnMnDTnHnMnS:
- [-] = an optional minus sign
- P = period indicator
- nY = the number of years
- nM = the number of months
- nD = the number of days
- T = date/time separator
- nH = the number of hours
- nM = the number of minutes
- nS = the number of seconds
- empty string
- A string with no contents (for example, ''). This is typically
returned for error conditions when the result is normally a string.
- month
- A string representing the month portion of a date in the format:
MM
- monthday
- A string representing the month and day portion of a date in the
format: MM-DD
- nodeset
- A set of nodes within the schema. Node sets are identified by
a specific path to a node or structure in the schema. Node sets are
used in certain math functions. The datatype of the nodes within the
set should be number.
- number
- Any integer or decimal number including:
- positive and negative zero
- positive and negative infinity
- NaN (This is a value indicating that the result is not a number.)
- string
- Text characters within the character encoding of the message
- time
- A string representing a time of day in the format:
hh:mm:ss.sss[-time-zone-indicator]
See datetime for
the component descriptions.
- tm
- Several different time datatypes can be supplied. See the description
of the parameter for a list of the datatypes that are valid.
- year
- A string representing the year portion of a date in the format:
YYYY
- yearmonth
- A string representing the year and month portion of a date in
the format: YYYY-MM