Share via

Profiles Adapter Message Types

  • Article

Commerce Server 2009 includes a BizTalk adapter that is designed to interact with the Profiles System, known as the Profiles adapter. There are two types of Profiles adapters, known as the Profiles receive adapter and the Profiles send adapter, each of which is associated with different message types. This topic provides an introduction to the messages associated with each type of Profiles adapter.

Note

The tables within this topic show the BizTalk Server context properties and the message body schemas associated with each of the Profiles adapter message types. The message body schemas are identified as being either Commerce Server 2009 system schemas, which may have to be regenerated periodically as you change the schemas associated with the corresponding Commerce Server 2009 systems, or as adapter schemas, which are adapter-specific and will not change unless new versions of Commerce Server 2009 adapters themselves are released and installed, and maybe not even then. For more information about generating up-to-date Commerce Server 2009 system schemas and about the complete set of schemas used by the Commerce Server 2009 adapters, see Generating and Using the XSD Files Required by Different Commerce Server Systems and Adapter Message Schemas, respectively.

Profiles Receive Adapter Message Types

The Profiles receive adapter produces a single type of message, as follows, which is used to periodically export information from the Profiles System.

CommerceServerProfilesExport

Messages of type CommerceServerProfilesExport are one-way messages that contain a single Commerce Server 2009 profile that matched the configured filter, if any. If more than one profile matches the configured filter, the Profiles receive adapter will produce a distinct export message for each matching profile.

Note

The Profiles Web service has its own search results limit that may limit the number of single-profile export messages generated during a given run a Profiles receive adapter endpoint.

The following table shows context properties and message body schemas that are associated with this one-way message.

Message Type

Context Properties

Message Body Schema(s)

CommerceServerProfilesExport

  • CommerceServerMessageType. Written and promoted by the Profiles receive adapter.

  • Sitename. If it is configured, written and promoted by the Profiles receive adapter.

  • System schema:

    ProfileDocument.xsd (default version)

Profiles Send Adapter Message Types

The Profiles send adapter processes several distinct pairs of solicit-response messages, as follows, which are used to retrieve information from the Profiles System.

CommerceServerProfilesQuery / CommerceServerProfilesQueryResponse

Messages of type CommerceServerProfilesQuery are solicit messages that contain an arbitrary query of the Profiles System.

Note

The Profiles Web service has its own search results limit that may limit the number of profiles returned in the query response message that was generated by the Profiles send adapter.

Note

If you specify a DateTime value in the query within the message body of a CommerceServerProfilesQuery message, you must use a culture invariant format. For more information, see System.Globalization.CultureInfo.InvariantCulture and System.Globalization.DateTimeFormatInfo.InvariantInfo in the .NET Framework.

Messages of type CommerceServerProfilesQueryResponse are the response messages that result from the corresponding solicit message being sent to the Profiles System. Such messages communicate success or failure using the context property CommerceServerCommandResults.

The following table shows context properties and message body schemas that are associated with this solicit-response message pair.

Message Type

Context Properties

Message Body Schema(s)

CommerceServerProfilesQuery

  • CommerceServerMessageType. Must be present if the endpoint transport property Endpoint Message Type is set to From Context.

  • Adapter schema:

    ProfilesQuery.xsd, ProfilesQueryExpr.xsd

CommerceServerProfilesQueryResponse

  • CommerceServerMessageType. Written and promoted by the Profiles send adapter.

  • CommerceServerCommandResults. Written and promoted by the Profiles send adapter.

  • Sitename. If it is configured, written and promoted by the Profiles send adapter.

  • ProfileType. Written, but not promoted, by the Profiles send adapter.

  • Key. Written, but not promoted, by the Profiles send adapter.

  • Adapter schema:

    ProfilesQueryResponseMessage.xsd

CommerceServerProfilesImport / CommerceServerProfilesImportResponse

Messages of type CommerceServerProfilesImport are solicit messages that contain one or more profiles, including profiles of different types, to be imported into the Profiles System. The format of CommerceServerProfilesImport messages is the same as is used by the Profiles Web service CreateProfile.

Messages of type CommerceServerProfilesImportResponse are the response messages that result from the corresponding solicit message being sent to the Profiles System. Such messages communicate success or failure using the context property CommerceServerCommandResults.

The following table shows context properties and message body schemas that are associated with this solicit-response message pair.

Message Type

Context Properties

Message Body Schema(s)

CommerceServerProfilesImport

  • CommerceServerMessageType. Must be present if the endpoint transport property Endpoint Message Type is set to From Context.

  • System schema:

    ProfileDocument.xsd (default version)

CommerceServerProfilesImportResponse

  • CommerceServerMessageType. Written and promoted by the Profiles send adapter.

  • CommerceServerCommandResults. Written and promoted by the Profiles send adapter.

  • Sitename. If it is configured, written and promoted by the Profiles send adapter.

  • ProfileType. Written, but not promoted, by the Profiles send adapter.

  • Key. Written, but not promoted, by the Profiles send adapter.

  • Successful imports:

    Adapter schema:

    ProfilesImportResponse.xsd

  • Unsuccessful imports:

    Adapter schema:

    InvalidProfilesMessageResponse.xsd

CommerceServerProfilesUpdate / CommerceServerProfilesUpdateResponse

Messages of type CommerceServerProfilesUpdate are solicit messages that contain one or more profile updates, including updates to profiles of different types, to be imported into the Profiles System. The format of CommerceServerProfilesUpdate messages is the same as is used by the Profiles Web service UpdateProfile.

Messages of type CommerceServerProfilesUpdateResponse are the response messages that result from the corresponding solicit message being sent to the Profiles System. Such messages communicate success or failure using the context property CommerceServerCommandResults.

The following table shows context properties and message body schemas that are associated with this solicit-response message pair.

Message Type

Context Properties

Message Body Schema(s)

CommerceServerProfilesUpdate

  • CommerceServerMessageType. Must be present if the endpoint transport property Endpoint Message Type is set to From Context.

  • System schema:

    ProfileDocument.xsd (default version)

CommerceServerProfilesUpdateResponse

  • CommerceServerMessageType. Written and promoted by the Profiles send adapter.

  • CommerceServerCommandResults. Written and promoted by the Profiles send adapter.

  • Sitename. If it is configured, written and promoted by the Profiles send adapter.

  • ProfileType. Written, but not promoted, by the Profiles send adapter.

  • Key. Written, but not promoted, by the Profiles send adapter.

  • Successful imports:

    Adapter schema:

    ProfilesUpdateResponse.xsd

  • Unsuccessful imports:

    Adapter schema:

    InvalidProfilesMessageResponse.xsd

CommerceServerProfilesDelete / CommerceServerProfilesDeleteResponse

Messages of type CommerceServerProfilesDelete are solicit messages that specify a single profile to be deleted from the Profiles System. Such messages are parsed by the Profiles adapter to extract the parameters required for the Profiles Web service DeleteProfile.

Messages of type CommerceServerProfilesDeleteResponse are the response messages that result from the corresponding solicit message being sent to the Profiles System. Such messages communicate success or failure using the context property CommerceServerCommandResults.

The following table shows context properties and message body schemas that are associated with this solicit-response message pair.

Message Type

Context Properties

Message Body Schema(s)

CommerceServerProfilesDelete

  • CommerceServerMessageType. Must be present if the endpoint transport property Endpoint Message Type is set to From Context.

  • Adapter schema:

    ProfilesDelete.xsd

CommerceServerProfilesDeleteResponse

  • CommerceServerMessageType. Written and promoted by the Profiles send adapter.

  • CommerceServerCommandResults. Written and promoted by the Profiles send adapter.

  • Sitename. If it is configured, written and promoted by the Profiles send adapter.

  • ProfileType. Written, but not promoted, by the Profiles send adapter.

  • Key. Written, but not promoted, by the Profiles send adapter.

  • Adapter schema:

    ProfilesDeleteResponse.xsd

See Also

Other Resources

Orders Adapter Message Types

Catalog Adapter Message Types

Inventory Adapter Message Types

Generating and Using the XSD Files Required by Different Commerce Server Systems

Adapter Message Types