Transactional Data

From EN Salesforce Integration
Jump to: navigation, search

A full overview on transactional data structure is out of scope for this wiki, but below is some information to get you started.

As it is a key part to understanding how to map information to objects in Salesforce, it is recommended that you contact EN support for the latest documentation on the CSV structure and types of transactions (Version 2).

It is also recommended using an ‘Export Group', as this will help isolate the data requires to come over to Salesforce.


Email EN Support to receive the latest 'Transaction Data Export structure overview'


Important Currently Engaging Networks supports two data export formats, 'Version 1' (legacy) and 'Version 2' (recommended). Version 2 must be used so please check in the organisation's account that it is applied.


Overview

Salesforce pulls down the 'transactional data' CSV file and then proceeds to map each row's data to a new Engaging Networks Import Record object.


What is this transactional format?

The CSV file can broadly be divided into three sections, shown schematically below:


Overview of the transaction data file


Common transaction data segments – this section contains data columns that are common to all transaction types, such as supporter ID, time of activity, activity reference name/ID. ( Account Id to Campaign Status )


Campaign data segments – for each data row, the contents of this section will depend on the specific type of activity the row relates to. ( Campaign Data 1 to Campaign Data 30 )


Default supporter segments – contains the account's default supporter record (consitituent) fields


Each transaction is a row of information (which corresponds to a supporter action) and each row has a defining 'type' field. It's this type column, which denotes if and what value the dataX columns gets populated with.

For example, type ETT is the Email to Target campaign type and this is used to write to MPs. This would mean different data would come through than if it was a type FCS, fundraising credit single, for example.



Campaign Types

Type Code Code Meaning Description What to expect Additonal Comments
Advocacy Email: 'ETT' Email to Target A supporter takes part in an action, that fires an email to the target. A row for each target. For example, if they action is targeting 5 contacts - five rows will be created.
Email Subscribe: 'EMS' Email Subscribe A supporter signing up to a list. Note that the most useful part to this is the attaching QCB row(s), which describes which list the support is signing up to.
Advocacy Petition: 'PET' Petition A supporter signing a petition.
Data Capture: 'DCF' Data Capture A supporter filling in a form. This is a general campaign type and could be used for all manner of form needs.
Ecard: 'ECF' E-card A supporter can send an 'ecard' to their friend(s). This can either be stand-alone or often off the back from an 'FIM' transaction. A reference of the supporter who is sending the email. We don't log the friend's emails.
Email-a-Friend: 'TAF' Tell a Friend A supporter can send an email, to a friend, saying they should take action in X campaign. A reference of the supporter who is sending the email. We don't log the friend's emails.
Membership 'MEM' Membership A supporter starting or renewing a membership. Usually associated with an FCS record, to indicate payment method
Broadcast Email: 'EBC' Email Broadcast A supporter interacting with an email, be it through an open, click, form completion, hardbounce, softbounce or feedback (spam complaint) We don't generate a row for 'sent', so these are logs of a supporter doing something off a send.
Question Checkbox: 'QCB' Question checkbox ( Opt Ins ) This is called an 'Opt In' question in EN and it the primary way clients handle the email subscription lists. Campaign Status holds the Y or N value, of the supporter's subscription status to the respective list. "Question" types are always preceeded by an action type, as questions need to be included on page forms.
Question Confirmation "CQS' Question with Email Confirmation checkbox ( Opt Ins ) This is called an 'Opt In with confirmation' question in EN and it another way for clients to handle the email subscription lists. The difference here, if clients use this, is that supporters are required to click on the confirmation link in the email to change the value from P to Y.
Question Multiple Reponse: 'QMR' Standard Questions Clients use 'Questions' as externtions to their forms. Example: They may want to capture 'T-shirt' size for campaign X, but don't want to store it on the supporter's default record. This transaction row encompasses radios, selects, checkboxes, text, textareas etc.. So note which type the campaign is using. For questions that can have multiple answers, their values are written seperately in the Campaign Data columns.
Fundraising - Credit/Debit Single 'FCS' Fundraising Creditcard Single A supporter submitting a single payment Note that success and rejects are included, so be sure to filter on 'success'. Note that no credit card data is stored in EN, so no PAN related data will be seen on the export.
Fundraising - Credit/Debit Recurring 'FCR' Fundraising Creditcard Recurring Either a supporter submitting a gift , which is the start of the recurring series or the subsequent transaction processed by EN. An FCR record is for the first and then every subsequent transaction. Note that ' Campaign Data 11' indicates the parent id. Note that 'Campaign Data 12' indicates the transaction's recurring status: ÔactiveŐ ÔsuspendedŐ ÔcancelledŐ
Fundraising - Credit/Debit Unmanaged Recurring 'FUR' Fundraising Unmanaged Recurring A supporter submitting the first gift, of an unmanaged recurring series. The term 'Unmanaged' here means that Engaging Networks wonŐt/can't process the subsequent payments. This is being down by the gateway or an external source. No further transactions will be seen about this gift.
Fundraising - Bank Single 'FBS' Fundraising Bank Single A supporter submitting a single payment, which is bank related. (ACHF or Direct Debit etc)
Fundraising - Bank Recurring 'FBR' Either a supporter submitting a gift , which is the start of the recurring series or is the subsequent transaction processed by EN.
Fundraising - In Memoriam 'FIM' Fundraising In-Memoriam An 'In memoriam' gift. Note that this gift type will always have a corresponding FCS or FCR transaction. If a support has marked that a gift is an 'In memoriam' donation, then this row holds the data captured on the page. Depending on what the client decides to include/capture on the page, column's 'Campaign Data 8' to 'Campaign Data 30' could be populated with data.
Fundraising - Refund Single/Recurring 'RFD' Refund If a gift has been 'Mark as refunded' or 'Refunded', though the EN admin dashboard. ( Manage Supporters ) For the majority of cases, the actual refund is made in the gateway's dashboard and then 'Marked as Refunded' in EN. Currently Optimal Payments is the only gateway that provides the services for EN to trigger an actual refund.
Fundraising - One-click 'FOC' Fundraising One Click If a gift is processed from a One Click page. The FOC type is just like the FCS record and occurs due to EN already having a gateway profile id, associated with the supporter. This means the supporter does not need to re-enter the credit card details. This has to be enabled on a per page basis, but the same processing rules can be used as FCS
Fundraising - Cash 'FCA' Fundraising Cash ( offline ) If a gift has been registered as an offline 'cash' gift.
Fundraising - Check 'FCH' Fundraising Cheque ( offline ) If a gift has been registered as an offline 'check' gift.
P2P Registration 'PRG' Peer to Peer Registration A supporter signing up to a peer to peer page
P2P Fundraising Credit/Debit Single 'PFS' Peer to Peer Fundrasing (creditcard) Single A supporter submitting to a fundraiser's peer to peer page, as a single gift This is like an FCS, but through the P2P module.
P2P Fundraising Credit/Debit Recurring 'PFR' Peer to Peer Fundrasing (creditcard) Recurring A supporter submitting to a fundraiser's peer to peer page, as a recurring gift This is like an FCR, but through the P2P module.
P2P Fundraising - Cash/Cheque 'PFC' Peer to Peer Fundraising Cash or Cheque ( offline ) If a gift has been registered as an offline gift, through EN's Peer to Peer module. If the fundraiser is logged into their own 'P2P Dashboard', and want to register gifts they have received as cash or check.
Manual Supporter Update: "MSU" Manual Supporter Update If a supporter's record is updated within EN's admin inteface. ( 'Manage Supporters' )
Manual Supporter Create: "MSC" Manual Supporter Create If a supporter is created within EN's admin inteface. ( 'Manage Supporters' )
Amplify Registration: "AMR" Amplify Registration A supporter signing up to an 'amplify' site "amplify" is Peer to Peer, "version 2". It provides a more feature rich module that the over P2P transactions.
Amplify Credit Single: "ACS" Amplify Credit Single A supporter submitting to a fundraiser's amplify page, as a single gift
Amplify Credit Recurring: "ACR" Amplify Credit Recurring A supporter submitting to a fundraiser's amplify page, as a recurring gift