Formula Parameter Formats
Formula parameters can be given in XML format or JSON format.
XML format
The listing below shows formula parameters in XML format.
<?xml version="1.0" encoding="utf-8"?>
<options:formula-parameters
xmlns:options="https://www.altova.com/schemas/altova/raptorxml/options"
xmlns:p="http://xbrl.org/formula/conformance/paramstuff"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://www.altova.com/schemas/altova/raptorxml/options https://www.altova.com/schemas/altova/raptorxml/options.xsd">
<options:parameter name="p1">
<options:value type="xs:string">hello world from new xml (without namespace)</options:value>
</options:parameter>
<options:parameter name="p:p1" type="xs:string" value="hello world from new xml"/>
</options:formula-parameters>
Note the following points:
•The @type attribute is optional and defaults to xs:string.
•Multiple <options:value> child elements can be specified in order to assign an XPath sequence to a parameter.
•@value and <options:value> cannot be used at the same time.
JSON format
The listing below shows formula parameters in JSON format.
{
"formula-parameters": [
{
"name": "p1",
"values": [
{
"type": "xs:string",
"value": "hello world from json new (without namespace)"
}
]
}, {
"name": "ns1:p1",
"values": [
{
"type": "xs:string",
"value": "hello world from json new"
}
]
}
],
"namespaces": {
"xs": "http://www.w3.org/2001/XMLSchema",
"ns1": "http://xbrl.org/formula/conformance/paramstuff"
}
}
Note the following points:
•The type key is optional and defaults to xs:string.
•The xs key is optional and defaults to http://www.w3.org/2001/XMLSchema.
•The type in the parameter map is used if a value is specified directly as a JSON string.
•Other ways of writing are currently also supported:
{
"name": "p2",
"type": "xs:string",
"value": "hello world from json new (without namespace)"
}, {
"name": "p3",
"type": "xs:int",
"values": ["1", "2"]
}, {
"name": "p4",
"type": "xs: int",
"values": ["1", {"type": "xs:string", "value": "abc"}, "2"]
}