Using an Order Log

There are two ways to view order processing pipeline (OPP) information. You can create an OPP run-time information log, which includes all the name/value pairs that are written to the OrderForm by each component in each stage. You can also view the contents of the OrderForm using the DumpOrder sample Scriptor component.

You can log run-time information for each stage in the pipeline to a text file. By doing so, you see each stage and each component within that stage as it is executed, including the information written to the OrderForm at each stage. This is useful for debugging the order process. To do this, add a call to the SetLogFile function.

To set up an order debug log for Volcano Coffee

1. In a text editor, open Util.asp for the Volcano Coffee site. This file is usually located in the \Inetpub\WWWRoot\Vc30\Include subdirectory.
2. In Util.asp, a pipeline object is created. Search for the following code:

   REM Call pipeline.SetLogFile("c:\temp\pipeline.log")
   

3. Delete the REM keyword from the second line of code.
4. Repeat steps 2 and 3 for a second call to SetLogFile.
5. Save the file.

When you run the pipeline, stage and component information will be written to the specified file.

Warning  For the log file to be created, you must specify a location in which you have Write permission; otherwise, the log file creation will fail without a warning.

Remember that the order processing system is a series of components that execute in turn; the stages are merely an abstract grouping of those components. Thus, in the log file, components are numbered in the order that they are run and listed by name, but are not separated by pipeline stage.

Some stages have a built-in component that performs certain consistency tasks but does not appear in the list of pipeline components in either Pipeline Editor. These components are included in the log file and in the ordinal list, however.

For example, the following entry in the log file refers to the first component in the site. For the Clocktower, that would be the QueryProdInfo component (in the Product Information stage):

PIPELINE:++ component[0x0] about to be called    PROGID:  Commerce.QueryProdInfo.1

The next entry in the log file refers to the second component in the site. For the Clocktower, that would be the required component (in the Product Information stage):

PIPELINE:++ component[0x1] about to be called    PROGID:  Commerce.RequiredProdInfo.1

Note  The log file is easier to read if you use a spreadsheet application, such as Microsoft® Excel, to view it.