CSFIISAppendToLog
Use the CSFIISAppendToLog pipeline component to record information about content selection results in the QueryString key of the Internet Information Server (IIS) log file.
Intended use: Content Selection pipeline, Record stage; Order Processing pipeline, Accept stage.
Values Read
The CSFIISAppendToLog pipeline component reads the following values from the indicated dictionaries.
Key |
Dictionary |
Description |
|---|---|---|
_event |
Order |
A string that contains the name of the event to log. |
_winners |
Order |
A SimpleList object that contains the values from the item_id key of the winning content items. If this entry is present, the _winnerindexes key should not be present. If both are present, only the _winnerindexes key will be used. |
_eventcount |
Order |
Optional. A SimpleList object that contains the number of events to record for each winning content item. It must contain the same number of elements as the list of winners. If this key is not present, one event will be recorded for each winning content item. |
_winnerindexes |
Order |
A SimpleList object that contains the ContentList object indexes of the winning content items. If this key is present, the _winners key should not be present. If both are present, only the _winnerindexes key is used. |
PageGroups |
Context |
A dictionary that maps page group names to IDs from the identity column in the page_groups database table. |
ContextProfile |
Context |
Optional. A reference to the ContentSelector object (CSO). This object can be assigned arbitrary properties and can be used to pass additional information into the pipeline. Two entries are required. |
PageGroupId |
Context |
Optional. The current page group. |
Values Written
None for the Order or Context dictionaries.
Remarks
The CSFIISAppendToLog pipeline component appends information about the result of the content selection process in the QueryString key of the IIS log file. This log file can be imported into the Data Warehouse for use with reporting and analysis. This component can only be used in the context of IIS because it uses the AppendToLog method of the IIS Response object.
The logging format is:
&CVET={T=class, property=value, property=value1+value2}
The components and their descriptions for this logging format are listed in the following table.
Key |
Description |
|---|---|
&CEVT={ |
The start of a Commerce event entry in the URI_Query object. |
} |
The end of a Commerce event in the URI_Query object. |
T=class |
The event class as defined in the Data Warehouse event class definitions, where class is the name of the corresponding definition. The value of class is always CAMP. |
Property=value |
A value associated with a particular property. Both property and value strings must be URL-encoded (the space character and the following characters are subject to encoding: { } , = & +).Typical properties include CI (campaign item), CNT (count), and EVT (event). |
Property=value1+value2 |
Multiple values that are associated with a particular property. Both property and value strings are URL-encoded. |
, (comma) |
Used as the separator between elements. |
The following lines are examples of possible log formatted strings and a description of their contents:
&CEVT={T=CAMP,CI=3,EVT=REQUEST,PG=2}
Campaign event, campaign item 3, event name=REQUEST, page group id =2
&CEVT={T=CAMP,CI=1,CNT=3,EVT=CLICK}
Campaign event, campaign item 1, count=3, event name=CLICK
&CEVT={T=CAMP,CI=3,EVT=DOWNLOAD}