Audit

Audit

The Audit component, which usually appears in the Audit stage of a Commerce Interchange Pipeline, writes the specified values from the Transport Dictionary into a database table in the audit database.

Connection String. Specifies the connection string used for connecting to the database into which the audit data is saved. The connection string must include either the full connection string (the DSN, database login ID, and database password) or the name of a named connection stored in the connection map.
Table. Specifies the name of the database table into which the audit data is saved. This table must exist in the database identified by the connection string.
Add a field. Specifies the name of a field that the Audit component reads from the Transport Dictionary. This name must exactly match the name of a column that exists in the database table identified in the Table field. If the field exists on a child object, the name to be added must be a fully qualified path (for example, object1.field). Column names must be unique, otherwise the component takes only the first instance of the field name. Type the name, and then click Add to add the column to the Fields to record list.
Fields to record. Lists the names of the optional fields on the Transport Dictionary that the Audit component will write to the database table identified in the Table field, in addition to those fields written be default (as described later in this topic). To add a name, type the name in the Add a field box, and then click Add. To remove a name, select it, and then click Remove.

Remarks

The Audit component always writes the values of the following name/value pairs in the Transport Dictionary into columns in the database with the same names:

Name	Description
txid	Transaction ID. A name/value pair originally written to the Transport Dictionary by the transmitting application or by the AddHeader component in the Transmit pipeline. (Must be the primary key in the database table).
utc_datetime	Time (Universal Coordinated Time) when the Audit component runs.

In addition, the Audit component writes the values of the following name/value pairs in the Transport Dictionary, if they exist, into columns in the database with the same names:

Name	Description
receipt_requested	Optional name/value pair originally written to the Transport Dictionary by the transmitting application, indicating a request for the receiving application to send a receipt.
AppID	Application ID. An optional name/value pair originally written to the Transport Dictionary by the transmitting application, usually indicating the programmatic ID (progID) of the transmitting application.
return_receipt_request	Optional name/value pair written to the Transport Dictionary by the OpenHeader component, containing the hashing algorithm (<DIGESTALGORITHM>) and the type of receipt document requested (<DOCUMENTTYPE>).
msg_digest	Digest (hash) of the business data object written to the Transport Dictionary by OpenHeader.
document_type	Optional. Description of the type of business object being transmitted.
document_source	Optional. Description of the source of the business object, usually the name or address of the company transmitting it
document_destination	Optional. Description of the destination of the business object, usually the name or address of the company receiving it.
send_datetime	The date and time of the OpenHeader operation.

When using the Audit component, observe the following notes:

Each column in the table must be one of the default columns or have a corresponding entry in the Fields to record list.
Each column in the table must allow nulls to be inserted.
Values that contain text, where the text includes a single-quote (') character, cannot be logged by the Audit component.

For an example of this component, see the Commerce Interchange Transmit pipeline used by the Microsoft Market sample site (Inetpub\Wwwroot\Market\Config\InterchangeTransmit.pcf).

Audit

Remarks

Related Topics