Share via


CreateUPMCookie

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Use this component to collect cookie data to pass to an Active Server Pages (ASP) page generating a personalized message.

Intended use: DirectMailer pipeline, Create Cookies stage.

Values Read

The CreateUPMCookie component reads the following values from the indicated dictionaries.

Key

Dictionary

Description

rcp_bypass

Order

Boolean. The component bypasses (skips) processing if True.

rcp_personalize

Order

Optional. Numeric. Use this key to indicate whether or not to personalize the message for this recipient. The values are:

  • 0. Do not personalize

  • 1. Personalize

The default is 1 (personalize).

rcp_url

Order

The URL used to retrieve the mailing content. Takes precedence over default_url.

rcp_url_isfile

Order

True if the URL for the content (rcp_url) is a file and not an http:// address.

cookie

Order

Optional. A reference to a dictionary to hold the created cookie. This key is created if it is not present.

rcp_guid

Order

Optional. The globally unique identifier (GUID) uniquely identifying this recipient, taken from the user profile.

rcp_email

Order

The e-mail address of the recipient.

css_site

Context

The site ID string.

campaign_item

Context

Optional. The campaign item ID.

CampaignItemName

Context

Optional. The name of the campaign item.

default_url_isfile

Context

This key is True if the default URL is a file path and not an http:// address.

Values Written

The CreateUPMCookie component writes the following values to the Order dictionary.

Key

Description

cookie

A dictionary containing the information that will be used in the cookie.

Remarks

The CreateUPMCookie component does nothing if the rcp_bypass key is True, if the default_url_isfile key is True, or if the rcp_personalize key is zero (0).

The CreateUPMCookie component keeps the cookie information in a dictionary. The cookie string is produced by the ComposeDMLMessage component.

If the message is not personalized, the component creates a cookie entry (assigns YES to the key Microsoft_DirectMailer) to prevent the Collaboration Data Objects (CDO) from using a locally stored cookie.

The cookie string created from the data has the following format:

MSCSProfile='encryptedstring';CampaignItemID=string;CampaignItemName=string;UserEmail=string

The items in the cookie have the following meanings.

Item

Description

MSCSProfile

String. The user profile ID, which is needed for personalizing the message.

CampaignItemID

String. The Campaign item ID, which is necessary for click tracking.

CampaignItemNames

String. The Campaign item name, which allows labeling the message for the user.

UserEmail

String. The e-mail address of the user.

The abbreviations in the table are also the keys used in the Cookie dictionary.

The user profile ID is encrypted only when the e-mail is sent as part of the campaign. In a stand-alone Direct Mailer job, the user profile ID is not encrypted.

See Also

Other Resources

AddAttachments

ComposeDMLMessage

SendPrecomposedMessage

ThrottleDMLPerformance

VerifyMessageBody

VerifyRecipientData