XML Elements
The Microsoft Commerce Server Catalog Extensible Markup Language (XML) elements are divided into three groups:
- MSCommerceCatalogCollection2. The root node for a Commerce Server Catalog XML file.
- Catalog Schema Elements. These elements are used to extend the catalog: CatalogSchema, AttributeDefinition, Definition, Property, and PropertyValue.
- Catalog Data Elements. These elements are used for the actual catalog and its members: Catalog, Category, Product, ProductVariant, and Relationship.
AttributeDefinition
Defines an attribute that can be used to describe an aspect of a property, such as its display name. This allows additional attributes to be defined on top of the built in ones.
**Parent Elements:**CatalogSchema
Child Elements: None
Attributes:
| Name | Type | Description |
|---|---|---|
| dataType | enumeration | Valid types are:
datetime |
| MaxLength | number | The maximum length for string values of this attribute, not valid for other data types. |
| name | string | The name of the attribute definition. |
| AttributeType | enumeration | Valid types are:
PropertyAttribute (default) |
Catalog
Defines an individual catalog.
**Parent Elements:**MSCommerceCatalogCollection2
**Child Elements:**Category, Product, displayName
Attributes:
| Name | Type | Description |
|---|---|---|
| name | string | The name of the catalog. |
| currency | string | The currency used in the catalog, expressed as a three letter ISO 4217 currency code. For example, USD, AUD, CDN, GBP, DEM, JPY. |
| DefaultLanguage | string | The culture code indicating the default language of the catalog. |
| endDate | string | The date the catalog validity expires. Used for documentation purposes only—Commerce Server does not apply any logic to this value. |
| languages | string | A comma-separated list of culture codes indicating the languages supported by the catalog. |
| locale | string | The locale of the catalog specified using a Windows Locale ID (LCID). |
| productUId | string | The name of the property that uniquely identifies products (or product families) in the catalog. |
| ReportingLanguage | string | Theculture code indicating the language to be used for catalog reporting. |
| startDate | string | The date the catalog is valid. Used for documentation purposes only—Commerce Server does not apply any logic to this value. |
| VariantUId | string | The name of the property that uniquely identifies product variants in the catalog. If the catalog does not contain products with variants, set this attribute to the same value as the value in the productIdentifier attribute. |
| Optional user defined attributes | Attributes created by the user with the CatalogManagerAddCatalogAttribute method. |
CatalogSchema
Contains the schema definition elements for the Catalog collection.
**Parent Elements:**MSCommerceCatalogCollection2
**Child Elements:**AttributeDefinition, Definition, Property
Attributes: None
Category
Defines an instance of a type of category.
**Parent Elements:**Catalog
**Child Elements:**Relationship, ParentCategory, displayName
Attributes:
| Name | Type (default=string) | Description |
|---|---|---|
| action | string | A value of delete specifies that this element is to be deleted when the catalog is imported. If the value is unspecified then this element will be added or updated as appropriate. |
| DateChanged | datetime | The date and time this category was last changed. |
| Definition | string | The name of the category definition upon which the category is based. |
| id | string | The unique identifier of the category. |
| isSearchable | string | Indicates whether this category is to be used as a starting point for specification searches. True indicates this category will be included in the record set returned by calls to the ProductCatalog.GetSearchableCategories object.
The values are 0 for False; 1 for True. |
| name | string | The name of the category. This name must be unique for all categories in the same catalog. |
| PrimaryParentCategory | string | The primary parent category of this category. |
| listprice | string | The price that should be applied to any products that reference this category as their pricing category. Units for this value are determined by the currency attribute of the containing catalog. |
| Optional user defined attributes | The properties that the user has added to the category definition for this category. |
DefaultValue
Defines a language default value for an enumeration type property.
**Parent Elements:**Property
Child Elements: None
Attributes:
| Attribute name | Type | Description |
|---|---|---|
| value | string | Text of the default value. |
| language | string | Theculture code indicating the language to which the default value applies. |
Definition
Defines a type of product or category.
**Parent Elements:**CatalogSchema
**Child Elements:**DefProperty, DefVariantProperty
Attributes:
| Name | Type | Description |
|---|---|---|
| DefinitionType | enumeration | The type of the definition — either product or category. |
| Name | string | The name of the property. This name must be unique within the XML document. |
DefProperty
Contains the name of property that is part of a Definition.
**Parent Elements:**Definition
Child Elements: none
Attributes: none
DefVariantProperty
Contains the name of variant property that is part of a Definition.
**Parent Elements:**Definition
Child Elements: none
Attributes: none
displayName
Defines a language-specific display name for a property, category, or catalog.
**Parent Elements:**Property, Category, Catalog
Child Elements: None
Attributes:
| Attribute name | Type (default=string) | Description |
|---|---|---|
| value | string | The display name text. |
| language | string | culture code indicating the language to which the display name applies. |
MSCommerceCatalogCollection2
The root node for a Commerce Server Catalog XML file.
Parent Elements: None
**Child Elements:**CatalogSchema, Catalog
Attributes:
| Attribute name | Type | Description |
|---|---|---|
| version | string | The version of the schema. "2.0" indicates the Commerce Server 2002 schema. |
ParentCategory
Contains the name of a category that has a parent relationship to the containing product or category element.
**Parent Elements:**Category, Product
Child Elements: none
Product
Defines an instance of a type of product.
**Parent Elements:**Catalog
**Child Elements:**ParentCategory, ProductVariant, Relationship, <UserDefinedMultilingualProperty>
Attributes:
| Name | Type | Description |
|---|---|---|
| action | string | A value of delete specifies that this element is to be deleted when the catalog is imported. If the value is unspecified then this element will be added or updated as appropriate. |
| DateChanged | datetime | The date and time that the product was last changed. |
| Definition | string | The name of the product definition upon which the product is based. |
| id | string | The XML ID for the product element. |
| listprice | string | The price for this product. Units for this value are determined by the currency attribute of the containing catalog. This attribute is required. |
| PrimaryParentCategory | string | The XML ID of the category to which the product belongs. |
| UseCategorypricing | boolean | Specifies whether the price of this product should be inherited from the PrimaryParentCategory of this product.
A value of 1 (one) indicates to inherit the price from the PrimaryParentCategory. |
| Optional user defined attributes | The properties that the user has added to the product definition for this product. |
ProductVariant
Defines an instance of a variant of a product.
**Parent Elements:**Product
Child Elements: <UserDefinedMultilingualProperty>
Attributes:
| Name | Type | Description |
|---|---|---|
| action | string | A value of delete specifies that this element is to be deleted when the catalog is imported. If the value is unspecified then this element will be added or updated as appropriate. |
| DateChanged | datetime | The date and time that the product variant was last changed. |
| id | string | The XML ID for the variant element. |
| listprice | string | The price for this product variant. Units for this value are determined by the currency attribute of the containing catalog. This attribute is required. |
Property
Defines a property that can be used to describe an aspect of a product or category.
**Parent Elements:**CatalogSchema
**Child Elements:**DefaultValue, displayName, PropertyValue.
Attributes:
| Name | Type | Description |
|---|---|---|
| AssignAll | boolean | Indicates whether this property should automatically be assigned to product definitions as they are created through Commerce Server Business Desk.
The values are: "1" (True) or "0" (False). |
| Currency | string | The currency used in the catalog, expressed as a three letter ISO 4217 currency code. For example, USD, AUD, CDN, GBP, DEM, JPY. This attribute is only valid when the DataType attribute is money. |
| DataType | string | Legal values are:
datetime |
| DisplayInProductsList | boolean | Indicates whether this property is to be displayed in summary lists of products in the Business Desk Catalog Editor, or in other areas where product lists are displayed.
The values are: "1" (True) or "0" (False) |
| DisplayOnSite | boolean | Indicates whether this property should be shown to users visiting the Web site.
The values are: "1" (True) or "0" (False). |
| ExportToDW | boolean | Indicates whether the Catalog DTS task should export this property into the Data Warehouse. Properties with this attribute set to True will be available for use in reports and data analysis.
The values are: "1" (True) or "0" (False) |
| id | string | A unique ID for each node in the document. May not contain spaces (an XML requirement). |
| IncludeInSpecSearch | boolean | Indicates whether this property should be exposed to specification searches.
The values are: "1" (True) or "0" (False) |
| IsFreeTextSearchable | boolean | Indicates whether this property should be included in the full-text index, and therefore, be free text searchable.
The values are: "1" (True) or "0" (False) |
| IsRequired | boolean | Indicates whether a value is required for this property. This rule is enforced by Bizdesk and not by the catalog objects
The values are: "1" (True) or "0" (False) |
| MaxValue | string | The maximum legal value for number data types, and the maximum length for string data types. |
| MinValue | string | The minimum legal value for number data types, and the minimum length for string data types. |
| Multilingual | string | Indicates whether this property is multilingual. This attribute is only valid when the DataType attribute is string, text, filename, or enumeration.
The values are: "1" (True) or "0" (False) |
| name | string | The unique name of the property. |
PropertyValue
Defines a legal value for a property.
**Parent Elements:**Property
Child Elements: None
Attributes:
| Name | Type | Description |
|---|---|---|
| displayName | string | A legal value for the containing property. |
| Language | string | ISO 639+1 code indicating the language to which the property value applies. |
Relationship
Defines a relationship between one product or category and another product or category.
**Parent Elements:**Category, Product
**Child Elements:**RelationshipDescription
Attributes:
| Name | Type | Description |
|---|---|---|
| name | string | The name of the relationship. |
| targetCatalog | string | The name of the catalog containing the target of this relationship, if the relationship is to an item in a different catalog. Not used if the relationship attribute is used to define a relationship to an item in the same catalog. |
| targetCategory | string | The name of the category that is the target of this relationship. Not used if the relationship attribute is used to define a relationship to an item in the same catalog. |
| targetProduct | string | The ID of the product that is the target of this relationship. Not used if the relationship attribute is used to define a relationship to an item in the same catalog. |
RelationshipDescription
Defines a language specific description for a relationship.
**Parent Elements:**Relationship
Child Elements: None
Attributes:
| Attribute name | Type (default=string) | Description |
|---|---|---|
| value | string | The display name text. |
| language | string | ISO 639+1 code indicating the language to which the display name applies. |
<UserDefinedMultilingualProperty>
Defines a name and value pair for a multilingual property.
**Parent Elements:**Category, Product, ProductVariant
Child Elements: None
Attributes:
| Name | Type | Description |
|---|---|---|
| Value | string | The text value of the property. |
| language | string | ISO 639+1 code indicating the language to which the property applies. |
Copyright © 2005 Microsoft Corporation.
All rights reserved.