BizTalk Adapters SDK
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
The software development kit (SDK) for Commerce Server 2007 includes both default schema files for the various adapter messages, and sample messages based on the default schemas. These schemas and messages can be found in the following two folders, respectively:
%COMMERCE_SERVER_ROOT%\Sdk\Samples\Adapters\MessageSchemas
%COMMERCE_SERVER_ROOT%\Sdk\Samples\Adapters\SampleMessages
The rest of this topic describes each default message schema and sample message.
Default Message Schemas
The BizTalk adapters that are provided with Commerce Server include a set of default XSD schema files that describe the message bodies of the various adapter messages. For ease of use in the BizTalk Server development environment, a solution file and a BizTalk Server project file for Visual Studio 2005 or Visual Studio 2008, the latter of which contains the XSD schema files, are also included. Together, these Visual Studio 2005 or Visual Studio 2008 files and the associated schema files may be used to build a schema DLL that can be deployed into the BizTalk Server application within which your adapters reside, and that can be referenced from inside BizTalk Server development projects within Visual Studio 2005 or Visual Studio 2008. For more information about how to build and deploy an adapters schema DLL, see Generating and Using the XSD Files Required by Different Commerce Server Systems.
All these files are included in the adapters SDK, as described in the following table.
Adapter SDK file |
Description |
|---|---|
CommerceServerAdapterSchemas.btproj (in ...\MessageSchemas) |
Visual Studio 2005 or Visual Studio 2008 project file that contains all the XSD files listed in this table. |
CommerceServerAdapterSchemas.sln (in ...\MessageSchemas) |
Visual Studio 2005 or Visual Studio 2008 solution file that contains the BizTalk Server project CommerceServerAdapterSchemas.btproj. |
Basket.xsd (in ...\MessageSchemas\Orders) |
Commerce Server system schema. You may have to generate an updated version of this schema if you change the schema of the Orders System. |
OrderGroupCollection.xsd (in ...\MessageSchemas\Orders) |
Commerce Server system schema. You may have to generate an updated version of this schema if you change the schema of the Orders System. |
OrdersAcceptBasketErrorResponse.xsd (in ...\MessageSchemas\Orders) |
Adapter schema. You do not have to update this schema. |
OrdersQuery.xsd (in ...\MessageSchemas\Orders) |
Adapter schema. You do not have to update this schema. |
OrdersQueryExpr.xsd (in ...\MessageSchemas\Orders) |
Orders search expression schema. You do not have to update this schema. |
OrdersSavePurchaseOrderResponse.xsd (in ...\MessageSchemas\Orders) |
Adapter schema. You do not have to update this schema. |
OrderUpdate.xsd (in ...\MessageSchemas\Orders) |
Adapter schema. You do not have to update this schema. |
PurchaseOrder.xsd (in ...\MessageSchemas\Orders) |
Commerce Server system schema. You may have to generate an updated version of this schema if you change the schema of the Orders System. |
UpdatePurchaseOrderPropertiesResponseMessage.xsd (in ...\MessageSchemas\Orders) |
Adapter schema. You do not have to update this schema in this file. |
CatalogQuery.xsd (in ...\MessageSchemas\Catalog) |
Adapter schema. You do not have to update the schema. |
CatalogResponseMessage.xsd (in ...\MessageSchemas\Catalog) |
Adapter schema. You do not have to update this schema. |
DefaultCatalog.xsd (in ...\MessageSchemas\Catalog) |
Commerce Server system schema. You may have to generate an updated version of this schema if you change the schema of the Catalog System. |
DefaultInventory.xsd (in ...\MessageSchemas\Inventory) |
Commerce Server system schema. You may have to generate an updated version of this schema if you change the schema of the Inventory System. |
InventoryQuery.xsd (in ...\MessageSchemas\Inventory) |
Adapter schema. You do not have to update this schema. |
InventoryResponseMessage.xsd (in ...\MessageSchemas\Inventory) |
Adapter schema. You do not have to update this schema. |
ProfileDocument.xsd (in ...\MessageSchemas\Profiles) |
Commerce Server system schema. You may have to generate an updated version of this schema if you change the schema of the Profiles System. |
ProfilesDelete.xsd (in ...\MessageSchemas\Profiles) |
Adapter schema. You do not have to update the schema in this file. |
ProfilesDeleteResponse.xsd (in ...\MessageSchemas\Profiles) |
Adapter schema. You do not have to update this schema. |
ProfilesImportResponse.xsd (in ...\MessageSchemas\Profiles) |
Adapter schema. You do not have to update this schema. |
ProfilesQuery.xsd (in ...\MessageSchemas\Profiles) |
Adapter schema. You do not have to update this schema. |
ProfilesQueryExpr.xsd (in ...\MessageSchemas\Profiles) |
Profiles search expression schema. You do not have to update this schema. |
ProfilesQueryResponseMessage.xsd (in ...\MessageSchemas\Profiles) |
Adapter schema. You do not have to update this schema. |
ProfilesUpdateResponse.xsd (in ...\MessageSchemas\Profiles) |
Adapter schema. You do not have to update this schema. |
Sample Messages
The BizTalk adapters that are provided with Commerce Server include a set of sample adapter messages. You can use these messages to examine the various message formats in the context of actual samples instead of the syntax specifications provided by the schema files. You can also use them with the adapters to test basic connectivity.
Note
These messages are samples, and comply with the default schemas. You will probably have to update your system schemas to match schema changes in the corresponding Commerce Server system, and the messages that you create must match the updated schemas.
The following table describes the included sample messages.
Adapter SDK file |
Description |
|---|---|
OrdersQuery.xml (in ...\SampleMessages\Orders) |
Complies with the adapter schema file OrdersQuery.xsd. This sample message shows you how to construct an adapter message of type CommerceServerOrdersQuery. |
OrdersSaveBasket.xml (in ...\SampleMessages\Orders) |
Complies with the system schema file Basket.xsd. This sample message shows you how to construct an adapter message of type CommerceServerOrdersAcceptBasket. |
OrdersSavePurchaseOrder.xml (in ...\SampleMessages\Orders) |
Complies with the system schema file PurchaseOrder.xsd. This sample message shows you how to construct an adapter message of type CommerceServerOrdersSavePurchaseOrder. |
OrdersUpdate.xml (in ...\SampleMessages\Orders) |
Complies with the adapter schema file OrdersUpdate.xsd. This sample message shows you how to construct an adapter message of type CommerceServerOrdersUpdateOrderProperties. |
CatalogImport.xml (in ...\SampleMessages\Catalog) |
Complies with the system schema file DefaultCatalog.xsd. This sample message shows you how to construct an adapter message of type CommerceServerCatalogImport. |
CatalogQuery.xml (in ...\SampleMessages\Catalog) |
Complies with the adapter schema file CatalogQuery.xsd. This sample message shows you how to construct an adapter message of type CommerceServerCatalogQuery. |
InventoryImport.xml (in ...\SampleMessages\Inventory) |
Complies with the system schema file DefaultInventory.xsd. This sample message shows you how to construct an adapter message of type CommerceServerInventoryImport. |
InventoryQuery.xml (in ...\SampleMessages\Inventory) |
Complies with the adapter schema file InventoryQuery.xsd. This sample message shows you how to construct an adapter message of type CommerceServerInventoryQuery. |
ProfilesDelete.xml (in ...\SampleMessages\Profiles) |
Complies with the adapter schema file ProfilesDelete.xsd. This sample message shows you how to construct an adapter message of type CommerceServerProfilesDelete. |
ProfilesImport.xml (in ...\SampleMessages\Profiles) |
Complies with the system schema file ProfileDocument.xsd. This sample message shows you how to construct an adapter message of type CommerceServerProfilesImport. |
ProfilesQuery.xml (in ...\SampleMessages\Profiles) |
Complies with the adapter schema file ProfilesQuery.xsd. This sample message shows you how to construct an adapter message of type CommerceServerProfilesQuery. |
ProfilesUpdate.xml (in ...\SampleMessages\Profiles) |
Complies with the system schema file ProfileDocument.xsd. This sample message shows you how to construct an adapter message of type CommerceServerProfilesUpdate. |
See Also
Other Resources
Generating and Using the XSD Files Required by Different Commerce Server Systems