BizTalk Adapter Tools
There are three Commerce Server 2009 command-line tools that are of particular interest to developers who are using the BizTalk adapters provided with Commerce Server 2009, also known informally as the Commerce Server 2009 adapters, to integrate with other systems. These tools provide a way for you to generate up-to-date schemas from the Orders, Catalog, and Profiles Systems so that they can be deployed to, and used within, BizTalk Server.
Note: |
|---|
|
To generate an up-to-date schema for the Inventory System, use the Inventory receive adapter itself. For more information, see Generating and Using the XSD Files Required by Different Commerce Server Systems). |
The three tools are:
-
OrderMapping.exe. Use this tool to generate an up-to-date XSD schema for the Orders System.
-
ExportCatalog.exe. Use this tool to generate an up-to-date XSD schema for the Catalog System.
Note:You can also use the Catalog receive adapter itself to generate an up-to-date version of the catalog schema. For more information about how to use these receive adapters in this way, see Generating and Using the XSD Files Required by Different Commerce Server Systems.
-
ExportProfileXsd.exe. Use this tool to generate an up-to-date XSD schema for the Profiles System.
Each of these tools, including their respective command line parameters, is described separately below.
Note: |
|---|
|
The Commerce Server 2009 adapters do not support dynamic schema discovery within your BizTalk projects in Visual Studio. Instead, you must run these tools on the computer running Commerce Server 2009, and then deploy the generated schemas by following the steps described in How to Setup Visual Studio for BizTalk Adapter Development. |
You use the command-line tool OrderMapping.exe, found in the Tools folder within the Commerce Server 2009 installation folder, to generate an up-to-date XSD representation of the Orders schema. The command for using this tool to generate an up-to-date XSD file is as follows:
OrderMapping /w[ebconfig] <web_config_file>
[/n[osql]]
[/nologo]
[/i[gnore]]
[/x[sd] <output_XSD_file>]
[/t[ype] <OrderGroup_derived_type>]
[/c[ollection]]
[/tn | /targetNamespace <target_namespace>]
[/p]
[/f <mapping_XML_file>]
Note: |
|---|
|
You can also use this tool to generate updated SQL table definitions and stored procedures, for which additional command-line parameters are required. For information about these additional parameters, see How to Generate SQL Tables and Stored Procedures for Orders Mapped Storage. |
Parameter Descriptions
Note: |
|---|
|
Parameter specifiers are not case-sensitive and can begin with either the "/" or the "-" character. |
Examples
The following example generates an XSD file named MyOrderGroupSchema.xsd that could be used to replace the schema in the default system schema file OrderGroupCollection.xsd:
OrderMapping /webconfig Web.config /collection /type PurchaseOrder /nosql /xsd MyOrderGroupSchema.xsd
The following example generates an XSD file named MyPOSchema.xsd that could be used to replace the schema in the default system schema file PurchaseOrder.xsd:
OrderMapping /webconfig Web.config /type PurchaseOrder /nosql /xsd MyPOSchema.xsd
The following example generates an XSD file named MyBasketSchema.xsd that could be used to replace the schema in the default system schema file Basket.xsd:
OrderMapping /webconfig Web.config /type Basket /nosql /xsd MyBasketSchema.xsd
You use the command-line tool ExportCatalog.exe, found in the Tools folder within the Commerce Server 2009 installation folder, to generate an up-to-date XSD representation of the Catalog schema. The command for using this tool to generate an up-to-date XSD file is:
ExportCatalog /Site:<sitename>
/Xsd
[/Namespace:<target_namespace>]
<filename>
Parameter Descriptions
Note: |
|---|
|
Parameter specifiers and choices are not case-sensitive. |
Example
The following example generates an XSD file named MyCatalog.xsd that could be used to replace the schema in the default system schema file DefaultCatalog.xsd:
exportcatalog /site:CSharpSite /xsd MyCatalog.xsd
The following example generates the same XSD file as the previous example, except that it includes a namespace specifier set to the value "MyNamespace":
exportcatalog /site:CSharpSite /xsd /namespace:MyNamespace MyCatalog.xsd
You use the command-line tool ExportProfileXsd.exe, found in the Tools folder within the Commerce Server 2009 installation folder, to generate an up-to-date XSD representation of the Profiles schema. The command for using this tool to generate an up-to-date XSD file is:
ExportProfileXsd {-s <site_name> | -c <connection_string>}
[-o <output_file_name>]
[-tn <target_namespace>]
<profile1> [<profile2> ... [<profileN>]]
Parameter Descriptions
Example
The following example generates an XSD file named MyProfileSchema.xsd that could be used to replace the schema in the default system schema file ProfileDocument.xsd:
ExportProfileXsd –o MyProfileSchema.xsd –s CSharpSite UserObject Address Organization