The Transport Dictionary

The Transport Dictionary is a Dictionary object that applications pass to the Commerce Interchange Pipeline (CIP). The Transport Dictionary has the same relationship with the CIP that the order form has with the order processing pipeline (OPP); it is the target of all CIP activity.

An application creates a Transport Dictionary to be passed as an argument to the CIP’s Execute method. This method can be invoked on the MtsPipeline or MtsTxPipeline object.

Once the Execute method is called, the various components that make up the sequentially executed stages of the CIP read data out of the Transport Dictionary into memory, perform various operations (for example, encryption and digital signing) on this data, and then write the result back into the Transport Dictionary.

In the case of a transmit pipeline, the pipeline begins with the Transport Dictionary that contains a name/value pair, usually called Object, which references the business data object, which is the object that contains the business document that you want to transmit. The Transport Dictionary may also contain an optional receipt request and an optional application identifier.

The business data object is referenced by the Transport Dictionary

As the Transport Dictionary is passed by the CIP from one component to the next, these components write new values to the Transport Dictionary (or overwrite old values), based on the contents of the business data object. Unlike the order processing pipeline, in which various components write various name/value pairs to an OrderForm, CIP components generally work with a single name/value pair on the Transport Dictionary: the working_data name/value pair. As the Transport Dictionary is passed to a component, it reads the contents of working_data into memory, performs some operation on the data, and overwrites the original working_data value. Where a component reads from or writes to a name/value pair other than working_data, this name/value pair is noted in the documentation on that component.

In the case of a receive pipeline, the pipeline begins with a Transport Dictionary that contains the data received. Depending on the transport used, this data may have been encrypted, converted to text and sent as e-mail or posted as an HTTP request. Whatever the mode of transmission, components in the receive pipeline are usually configured to process this data, converting it step-by-step back into a data object or other format such as EDI that can be used by the business application. Along the way, the pipeline components add the results of their conversions to the Transport Dictionary.

Note

While working_data is the default name/value pair for most CIP components, you can configure CIP components to use any name/value pair that you want.


© 1997-1998 Microsoft Corporation. All rights reserved.