Trading API
 

Keys


Global variables


Templates
match="Attribute" The template is to generate HTML elements of the currently parsed attribute such as label and input field.
AttributeQuadrantBottom The template is used to generate attribute with label arranged below the input box.
AttributeQuadrantLeft The template is used to generate attribute with label arranged on the left of the input box.
AttributeQuadrantRight The template is used to generate attribute with label arranged on the right of the input box.
AttributeQuadrantTop The template is used to generate attribute with label arranged above the input box.
CheckboxRadio The template is to generate attribute as a set of checboxes or radioboxes, based on the parameter type passed..
create_date_options The template generates date HTML option elements from the provided strings of date parts in three possible formats and based on user selelcted values and default.
create_date_options_old The template generates date HTML option elements from the provided strings of date parts in three possible formats and based on user selelcted values and default.
date_options The template is to generate a HTML option elements for the specified part of the date.
date_options_old The template is to generate a HTML option elements for the specified part of the date.
DateDropdowns The template is to generate date attribute as a dropdown box.
DateLabels The template is to generate date labels based on format provided..
Dropdown The template is to generate attribute as a dropdown box.
get_current_date_string The template generates part of the date based on passed parameters.
get_current_date_string_old The template generates part of the date based on passed parameters.
get_date_strings The template returns the required one string of 10 possible date sets with values delimited with ';'
get_date_strings_old The template returns the required one string of 10 possible date sets with values delimited with ';'
get_default_val The template generates the values that should be selected in the date option list based on user selections, current values and initial values.
get_default_val_old The template generates the values that should be selected in the date option list based on user selections, current values and initial values.
match="Input" The template is a starting point to generate input HTML elements, like radiobox, checkbox, combobox, list box, text field, textarea field..
JS_Arrays The template generates JavaScript variables that are needed to handle dependencies between attributes.
match="Label" The template generates specified formating for the label based on Presentation Instructions.
SingleMultiple The template generates Listbox with multiple or single selection.
Textbox_Day Display Input Box for DAY.
Textbox_FullDate Display Input Box for FULL DATE.
Textbox_Month Display Input Box for MONTH.
Textbox_Year Display Input Box for YEAR.
TextField The template generates text field elements.
WidgetGroupTableCell The template is to generate a row of check/radiobox elements for the attribute. It's used by the template with the name="CheckboxRadio".
WriteLabel The template generates the label and is used by match="Label". template.


Details
Template:   match="Attribute"
Description:
The template is to generate HTML elements of the currently parsed attribute such as label and input field.
Parameters:
attrId: Attribute id
widgetType: Type of widget to be generated..
Possible values:
normal - represents a widget that can have label and input box
text_message - represents a simple text message that needs to be displayed
date - represents a date widget
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
Show source


Template:   AttributeQuadrantBottom
Description:
The template is used to generate attribute with label arranged below the input box.
Parameters:
attrId: Attribute id
VCSID: characteristics set ID of the current category being handled
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
Show source


Template:   AttributeQuadrantLeft
Description:
The template is used to generate attribute with label arranged on the left of the input box.
Parameters:
attrId: Attribute id
VCSID: characteristics set ID of the current category being handled
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
Show source


Template:   AttributeQuadrantRight
Description:
The template is used to generate attribute with label arranged on the right of the input box.
Parameters:
attrId: Attribute id
VCSID: characteristics set ID of the current category being handled
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
Show source


Template:   AttributeQuadrantTop
Description:
The template is used to generate attribute with label arranged above the input box.
Parameters:
attrId: Attribute id
VCSID: characteristics set ID of the current category being handled
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
Show source


Template:   CheckboxRadio
Description:
The template is to generate attribute as a set of checboxes or radioboxes, based on the parameter type passed..
Parameters:
attrId: Attribute id
columns: Number of columns per row to be used to arrange input boxes.
type: Type of the input box.
Possible values:
checkbox - to generate checkbox element
radio - to generate radiobox element
inputName: Name of the input box that.
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
VCSID: characteristics set ID of the current category being handled
Show source


Template:   create_date_options
Description:
The template generates date HTML option elements from the provided strings of date parts in three possible formats and based on user selelcted values and default.
Parameters:
default_val: Default value
primary_match: Set of date parts (number format) arranged as a string of values with delimiters.
date_text: Set of date parts (long format) arranged as a string of values with delimiters.
delim: Delimiter string used
Show source


Template:   create_date_options_old
Description:
The template generates date HTML option elements from the provided strings of date parts in three possible formats and based on user selelcted values and default.
Parameters:
default_val: Default value
primary_match: Set of date parts (number format) arranged as a string of values with delimiters.
secondary_match: Set of date parts (short format) arranged as a string of values with delimiters.
date_text: Set of date parts (long format) arranged as a string of values with delimiters.
delim: Delimiter string used
Show source


Template:   date_options
Description:
The template is to generate a HTML option elements for the specified part of the date.
Parameters:
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
attr_id: Attribute id
date_sort: Specifies the sorting order and the format of the date part
Possible values:
ascending - descending order
descending - ascending order
pi_node_set: Options definded in the Presentation Instructions
range_type: Only needed for PF date ranges
FieldName: Field name only needed for SYI (to pull data from PostedFormFields section
Show source


Template:   date_options_old
Description:
The template is to generate a HTML option elements for the specified part of the date.
Parameters:
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
attr_id: Attribute id
date_sort: Specifies the sorting order and the format of the date part
Possible values:
DayDescending - days - descending order
DayAscending - days - ascending order
MonthAscendingShort - month short format (i.e. Jun) - ascending order
MonthDescendingShort - month short format - descending order
MonthAscendingLong - month long format (January) - ascending order
MonthDescendingLong - month long format - descending order
MonthAscendingNumber - month number format (01) - ascending order
MonthDescendingNumber - month number format (01) - descending order
YearDescending - year - descending order
YearAscending - year - descending order
pi_node_set: Options definded in the Presentation Instructions
range_type: Only needed for PF date ranges
FieldName: Field name only needed for SYI (to pull data from PostedFormFields section
Show source


Template:   DateDropdowns
Description:
The template is to generate date attribute as a dropdown box.
Parameters:
attrId: Attribute id
inputName: Name of the input box that.
format: Date formatexample: m_d_y
VCSID: characteristics set ID of the current category being handled
Show source


Template:   DateLabels
Description:
The template is to generate date labels based on format provided..
Parameters:
attrId: Attribute id
format: Date formatexample: m_d_y
quadrant: Location relatively to the field
Show source


Template:   Dropdown
Description:
The template is to generate attribute as a dropdown box.
Parameters:
attrId: Attribute id
inputName: Name of the input box that.
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
VCSID: characteristics set ID of the current category being handled
Show source


Template:   get_current_date_string
Description:
The template generates part of the date based on passed parameters.
Parameters:
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
date: The date delimited with '-'
Show source


Template:   get_current_date_string_old
Description:
The template generates part of the date based on passed parameters.
Parameters:
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
date: The date delimited with '-'
Show source


Template:   get_date_strings
Description:
The template returns the required one string of 10 possible date sets with values delimited with ';'
Parameters:
date_sort: Specifies the sorting order and the format of the date part
Possible values:
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
match: Specifies the format of the date value set to return
Possible values:
Show source


Template:   get_date_strings_old
Description:
The template returns the required one string of 10 possible date sets with values delimited with ';'
Parameters:
date_sort: Specifies the sorting order and the format of the date part
Possible values:
DayDescending - days - descending order
DayAscending - days - ascending order
MonthAscendingShort - month short format (i.e. Jun) - ascending order
MonthDescendingShort - month short format - descending order
MonthAscendingLong - month long format (January) - ascending order
MonthDescendingLong - month long format - descending order
MonthAscendingNumber - month number format (01) - ascending order
MonthDescendingNumber - month number format (01) - descending order
YearDescending - year - descending order
YearAscending - year - descending order
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
match: Specifies the format of the date value set to return
Possible values:
Show source


Template:   get_default_val
Description:
The template generates the values that should be selected in the date option list based on user selections, current values and initial values.
Parameters:
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
attr_id: Attribute id.
range_type: Only needed for PF date ranges
FieldName: Field name only needed for SYI (to pull data from PostedFormFields section
Show source


Template:   get_default_val_old
Description:
The template generates the values that should be selected in the date option list based on user selections, current values and initial values.
Parameters:
date_part: Specifies the part of date to generate option list for
Possible values:
Day - specifies to generate the day of the month
Month - specifies to generate month
Year - specifies to generate year
attr_id: Attribute id.
range_type: Only needed for PF date ranges
FieldName: Field name only needed for SYI (to pull data from PostedFormFields section
Show source


Template:   match="Input"
Description:
The template is a starting point to generate input HTML elements, like radiobox, checkbox, combobox, list box, text field, textarea field..
Parameters:
attrId: Attribute id of the input field
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
inputName: Name of the input field
Show source


Template:   JS_Arrays
Description:
The template generates JavaScript variables that are needed to handle dependencies between attributes.
Show source


Template:   match="Label"
Description:
The template generates specified formating for the label based on Presentation Instructions.
Parameters:
attrId: Attribute id of the label is generated for.
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
Show source


Template:   SingleMultiple
Description:
The template generates Listbox with multiple or single selection.
Parameters:
attrId: Attribute id of the input field
inputName: Name of the input field
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
VCSID: characteristics set ID of the current category being handled
Show source


Template:   Textbox_Day
Description:
Display Input Box for DAY.
Parameters:
attrId: Attribute id of the input field
inputName: Name of the input field
day: number of the day
VCSID: characteristics set ID of the current category being handled
Show source


Template:   Textbox_FullDate
Description:
Display Input Box for FULL DATE.
Parameters:
attrId: Attribute id of the input field
inputName: Name of the input field
day: number of the day
month: number of the month
year: number of the year
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
VCSID: characteristics set ID of the current category being handled
Show source


Template:   Textbox_Month
Description:
Display Input Box for MONTH.
Parameters:
attrId: Attribute id of the input field
inputName: Name of the input field
month: number of the month
VCSID: characteristics set ID of the current category being handled
Show source


Template:   Textbox_Year
Description:
Display Input Box for YEAR.
Parameters:
attrId: Attribute id of the input field
inputName: Name of the input field
year: number of the year
VCSID: characteristics set ID of the current category being handled
Show source


oXML.async = false; oXML.loadXML(document.getElementById('txt-template-TextField').value); ifdoc = document.frames('if-template-TextField').document; if (oXSLT.parseError.errorCode != 0) ifdoc.write("XSL Parse Error : " + xsl.parseError.reason); else ifdoc.write(oXML.transformNode(oXSLT)); ifdoc.close(); //-->
Template:   TextField
Description:
The template generates text field elements.
Parameters:
attrId: Attribute id of the input field
inputName: Name of the input field
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
VCSID: characteristics set ID of the current category being handled


Template:   WidgetGroupTableCell
Description:
The template is to generate a row of check/radiobox elements for the attribute. It's used by the template with the name="CheckboxRadio".
Parameters:
attrs: A subset of attribute values that follow the value already parsed or the full set if it's a starting point
cols: Number of columns left to generate in the row. Used in decremental order. The template is recursively called until cols is 0
max: Number of columns to generate, used to keep track of how many needs to be generated during recursive calls
inputName: Name of the input box that.
attrId: Attribute id
WidgetType: Type of the input box.
Possible values:
checkbox - to generate checkbox element
radio - to generate radiobox element
IsEmpty: Says if the attribute has no values currently selected
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
SelectedAttributeXPath: Selected attributes from the previous step based on the current characteristics set ID
VCSID: characteristics set ID of the current category being handled
Show source


Template:   WriteLabel
Description:
The template generates the label and is used by match="Label". template.
Parameters:
attrId: Attribute id of the label is generated for.
CurrentAttributeXPath: Current set of attributes based on characteristics set ID being parsed
Show source