ExportOption Element
The ExportOption element specifies options for including or excluding catalog and marketing data to be exported for a Commerce Server Staging (CSS) business data project.
Put the ExportOption element within the BusinessData element.
The following table lists the attributes of the ExportOption element.
Attribute |
Data Type |
Description |
|---|---|---|
Name |
String |
Specifies the name of the property to be set. This property defines the configuration of the export data. Property names are not case-sensitive. The export options differ based on the type of data being exported. |
Val |
String |
Specifies the value of the property to be set. |
The following table lists the valid names and values for catalog data.
Name |
Value |
|---|---|
CatalogSetsToExport |
Whether to stage the selected catalog sets. Valid values are "Yes" and "No". |
CatalogsToExport |
A comma-separated list of the names of the catalogs to export. If this attribute is not specified, all catalogs in the system are exported. |
CatalogsToExport_SourceCulture |
A comma-separated list of the display names of the catalogs that are to be exported. .gif "Note") Note:
This option is only used by the CSS Microsoft Management Console (MMC). If you are creating an XML configuration file for use with a CSS command line or API, you can omit specifying this attribute.
|
Descendents |
The following table describes the valid values for how catalog descendents are to be staged.
ValueDescription
All Stage all descendants. All descendants are included in the list.
ImmediateChildrenStage only the immediate child descendants. Only one level of descendants is included in the list.
NoneStage no descendants. Only the items on the list are exported.
|
ExportAsVirtualCatalog |
Whether to stage virtual catalogs. Valid values are "Yes" and "No". A virtual catalog is a catalog that references the product data in one or more base catalogs. Products are represented only in a single instance in the database, regardless of how many virtual catalogs they appear in. |
ExportDeletedItems |
Whether to stage deleted items. Valid values are "Yes" and "No". The catalog system keeps track of products and categories deleted from individual catalogs. Use this property to export these deleted items to your XML file. |
ExportDependentBaseCatalogs |
Whether to stage base catalogs. Valid values are "Yes" and "No". Base catalogs are referenced to build virtual catalogs. |
ExportEmptyValues |
Whether to stage empty values. Valid values are "Yes" and "No". |
FilterDescendantsClause |
An SQL query clause that specifies the descendants to export. The properties specified in this clause must be defined for all catalogs in the system. |
Language |
A comma-separated list of the names of the languages for which catalog data is to be exported. The Language is specified as an RFC 1766 CultureInfo class name. If no language property is set, all languages defined for the selected catalogs are exported. |
Mode |
The following table describes the valid values for how catalog data is to be staged.
ValueDescription
Full Stage the whole catalog. Specify which catalogs to export by using the CatalogsToExport or CatalogSetsToExport properties. If these properties are empty, all catalogs in the system are exported.
ExpressionBasedStage selected items by specifying an SQL-based search expression to select specific data. You specify this expression in the ProductsAndCategoriesClause property.
|
ProductsAndCategoriesClause |
An SQL query clause that specifies the products and categories to export. This assignment is only applicable when the ExpressionBased mode is specified. This expression must apply to all catalogs that are being exported. If you are exporting multiple catalogs, and if one catalog does not contain the property in the expression, the export fails. For example, if the ProductsAndCategoriesClause is "Description like N'%test%'" and a catalog does not contain the property "Description", the export will fail. Every node of the database is tested against this query. Items that match the query are put in a list to be exported. This list is then expanded according to criteria determined by the value of the Descendants property. |
PropertiesToExport |
A comma-separated list of the names of the catalog properties to export. Only the properties specified and the mandatory properties are exported. |
PropertiesToExport_SourceCulture |
A comma-separated list of the display names of the catalog properties are to be exported. Note:
This option is only used by the CSS Microsoft Management Console (MMC). It is used to populate the properties list in the UI with the correct cultural context. If you are creating an XML configuration file for use with a CSS command line or API, you can omit specifying this attribute.
|
SchemaExportType |
The schema elements to export. The following table describes the valid values:
ValueDescription
AllExport the complete schema.
NoneDo not export the schema.
RelevantExport the schema only for the product catalogs being exported.
|
The following table lists the valid names and values for marketing data.
Name |
Value |
|---|---|
Promocode |
How promotional codes are to be staged. The following table describes the valid values:
Incremental Stage only the promotion codes that have changed since the last deployment.
Full Stage all promotion codes, regardless of any changes since the last deployment.
|
Remarks
When you stage business data, you export data from a source database and import data to a destination database. The ExportOption element provides support for configuring the export operation and the ImportOption element specifies how the import operation is conducted.
When staging catalog data, you can decide which catalogs to update and also how to update them. You can select one or more catalogs as part of a single project. The options selected will be applied to all the catalogs selected. When you select marketing data for export, all advertisements and discounts are staged in full. For staging of promotion codes, you can select whether these should be staged in full, incrementally, or not at all.
You export the catalog to a location on the server computer or a network share that can be accessed by the server computer. You select the language in which you are to export the catalog data or you can export the catalog data in all languages.
The ExportOption element is not valid for use when the BusinessDataTypeName is "Orders" or "SiteTerms".
Example
The following example specifies to export marketing data and perform a full staging of all promotion codes, regardless of any changes that occurred since the last deployment. For an additional example, see ImportOption Element.
<BusinessData BusinessDataID="8fda83ba-25ad-4540-8f6b-03eaa24b6fb6" BusinessDataTypeName="Marketing">
<ExportOption Name="PROMOCODE" Val="Full" />
</BusinessData>