Business Desk XML Structures

  • Article

The Extensible Markup Language (XML) structures used by Commerce Server Business Desk can be divided into three categories:

  • Module Configuration: XML structures used for category and module configuration. These need to be modified only when a new module is added to Business Desk, or in the event that existing modules are rearranged or removed.

  • HTML Component (HTC) Data: XML structures used to represent the data that is displayed within the various HTCs that are provided as part of the Business Desk Framework. For the most part, a single standard format is used, though it can be nested more deeply for some controls than for others. In general, an XML data-island with this structure is one of two data-islands that must exist for a particular HTC to operate correctly.

    The other XML structure in this category is used to represent the nodes in the TreeView HTC. This structure is unique because the data and configuration information are embedded into the same XML structure.

  • HTC Configuration: XML structures used to provide meta-data about the data being displayed. For example, if the data is being displayed in columns, this structure specifies information about each of those columns, such as the column heading, how the data itself should be formatted, the column width, and whether the column can be sorted. In general, an XML data-island of this type is one of two data-islands that must exist for a particular HTC to operate correctly.

This section contains:

  • Master Configuration File. Describes the XML structure of the master module configuration file that ties all other module configuration files together, including their organization into categories.

  • Module Configuration Files. Describes the XML structure of the module configuration files that specify the details of each individual module.

  • Standard XML Data Record Format. Describes the XML structure in which many of the HTCs expect data to be represented. These HTCs include the DynamicTable, EditField, EditSheet, ListEditor, and ListSheet.

  • DynamicTable Configuration. Describes the XML structure of the configuration information for the DynamicTable HTC. Since the DynamicTable HTC makes use of embedded EditField HTCs, much of the configuration information is shared between the two. For more details, see EditField Configuration.

  • EditField Configuration. Describes the XML structure of the configuration information for one or more EditField HTCs.

  • EditSheet Configuration. Describes the XML structure of the configuration information for the EditSheet HTC. Because the EditSheet HTC makes use of embedded EditField HTCs, much of the configuration information is shared between the two. For more details, see EditField Configuration.

  • ExpressionBuilder Configuration. Describes the XML structure of the configuration information for the ExpressionBuilder HTC.

  • ListEditor Configuration. Describes the XML structure of the configuration information for the ListEditor HTC. Because the ListEditor HTC makes use of embedded EditField HTCs, much of the configuration information is shared between the two. For more details, see EditField Configuration.

  • ListSheet Configuration. Describes the XML structure of the configuration information for the ListSheet HTC.

  • QueryBuilder Configuration. Describes the XML structure of the configuration information for the QueryBuilder HTC.

  • TreeView Configuration. Describes the XML structure of the combined data and configuration information used by the TreeView HTC.


All rights reserved.