| Template: |
|
| Template mode: |
API |
Description:
The template is used to display attribue value, date in particular.
|
|
| Parameters: |
| attrId: |
Attribute id of the input field
|
| PI.Attribute: |
Presentation Instructions for Attribute that contains this value
|
| CurrentAttributeXPath: |
Current set of attributes based on characteristics set ID being parsed
|
|
|
Show source
|
| Template: |
/ |
Description:
Main template to start ItemSpecific generation.
This template should be re-implemented in the XSL file that include this file Attributes_API.xslIf you have the form name different from $formName, the you need to re-declare it in the XSL that includes this XSL file.You can use Attributes_Style.xsl to disable shoing of head, body and form in case you want to include itemspecifics into your own HTML code |
|
Show source
|
| Template: |
match="Attribute" |
| Template mode: |
API.CheckOnVisibility |
Description:
Template performs check on if an attribute dependent on parent value or attribute can be shown.
The recursive check needs to be performed to check the whole chain of parent attributes and values on visibility.
It generates non-empty string in case it should not be shown.
Only attributes with @hide sttribute equal to true will be parsed.
|
|
Show source
|
| 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: |
match="Attribute" |
| Template mode: |
API.Other |
Description:
The template is used to show textbox 'Other' to the right of the control where other values is selected.
|
|
| Parameters: |
| 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: |
AttributeError |
Description:
The template is used to generate error messages below the attributes HTML elements that have invalid values.
The content is generated as a part of the HTML table |
|
| Parameters: |
| InputId: |
specifies the attribute id to check on errors and display if any
|
| VCSID: |
characteristics set ID of the current category being handled
|
| Col: |
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: |
Attributes |
Description:
The template parses Presentation Instructions.for every characteristics set.
The generation of HTML elements depends on the current state of the flow, which can be initial or conditional.
It utilizes characteristics set ID to extract selected/defualt values for attributes and available attributes from CharacteristicsSet that correspon to the characteristics set being parsed
|
|
Show source
|
| Template: |
BuildActualRow |
Description:
The template buids the row of attributes based on Presentation Instructions (PI).
|
|
| Parameters: |
| attrId: |
Attribute id of the label is generated for.
|
| 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: |
BuildConditionalOrStandard |
Description:
Te template is to build either an initial or conditional row from the PI. If we are in the conditional flow we need to recursively go through the row to determine if the current
row needs to be built. If it is an initial row we will simply call the BuildActualRow which will begin the build process.
|
|
| Parameters: |
| Row: |
Row node of PI to parse
|
| 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: |
BuildPresentationInstructions |
Description:
The template is to parse presentation instructions and show only eligible attributes that meet certrain conditions.
|
|
| Parameters: |
| PI: |
Presentation instructions of Initial secion that needs to be parsed.
|
| PI.Conditional: |
Presentation instructions of Conditional secion that needs to be parsed.
This is only for API flow.For other flow just omit this parameter during the call of the template.
|
| 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: |
BuildRows |
Description:
The template is used to initiate a row building process and handle case with attribute of type 2
that should be shown below all other attributes.
|
|
| Parameters: |
| Rows: |
Presentation instruction rows that needs to be parsed.
|
| PI.Conditional.Rows: |
Conditional presentation instruction rows that might be parsed in case a corresponding control is set to Other with value id=-6.
|
| Mode: |
Shows the state of the building process.
|
Possible values:
| FirstRun
- First pass to handle all non-type 2 attributes |
| SecondRun
- Second pass to handle type 2 attributes |
|
|
| 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: |
BuildWidget |
Description:
The template buids one widget of the row of attributes.
|
|
| Parameters: |
| Widget: |
Widget node with PI data
|
| 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: |
Categories |
Description:
The template is used to generate a first page to select category to list an item in.
|
|
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: |
match="Dependency" |
| Template mode: |
isVisible |
Description:
The template is used to generate option list for listboxes and dropboxes.
|
|
| Parameters: |
| attrId: |
Attribute id of the input field
|
| SelectedAttributeXPath: |
Selected attributes from the previous step based on the current characteristics set ID
|
| FieldName: |
Field name only needed for SYI (to pull data from PostedFormFields section
|
|
|
Show source
|
| Template: |
DisplayMessage |
Description:
The template is used to generate a message box around attribute.
|
|
| Parameters: |
| attrMessage: |
Contains the message text.
|
| messageStyle: |
Specifies the style of the message
|
|
|
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
|
| 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
|
|
|
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
|
|
|
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: |
GetStringToken |
Description:
The template is used as a helper function to retrieve string token by index.
|
|
| Parameters: |
| String: |
String to handle
|
| Separator: |
Separator to split the string into tokens
|
| Index: |
Index of the tocken to retrieve
|
|
|
Show source
|
| Template: |
InitializeCascades |
Description:
Initialize Cascades
Outputs a call to the JavaScript function aus_init_cascades that initializes child attributes.
|
|
| Parameters: |
| 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: |
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: |
match="Input" |
| Template mode: |
IsOtherSelected |
Description:
The template is used to determine if texbox "other" should be shown on the right if the control box.
|
|
| Parameters: |
| attrId: |
Attribute id
|
| 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: |
ItemSpecifics |
Description:
The template generates necessary JavaScript data and begins generation of HTML elements corresponding to the current attributes set.
|
|
Show source
|
| Template: |
JS |
Description:
The template generates JavaScript functionality used to handle dependencies between attributes.
|
|
Show source
|
| Template: |
JS_Arrays |
Description:
The template generates JavaScript variables that are needed to handle dependencies between attributes.
|
|
Show source
|
| Template: |
JS_Arrays_Other |
Description:
The template is used to generate array of attribute ids that have other values (-6) currectly selected
|
|
| Parameters: |
| 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: |
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: |
match="Message" |
Description:
Not used by API.
|
|
Show source
|
| Template: |
PromoMessage |
Description:
The template is used show Promotional message at the top and bottom of the ItemSpecifics.
|
|
| Parameters: |
| Message: |
Message to show.
|
|
|
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: |
SplitPresentationInstructions |
Description:
The template is a helper for template name="BuildPresentationInstructions" to split the flow of parsing presentation instructions into two runs
to show attributes with EditType=2 after the rest of attributes.
|
|
| Parameters: |
| PI.Rows: |
Presentation instructions of Initial secion that needs to be parsed.
|
| PI.Conditional.Rows: |
Presentation instruction rows of Conditional secion that needs to be parsed.
This is only for API flow.For other flows this parameter is omitted during the call of the template.
|
| 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: |
TableSpacerCell |
Description:
The template is used to format spaces between HTML elements in tables
|
|
| Parameters: |
| width: |
Specifies the width of the space.
|
| height: |
Specifies the height of the space.
|
| colspan: |
Specifies the colspan the space should occupy in the table
|
| rowspan: |
Specifies the rowspan the space should occupy in the table
|
| bgcolor: |
Specifies the background color to be used by the space
|
|
|
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
|
| 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
|
|
|
Show source
|
| Template: |
TextMessage |
Description:
The template is used to generate a message box for widget of type "message_text".
|
|
Show source
|
| Template: |
match="Value" |
Description:
The template is used to generate option list for listboxes and dropboxes.
|
|
| Parameters: |
| attrId: |
Attribute id of the input field
|
| SelectedAttributeXPath: |
Selected attributes from the previous step based on the current characteristics set ID
|
| FieldName: |
Field name only needed for SYI (to pull data from PostedFormFields section
|
|
|
Show source
|
| Template: |
match="Value" |
| Template mode: |
IsOtherSelected |
Description:
The template is used to generate text 'selected' in case a text box 'other' should be shown.
|
|
Show source
|
| 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
|
|