Exporting Contact Event Data Guide
Exporting Contact Event Data Guide
A b ou t expor ting Contact Event Data .......................................................................................................................................... 2 Configuring a Contact Event Data expor t job ............................................................................................................................ 2 Using Custom Columns .................................................................................................................................................................. 3 A b ou t Contact Event Data ou t pu t files ....................................................................................................................................... 4 Contact Event Data out pu t files ............................................................................................................................................... 5 Contact Event Type IDs ............................................................................................................................................................. 8 Launch Status Values ................................................................................................................................................................. 9 Launch Type Values .................................................................................................................................................................. 10 Source Identification Values ................................................................................................................................................... 10 File Layou ts ..................................................................................................................................................................................... 11 Launch State ............................................................................................................................................................................... 11 Bounced ...................................................................................................................................................................................... 12 Clicked ........................................................................................................................................................................................ 13 Complaint ................................................................................................................................................................................... 14 Conver ted ................................................................................................................................................................................... 16 Failed ............................................................................................................................................................................................17 Opened ....................................................................................................................................................................................... 18 Sent .............................................................................................................................................................................................. 19 Skipped ...................................................................................................................................................................................... 2 0 Form ............................................................................................................................................................................................ 21 Form State .................................................................................................................................................................................. 22 Op ted In ...................................................................................................................................................................................... 22 Op ted Out .................................................................................................................................................................................. 23 Program ..................................................................................................................................................................................... 24 Program State ............................................................................................................................................................................ 25 Accessing the Responsys File Server ........................................................................................................................................ 25
The Expor t Con tact Event Data feature lets you extract behavioral and o ther raw data abou t events fro m accountwi de and campaign -specific response activi ties. For example, logs can tell you on a ro w- by-ro w basis who was sent campaign X and when it was sent. W i th this infor mation, you can keep your system of record up to date wi th comp liance data or load data int o your repor ting system or o ther third par ty applications. Once you have expor ted the data, you can use it for:
Audi t tracking Scrubbing data Do wnloading to external pro grams Analyzing campaigns using your analytics or o ther sof t ware
Information is expor ted t o flat text files that are available on the Responsys file server associated wi th your account (for example, files.responsys.net or files.dc2.responsys.net) for 14 days. You can have the expor t data files packaged in individual ZIP archives and can also specify GPG /PGP encryp tion. A f ter you run an expor t for the first time, each subsequent repor t con tains an incremental update of events that occurred since the last successful expor t. You use the Launch_State values to create a lookup table of events so that you can match more recent events to an existing launch record. This is particularly imp or t ant for trigg ered events where the launch date and send date are no t necessarily the same.
A Con tact Event Data Expor t job lets you select the data you want to see, the for mat and location of the expor t file, and ho w of ten the file is created. Data is only available for 3 0 days, so best practice is to run expor t jobs on a daily basis. Although the data is available for expor t fro m the database for 3 0 days, the zip files, once you create them, are only available on the server for 14 days. You create and maintain a Contact Event Data Expor t job the same way as other Interact Connect Expor t jo bs. Al though you can create mul tiple Contact Event Data Expor t jobs for each account, you can only have one active Expor t Con tact Event Data job per Event t ype. For example, you could set up one expor t job to out pu t Bounced Event infor mation and another to out pu t Com plaint Event information, but you could no t configure t wo active expor t jobs to out pu t Bounced Event informat ion.
1 2 3
From Interact Connect click . Choose . On the Source page of the W izard, click check boxes for the Event Types you want to do wnload. Click W e recommend that you sta r t wi th these event t ypes; you can include o thers as well.
4 5
Click . On the Target File page, in the File Location area, enter the access specifications for a Responsys file server or choose an external server. The File Location for a Resp onsys File Server would look like this: Server: or (Check wi th Suppor t for your file server location.) / Responsys Interact Connect / Expor ting Contact Event Data / responsys.com 2
Username:
_scp ( is the shor t name of your Responsys Interact Accoun t. It appears to the righ t of the @ in your admin login: admin@ )
Choose
as the delimi t er bet ween the fields (columns) in the do wnload file. You can also choose comma, semicolon, or pipe as the delimiter, but tabs work best, especially if youre including custom columns.
Choose whether to enclose text columns in single quo tes, double quo te, or none. setting to expor t column headers as the first line in the Turn on the
expor ted file.
Choose whether to encryp t or com press your expor t job as a . zip file (or bo th).
Al though you can choose no t to compress or encryp t the file, the resulting ra w text file takes significantly longer to do wnload (and consumes more storage space on your file system and ours).
Choose whether to create a Ready File for validation after the file is expor ted. Enter a file extension if
needed. The op tions are none, an em p t y file, and a record count. Use an emp t y file to validate the completion of your do wnload process. Use a record count file (recom mended) to com pare sim pl e record counts to verify that all expected record counts were transferred. This is similar to the way the count file is used to validate a job impor t file. The Ready file and your expor t job have the same name. 7 8 Click . On the page, select whe ther to receive email no tification after each job is run, only after a failed jo b, or no t at all. Enter one or m ore email addresses if needed. Click . 9 On the page, choose ho w of ten you want t o expor t the file (once a day is typically sufficie nt ). Click . page, choose whether to activate or deactivate the expor t. Ad d a name and 10 On the descrip tion, and click . The new job is listed on the All Jobs tab.
There are times when the standard Contact Event Data columns do no t cap ture all the data elements you wan t t o repor t on, or you migh t need to feed additional information back to your System of Record. For example, you migh t use the! MasterData/ C ONTACT_LIST COUNTRY_ISO3 list column and want to include this information in the Contact Event Data out pu t file. Each account can have up t o t welve custom columns. All custom column inform ation per event must fit within a field defined as varchar2( 4 0 0 0 ), and must account for XML meta -data used to st ore the custom -column namevalue pair information in the given column. Custom column values are drawn fro m the Campaigns List or associated Personalization Data sources as defined in the Campaign Dashboard. For more information about the Contact Event Data ou t pu t files that suppor t custom columns, see Contact Event Data Out pu t Files. The source Event determines ho w custo m column infor mation is cap tured.
The W orklist based on the recipient profile in the List The incoming name-value pair passed during the form post 3
The value of the click or conver t event's querystring name / value pair. This is because values set in the click tracking URL at the time of launch for a campaign are typically bet ter for campaign and recipient tracking and at tribu tion projects. Similarly, conversion parameter values determined and set at conversion time are typically t he appro priate source of custom field dat a.
W hen tracking custom field values for click events and conver t events, the name in the name-value pair must be the target custom column name. These are the expected for mats for links in email campaigns:
For example, if cid, vid, and oid are defined as custom fields, these incoming values are persisted for this click event and available for exp or t as Clicked Event data. Similarly, custom fields for Converted Events should be passed as name-value pairs in the conversion tracking URL and would be specified by website code at conversion ti me.
2 3 4 5 6
Make sure the desired custo m data element / c olumn exists in the List or a Supplemental Data table associated wi th the campaign. If a column of the same name exists in more than one Supplemental Table for a campaign, make sure the custom column value is the same every where its used. link. Log in as an admin user and click the Click . Click . Enter a name and descrip tion (op tional) for the ne w custom column. Make sure the name is the same as the column name in the List table / o bject. Click . The configuration will apply for all future launches.
Contact Event Data out pu t files contain infor mation ab ou t each Event transaction . Each ro w represents one Even t t ransaction / occurrence. In general, each out pu t file con tains data for only one Event Type. Ho wever, some out pu t files contain information ab ou t multiple closely related Event Types. For example, the Form Contact Event Data contains information about For m submissions and Form vie ws. Each Contact Event Data out pu t file is a text flat file delimi ted the character you choose: com ma, semi-colon, tab, or pipe character. All ro ws in the out pu t file are related to your system of record data or repor ting data based on the CUSTOMER_ID value (a unique identifier for each recipient ). For Contact Event Data out pu t files that con tain information abou t multiple event types ( for example, the Form Event Contact Data out pu t ), each event t ype is identified by an Event Type ID value. See Contact Event Type IDs for a mapping of Contact Event Type ID values to their respective Event Names and Ac tions. See File Layou ts for a descrip tion of the columns in the Con tact Event Data out pu t files. All extracted date and time values are format ted in Coordinated Universal Time (UTC) for consistency and ease of com parison. The event infor mation con tained in each Contact Event Data out p ut is the data accumulated since the
last successful Contact Event Data extract was pro d uced. Therefore, it is quite likely the days Contact Event Data ou t pu t file may con tain data for more than a single 24 -hour period.
The table belo w provides a descrip tion of each Cont act Event, its corresponding data filename, and the type of events or actions captured in the out pu t file. The out pu t data filename is the name of the final text flat file that contains the out pu t data. The filename of the file(s) available on the file server depends on your configuration of the Cont act Event Data job; compressed files have a zip extension; encryp ted files have a g p g extension; ready and count files have extensions based on your set tings.
Launch State
Data accountID_LAUNCH_ regarding STATE_YYYYMMDD_ when a launch HH24MISS.txt starts, pauses, resumes, and stops
: N/A : N/A Use this file to create a lookup table for mapping LAUNCH_ID value that appears in other out pu t files. This mapping is particularly imp or tan t for trig gered launches, where the launch date and send date are not necessarily the same.
Bounced
_BOUNCE_ _
: No : No Starting in version 6.9, the Bounced Event Feed Type d oes no t suppor t Custom Columns.
Clicked
Tracked links _
_CLICK_ .txt
: Yes : Yes CUSTOMER_ID and Custom Column values are p o pulated fro m the event URL data.
Complaint
Spam _ com plaints repor ted by ISPs via feedback loo ps Conversions registered by Conversion Tracking functionalit y
_COMPLAINT _ .txt
: No : No
Conver ted
_CONVERT_ _ .txt
: Yes : Yes CUSTOMER_ID and Custom Colum n values are p o pulated fro m the event URL data. Includes Purchase events.
Failed
_FAIL_ _ .txt
Yes Yes The follo wing condi tions are so me, but no t all, p ossible reasons for failure to launch a specific message: No Response from any of Numb er MTAs No Response from any of Number MTAs (an d SMTP Server Busy on Failover) SMTP Error SMTP Error (and SMTP Server Busy on Failover) SMTP Server Busy CUSTOMER_ID and Custom Column values must be par t of the profile list or Personalization data sources.
Opened
_OPEN_ .txt
: Yes : Yes Interact tracks open events via a 1x1 pixel image; recipients must allo w images to be displayed in order t o kno w the recipient has o pened the message. CUSTOMER_ID and Custom Column values are p o pulated fro m the event URL data.
Sent
Messages by recipient by campaign launch that were successfully sent to the target mail server Suppressions
_SENT_ _ .txt
: Yes : Yes
Skipped
_SKIPPED_ _ .txt
: Yes : Yes The follo wing condi tions are some, but no t all, p ossible reasons for skipping a recipient when launching a campaign: Email is suppressed at the pod level, the account level, or at the cam paign level Email is suppressed at the po d level, the account level, or the campaign level Invalid email address Missing data for $replacementField$ Personalization errors, including pro blems with <Format Type> message or missing data for <Dynamic Values> such as Variable, Data Field, or Document. CUSTOMER_ID and Custom Column values must be par t of the profile list or Personalization data sources.
Form
_FORM_ .txt
: Yes : Yes (Form Submi ts only) Read the EVENT_TYPE_ID column for the specific event t ype designation. : Custo m Column values are populated based on incoming parameters (GET / POST request) where names match Custom Column names. : Custom Column values ARE NOT suppor ted.
Form State
_FORM_STAT _ .txt
: N/A : N/A
Op ted In
_OPT_IN_ _ .txt
: Yes : No An Op tIn event is recorded if: A ne w record is inserted w ith an Op tIn permission status An existing records permission status is changed fro m Op tOu t to Op tIn Permission status changes via: Vie w / e di t data screen Form submissions Program Set Data calls W eb services
Op ted Out
_OPT_OUT_ _ .txt
: Yes : Yes An Op tOu t event is recorded if the existing record has a permission status of Op tIn and is being changed to Op tOu t. Permission status changes via: Vie w / e di t data screen Form submissions One-click Op tOu t form sub mission Unsubscribe via an email reply ( when the reply address is hosted by Responsys) Program Set Data calls W eb services
Program
Information for Program Entry and Program Exit events Includes infor ma tion abou t when a Program is published or unpublished
_PROGRAM_ _ .txt
N/A N/A W ho entered a Program w hen; who exi ted a Program when
Program State
STATE_
_PROGRAM_ _ .txt
: N/A : N/A
These Contact Event Type IDs are used in Contact Event Data out pu t files to identify the event in each ro w .
-1 1 2 4 5 6 7 8 10 11 12 14 15 16 17 18 19 20 21
No t specified Sent Bounced Opened Clicked Conver ted Unsubscribed Failed Skipped Entered_program Ended_pro gram Vie wed_form Submit ted_for m For warded Form_A bandoned Spam_Com plaint Purchased Spent Joined_List
No t Used _Sent_ _Bounced_ _Opened_ _Clicked_ _Conversion_ _Unsubscribed_ _Failed_ _Skipped_ _Entered_program_ _Ended_pro gram_ _Vie wed_form_ _Submit te d_for m_ _For warded_ _Form_A bandoned_ _Spam_Complaint_ _Purchased_ _Spent_ _Joined_List_
Standard Standard Standard Standard Standard Standard Standard Standard Standard Program Program Form Form Standard Form Standard Standard Standard List Occurs when a recipient op ts in to a list) List List List 8
22 23 24
Deactivated_Mobile Ac tivated_Postal Deac tivated_Postal EMail_ChangeOf A d dress Mobile_ChangeNumber Postal_ChangeOf A d dress Deleted_From_List EnteredEnded_Program FTAF_Sent FTAF_Failed FTAF_Skipped FTAF_Clicked FTAF_Link FTAF_Submi t FTAF_Opened FTAF_Conver ted Social_click Social_conversion Social_purchase
_Deactivated_Mobile_ _Ac tivated_Postal_ _Deactivated_Postal_ _EMail_ChangeOf A d dress_ _Mobile_ChangeNumber_ _Postal_ChangeOf A d dress_ _Deleted_From_List_ _EnteredEnded_Program_ _FtaFSent_ _FtaFFailed_ _FtaFSkipped_ _FtaFClicked_ _FtaFLink_ _FtaFSubmi t_ _FtaFOpened_ _FtaFConver ted_ _Social_click_ _Social_conversion_ _Social_purchase_
List List List List List List List Program FTAF FTAF FTAF FTAF FTAF FTAF FTAF FTAF Social Social Social
The LAUNCH_STATE Feed out pu t uses a launch_status column to indicate the launch state at the time of the event transaction. Ideally, a series of launch state events will start wi th Build W ork List and finish wi th Com plete, meaning the campaign launch activit y com pleted. These values can apply to eit her a campaign or a form. These are the launch_status values:
N R B
Unkno wn Requested Building W ork List Creating the final list of recipients, accounting for recipients who are Undeliverable ( t he deliverability permission status), and o p ted -ou t (if the campaign is a promo tional campaign). Interact also identifies the recipients to skip due to suppression set tings. The list of recipients for whom Interact will at temp t t o create a personalized message Sending the messages The launch process has com pleted for the given campaign launch. The launch process was paused.
L S C P
T M F
The launch process was sto p ped. A paused launch was subse quently resumed. The launch process failed.
The LAUNCH_STATE Feed out pu t uses a launch_type column to indicate the way a launch was requested at the ti me of the event transaction. These are the launch_type values:
S T X V P
Launches via Program, form follo w -up, or the API's t rig geredCampaignMessage method. A launch type of P is created when the campaign is created. Ho wever, star ting wi th 6.12.1, campaigns launched via Program use the R launch type. Campaign Usage / Form Usage. The launch record is created when users select Campaign Usage or Form URLs fro m the o bject's con text menu. Used primarily for testing purp oses. Program Triggered Launch. As of 6.12.1, campaigns launched via Program no longer use the Triggered (P) launch record. This launch ty pe is created when the program is published.
Usage
Program Triggered
Several Contact Event Typ e data out pu t files have a column named SOURCE that identifies the application or m o dule that initiated (raised) the specific event. For example, if a reci pient op t s-in via a hosted form, the SOURCE value is Form for the OPTIN Contact Event Type Data record. These are the source ident ification values:
Form Program User Interface UI Data Vie wer UI List Upload Exchange W ebservice Exchange Connect
10
XS SC RT UN
Email reply sent to a Responsys-hosted reply to address, and processed by the Reply To Handling feature
These are the layou ts of the expor t files. All timestam ps are presented in UTC wi th this for mat: -
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO NO
Date and time the system was informe d about the event Date the event transaction was stored into the Event DB Numerical identifier of the specific campaign
NO
Numerical identifier of the launch instance A string value matching the campaign name assigned by your W eb analytics package for the specific campaign Used to associate system events to events and data in your W eb analytics package
EXTERNAL_CAMPAIGN_ID V ARCHAR2(255)
SF_CAMPAIGN_ID
V ARCHAR2(255)
A string value ma tching the ID of the associated Salesforce campaign object Only used wi th Interact Connect for Salesforce integration.
Name of the Campaign. Campaign name at launch ti me (same as CAMPAIGN_NAME) The state of the campaign launch at the time of the event ro w. See Launch Status Values for more infor mation.
LAUNCH_TYPE
CHAR(1)
NO
The method by which the campaign was launched. See Launch Type Values for more information.
LAUNCH_CHARSET
V ARCHAR2(255)
Language character set for the campaign. Normally, this value is either ISO-8859-1 or UTF-8, but depends on the exact campaign configuration.
PURPOSE
CHAR(1)
11
= pro mo tional = transactional SUBJECT V ARCHAR2(255) The campaigns subject line. Can include built-in functions, as this the raw subject line as configured in the Campaign Dashboard. DESCRIPTION PRODUCT_CATEGORY PRODUCT_TYPE MARKETING_STRATEGY V ARCHAR2(4 0 0 0 ) V ARCHAR2(255) V ARCHAR2(255) V ARCHAR2(255) Marketing Strategy Category as configured in the Campaign Dashboard. Possible values are configured in the accounts A d ministrative Configuration screens available to the admin user. MARKETING_PROGRAM V ARCHAR2(255) Marketing Program Category as configured in the Campaign Dashboard. Possible values are configured in the accounts A d ministrative Configuration screens available to the admin user. LAUNCH_ERROR_CODE LAUNCH_STARTED_DT V ARCHAR2(255) TIMESTAMP(6) Campaign Descrip tion, as entered in the Campaign Dashboard.
LAUNCH_COMPLETED_DT TIMESTAMP(6)
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record.
NO NO NO NO NO
Date and time the system was informed about the event . Date the event transaction was stored into the Event DB. Numerical identifier of the specific campaign Numerical identifier of the launch instance Email address that initiated the bounce event 12
The email address of the response event may differ fro m the email address in the List. This is because recipients can for ward messages from one email account to ano ther before ultimately handling the message. EMAIL_FORMAT CHAR(1) NO Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t BOUNCE_TYPE CHAR(1) NO Hard or Sof t bounce = Hard bounce = Sof t Bounce REASON REASON_CODE V ARCHAR2(5 0 0 ) V ARCHAR2(5 0 0 ) Bounce category value (e.g. USER_NOT_FOUND, CONNECTION_REFUSED, etc.) The bounce message as provided by the ISP. Informational text the ISP provides when bouncing a message. This informational text is impor tant in determining if a block has occurred, and also includes ways to contact the ISP regarding questions SUBJECT CONTACT_INFO V ARCHAR2(255) V ARCHAR2(10 0 0 ) The b ounced messages subject line value A d di tional data for you to understand ho w to best follo w up wi th com plaints, b ounces, skips and changed contact data Possible values depend upon the subject Channel for the given event: Email Channel: Recipients email address (from the List) Mobile Channel: Recipients mobile number (fro m the List)
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this speci fic List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of 13
record EVENT_CAPTURED_DT EVENT_STORED_DT CAMPAIGN_ID LAUNCH_ID EMAIL_FORMAT TIMESTAMP(6) TIMESTAMP(6) NUMBER NUMBER CHAR(1) NO NO NO NO NO Date and time the system was informed about the event . Date the event transaction was stored into the Event DB. Numerical identifier of the specific campaign Numerical identifier of the launch instance Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t OFFER_NAME V ARCHAR2(255) NO The name of the link. The LINK_NAME value from the campaigns link table OFFER_NUMBER OFFER_CATEGORY NUMBER V ARCHAR2(255) NO Numerical identifier used for click tracking The link category value. The LINK_CATEGORY value fro m the campaigns link table OFFER_URL V ARCHAR2(4 0 0 0 ) NO The URL of the clicked link
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO
Date and time the system was informed about the event . Date the event transaction was stored into the Event DB. Numerical identifier of the specific campaign Numerical identifier of the launch instance Recipients preferred email conten t format, HTML or Text. = HTML = Text
14
= No Preferred = Multi-par t REASON V ARCHAR2(5 0 0 ) Method by which the complaint was cap t ured: SP:Spam Complaint SP:Spam Complaint Transfer (Com plaints that were o b tained via the Interact 5.x implementation during the first 3 0 -6 0 days after swi tching to Interact 6.x) EMAIL V ARCHAR2(255) Recipients email address that the spam com plaint. If recipients have for warded the message to a second (or third) email address, this is the email add ress used to make the complaint. This may differ from the email address in the List. This is because recipients can for ward messages from one email account to ano t her before ultimately com plaining. EMAIL_ISP V ARCHAR2(255) ISP of the recipients email address (e.g. Yahoo!, Hot mail, etc.) If the ISP is unkno wn / uncategorized, a value of O ther is presented. COMPLAINER_EMAIL V ARCHAR2(255) Recipients email address that com plaint repor t. the spam
The email address of the spam com plaint event may differ fro m the email address in the List. This is because recipients can for ward messages fro m one email account t o ano ther before ultimately complaining. SPAM_TYPE CONTACT_INFO NUMBER(8,2) V ARCHAR2(10 0 0 ) Hardco ded to 0 , which translates to AUTO_SPAM. A d di tional data for you to understand ho w to best follo w-up wi th com plaints, bounces, skips and changed contact data Possible values depend upon the subject Channel for the given event: Email Channel: Recipients email address (from the List) Mobile Channel: Recipients mobile number (fro m the List) COMPLAINT_DT TIMESTAMP(6) Date the complaint was rep or ted to the ISP.
15
As of Responsys Interact 6.8, the Conver ted event replaces the Purchase event. It uses the previous Purchase expor t schema, wi th three addi tional columns: ORDER_ID, ORDER_TOTAL and ORDER_QUANTITY.
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO NO NO
Date and time the system was informed about the event Date the event transaction was stored into the Event DB Numerical identifier of the specific campaign Numerical identifier of the launch instance A p plication / mo dule that initiates the event Conversion / Purchase events are initiated / repor ted by an external source (your W eb site), so this value will always be Unkno wn. See Expor ted value is Source Value found in the table of the Source Identification Values section.
EMAIL_FORMAT
CHAR(1)
NO
Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t
OFFER_NAME
V ARCHAR2(255)
NO
The name of the link that initiated the Conversion. The LINK_NAME value from the campaigns link table
OFFER_NUMBER OFFER_CATEGORY
NUMBER V ARCHAR2(255)
NO
Numerical identifier used for click tracking The link category value. The LINK_CATEGORY value fro m the campaigns link table
OFFER_URL ORDER_ID
V ARCHAR2(4 0 0 0 ) V ARCHAR2(255)
NO
The URL of the clicked link that initiated the Conversion The order ID value of the specific order as passed by you when registering the Conversion. The value from the OrderID name -value pair when calling the Conversion Tracking image pixel
16
ORDER_TOTAL
NUMBER(18,2)
The to tal amount of the order as passed by you wh en registered in the Conversion. The value from the OrderTo tal name-value pair when calling the Conversion Tracking image pixel
ORDER_QUANTITY
NUMBER(18,2)
The to tal number of items in the order as passed by you when registering the Conversion / Purchase The value from the NumItem name -value pair when calling the Conversion Tracking image pixel
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO NO NO
Date and time the system was informed about the event . Date the event transaction was stored into the Event DB. Numerical identifier of the specific campaign Numerical identifier of the launch instance Email address of the recipient. The value depends on the launch condi tions: Live Launch: the Value is the email address fro m the List Proof Launch to a Proof List: the Value is the email address from the Proof List Proof Launch to specific email address(es) or Proof Launch personalized against Proof Lis t: Value is the email address specified during the Proof Launch setup
EMAIL_ISP EMAIL_FORMAT
V ARCHAR2(255) CHAR(1) NO
Domain value of the recipients email address (e.g. yahoo.com) Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t
17
OFFER_SIGNATURE_ID
NUMBER
See SENT See SENT Message size in bytes See SENT A d di tional data for you to understand ho w to best follo w up wi th com plaints, b ounces, skips and changed contact data. Possible values depend upon the subject Channel for the given event: Email Channel: Recipients email address (from the List) Mobile Channel: Recipients mobile number (fro m the List)
REASON
V ARCHAR2(5 0 0 )
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned f or this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO NO NO NO
Date and time the system was informed about the event. Date the event transaction was stored into the Event DB. Numerical identifier of the specific campaign Numerical identifier of the launch instance Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t
18
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction. See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this specific List record The value depends on the launch condi tion: Live Launch: The RIID is drawn from the distribu tion List object Proof Launch personalized against the live distribu tion List: The RIID is dra wn fro m the distribu tion List object Proof Launch personalized against the Proof List: The RIID is drawn from the Proof List object
CUSTOMER_ID
V ARCHAR2(255)
A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record NO NO NO NO NO Date and time the system was informed about the event . Date the event transaction was stored into the Event DB. Numerical identifier of the specific campaign Numerical identifier of the launch instance Recipients email address The value depends on the launch condi tions: Live Launch: the Value is the email address fro m the List Proof Launch to a Proof List: the Value is the em ail address from the Proof List Proof Launch to specific email address(es) or Proof Launch personalized against Proof List: Value is the email address specified during the Proof Launch setup
EMAIL_ISP EMAIL_FORMAT
V ARCHAR2(255) CHAR(1) NO
Domain value of the recipients email a ddress (e.g. yahoo.com) Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t
OFFER_SIGNATURE_ID DYNAMIC_CONTENT_
NUMBER NUMBER
Ignore Ignore 19
SIGNATURE_ID MESSAGE_SIZE SEGMENT_INFO NUMBER V ARCHAR2(4 0 0 0 ) Message size in bytes If the message was sent with multiple segments, this infor mation is not usable. It is, ho wever, usable for single segment sends (PR:Value). A d di tional data for you to understand ho w to best follo w up wi th com plaints, b ounces, skips and changed contact data Possible values depend upon the subject Channel for the given event: Email Channel: Recipients email address (from the List) Mobile Channel: Recipients mobile numbe r (fro m the List)
CONTACT_INFO
V ARCHAR2(10 0 0 )
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO NO NO
Date and time the system was informed about the event . Date the event transaction was stored into the Event DB. Numerical identifier of the specific campaign Numerical identifier of the launch instance Recipients email address The value depends on the launch condi tions: Live Launch: the Value is the email address fro m the List Proof Launch to a Proof List: the Value is the email address from the Proof List Proof Launch to specific email address(es) or Proof Launch personalized against Proof List: Value is the email address specified during the Proof Launch setup
EMAIL_ISP EMAIL_FORMAT
V ARCHAR2(255) CHAR(1) NO
Domain value of the recipients email address (e.g. yahoo.com) Recipients preferred email conten t format, HTML or 20
Text. = HTML = Text = No Preferred = Multi-par t OFFER_SIGNATURE_ID NUMBER N/A N/A Message size in bytes See Sent. A d di tional data for you to understand ho w to best follo w up wi th com plaints, b ounces, skips and changed contact data Possible values depend upon the subject Channel for the given event: Email Channel: Recipients email address (from the List) Mobile Channel: Recipients mobile number (fro m th e List) REASON V ARCHAR2(5 0 0 ) Reason for skipping the message
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Form
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO
Date and time the system was informed about the event Date the event transaction was stored into the Event DB Numerical identifier of the specific campaign Numerical identifier of the launch instance Numerical identifier of the Form
NO
21
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Form
NO NO
Date and time the system was informed about the event Date the event transaction was stored into the Event DB Numerical identifier of the Form
NO
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO NO NO NO
Date and time the system was informed about the event Date the event transaction was stored into the Event DB Numerical identifier of the specific campaign Numerical identifier of the launch instance Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t
SOURCE
CHAR(10 0 )
A p plication / mo dule that initiates the event Expor ted value is Source Value found in the Source Identification Values table.
REASON
V ARCHAR2(5 0 0 )
Method used to add the recipient to the List (does not include bulk loads). 22
DV:MERGE (Data Vie wer edi t / merge ) FR:MERGE (Update / insert via a Form as a result of a for m submission) PR:MERGE WS:MERGE EMAIL V ARCHAR2(255) NO Recipients email address
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Campaign
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that match es a customer ID or unique identifier in your system of record
NO NO
Date and time the system was informed about the event Date the event transaction was stored into the Event DB Numerical identifier of the specific campaign
NO NO
Numerical identifier of the launch instance Recipients preferred email conten t format, HTML or Text. = HTML = Text = No Preferred = Multi-par t
SOURCE
CHAR(10 0 )
A p plication / mo dule that initiates the event Expor ted value is Source Value found in the table of the Source Identification Values for more information.
REASON
V ARCHAR2(5 0 0 )
Method used t o add the recipient to the List (does not include bulk loads) SP: Spam Complaint SP: Spam Complaint Transfer Unsubscribe Page US: Unsubscribe
23
US: Unsubscribe Transfer DV: Merge (Data vie wer) FR: Merge (Program) PR: Merge (Form) WS: Merge (W ebservices) EMAIL V ARCHAR2(255) NO Email address that initiated the Op tOu t event The email address of the response event may differ fro m the email address in the List; Recipients of ten for ward messages from one email address to ano ther where the recipient ultimately hand les the message CONTACT_INFO V ARCHAR2(5 0 0 ) A d di tional data for you to understand ho w to best follo w-up wi th com plaints, bounces, skips and changed contact data Possible values depend upon the subject Channel for the given event, provided the RIID value is included in the unsubscribe request. Email Channel: Recipients email address (from the List) Mobile Channel: Recipients mobile number (fro m the List) Default: Email address that initiated the Op tOu t event. (This usually occurs when an unsubscribe request is made via an email reply.)
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Program
NO
Unique ID assigned for this specific List record A unique identifier of the recipient / recor d that matches a customer ID or unique identifier in your system of record
NO NO NO NO NO
Date and time the system was informed about the event Date the event transaction was stored into the Event DB Numerical identifier for the given Program Numerical identifier for the recipients specific entry into the program The Programs name as set by you 24
PROGRAM_VERSION DESCRIPTION
NUMBER V ARCHAR2(10 0 0 )
The version of the Program used by this event The Programs descrip tion as set by you
EVENT_TYPE_ID
NUMBER
NO
Numerical value that denotes the event t ype for the given event transaction See Contact Event Type IDs for more information.
NO
Account number (for example. 1234) Numerical identifier for the List object used by the Program
NO
Date and time the system was informed about the event Date the event transaction was stored into the Event DB
NO NO
Numerical identifier for the given Program The Programs name as set by you The Programs descrip tion as set by you
PROGRAM_DESCRIPTION V ARCHAR2( 4 0 0 0 )
The Responsys File Server suppor ts Secure Copy (SCP) and Secure FTP (SFTP). Access to the file server via these pro t ocols is performed using SSH2 key authentication and your assigned login. In order to access the Resp onsys File Server, You must provide Responsys a public SSH2 key wi th the follo wing at tribu tes:
SSH2 compliant RSA or DSA com patible A t least 1024 bi t strong W e recommend the key pair is generated wi thou t a passphrase
A f ter receiving your public SSH2 key, we associate the key wi th your Responsys File Server account. You maintain possession of the private SSH2 key and ensure the private key is available to your machine(s) that will be remo tely accessing the Responsys File Server t o do wnload the Contact Event Data out pu t files. Resp onsys uses the public SSH2 key to authenticate you when you are trying to access the Responsys File Server account wi th a login we provide. If an individual has SSH2 key information that does not match the public SSH2 key we have on record, the individual is no t granted access to the SCP account. Many SCP and SFTP programs are available for several operating systems. A popular W indo ws pro gram is W inSCP; MacOS X has scp and sft p built -in; several Linux based operating systems are shipped wi th scp and / o r sftp. You can use one of these tools to create SSH2 key pairs:
Unix / Linux: com mand line t o ols such as ssh-keygen W indo ws: Put t yGen
25