Tracking Activity in Consent Capture
Certain countries have regulations which require HCPs to grant consent for activity tracking. If HCPs do not opt into activity tracking, their subsequent activity is tracked anonymously. Vault CRM tracks Approved Email activity, but customers should integrate consent for activity tracking with external systems to track custom channels to ensure all activity is associated with the appropriate CRM accounts.
Who can use this feature?
- Business Admin Users - Browser
- Set up consent for activity tracking
- Track Approved Email activity
- End Users - Browser, iPad, iPhone, Windows (Beta)
- HCPs - Browser, iPad, iPhone, Windows (Beta)
- Grant consent for activity tracking
- Users require an Approved Email license
Configuring Activity Tracking for
Account
- Ensure Configuring Consent Capture is complete.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the permission set for the appropriate user profile.
- Navigate to Objects.
- Grant Edit field permission to the zvod_consent_activity_tracking__v field on the consent_type__v object.
- Navigate to Admin > Configuration > Objects > Consent Type > Layouts.
- Add the zvod_consent_activity_tracking__v field to the consent_type__v layouts for the appropriate object types.
- Ensure Configuring Consent Capture is complete.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the permission set for the appropriate user profile.
- Navigate to Objects.
- Grant Read field permission to the zvod_consent_activity_tracking__v field on the consent_type__v object.
- Grant Edit field permission to the activity_tracking__v field on the multichannel_consent__v object.
Approved Email
- Ensure Configuring Consent Capture is complete.
- Ensure Capturing Consent for Approved Email is configured.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the permission set for the appropriate user profile.
- Navigate to Objects.
- Grant the following field permissions:
Object
Field
Field Permissions
sent_email__v
activity_tracking_mode__v
Read
vexternal_id__v
Edit
- Ensure Configuring Consent Capture is complete.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the permission set for the appropriate user profile.
- Navigate to Objects.
- Grant the following permissions:
Object Object Permission Object Types Fields Field Permission consent_type__v R approved_email__v zvod_consent_activity_tracking__v Read sent_email__v CRE All object types activity_tracking_mode__v Read
- Ensure Configuring Consent Capture is complete.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the permission set for the appropriate user profile.
- Navigate to Objects.
- Grant Edit field permission to the activity_tracking_mode__v field on the sent_email__v object.
Setting Up Consent for Activity Tracking as
- Navigate to Business Admin > Objects > Consent Headers.
- Select the consent_header__v record related to the appropriate consent type.
- Set the consent_header_status__v field to Inactive or Staged to allow edits to the record.
- Select the appropriate consent_type__v record from the Consent Types dropdown section.
- Select Edit.
- Populate the zvod_consent_activity_tracking__v field with consent text for activity tracking. The following HTML tags are supported:
- Paragraph — <p>, can set the dir attribute to rtl to ensure punctuation for right-to-left languages displays correctly
- Line break — <br>
- Bold — <b>
- Italics — <i>
- Underline — <u>
- Ordered and unordered Lists — <ol>, <ul>, and <li>
- Hyperlinks — <a>, must have the target attribute set to _blank
- Select Save.
- Navigate back to the consent_header__v record.
- Set the consent_header_status__v field to Active or Staged:
- Active — displays consent channels and lines on the Consent Capture screen and prevents further editing
- Staged — hides the consent records from end users while allowing consent admins to review how the Consent Capture screen displays
- Select Save.
Granting Consent for Activity Tracking as
When an HCP grants at least one opt-in consent, the zvod_consent_activity_tracking__v checkbox displays in addition to the zvod_consent_default_consent_text__v checkbox on the consent review screen.
Initially, the zvod_consent_activity_tracking__v checkbox is gray and cannot be selected. The HCP can select the zvod_consent_activity_tracking__v checkbox to consent to activity tracking only after selecting the zvod_consent_default_consent_text__v checkbox.
If the HCP selects the zvod_consent_activity_tracking__v checkbox, the value of the consent text is stamped on the activity_tracking__v field on the multichannel_consent__v object, signaling an opt-in for regular email activity tracking. If not, the activity_tracking__v field on the multichannel_consent__v object is blank and their email activity is tracked anonymously.
Tracking Approved Email Activity as
Vault CRM tracks certain email events for Approved Email. Email events related to the delivery of the email are tracked on the sent_email__v record of the email itself, not as user activity. These events include:
- Delivered
- Bounced
- Dropped
- Unsubscribed
- Unsubscribed all
- Preferences modified
- Marked as spam
Email events tracked as user activity include:
- Opened
- Clicked
- Viewed
- Downloaded
See Tracking Approved Email Activity for more information about email events.
The activity_tracking_mode__v picklist field on the sent_email__v record for user activity automatically populates according to the value of the activity_tracking_mode__v field on the multichannel_consent__v record from capturing consent. If the activity_tracking__v field is blank, the activity_tracking_mode__v picklist field is set to Anonymous, enabling anonymous tracking for the email. If the activity_tracking__v field is populated, the activity_tracking_mode__v picklist field is set to Regular and information identifying the account displays on the record.
The following Approved Email entry points always use regular tracking and do not require consent:
- Medical Inquiry
- Receipts
- Double Opt-In
- Case
If the Approved Email Test Email Address setting is populated, Approved Email operates in test mode. In this mode, the account’s latest Multichannel Consent record is not checked, and the activity_tracking_mode__v field on the Sent Email record is not populated. This results in regular activity tracking regardless of the activity tracking consent status on the account.
Tracking Activity for Recommended Emails
When a Recommended Email campaign job runs, the system follows the process below to evaluate the Campaign Target Owner's settings and the individual Campaign Target's consent status to determine the tracking mode.
1. Verify Consent Mode
The system first checks the approved_email_consent_mode__v field on the Approved Email Settings record associated with the Campaign Target Owner’s application profile.
|
Mode |
Configuration |
Behavior |
|---|---|---|
|
Classic Mode |
approved_email_consent_mode__v = 0 |
Tracking is enabled for all Campaign Targets. |
|
Consent Capture Mode |
approved_email_consent_mode__v = 1 |
Logic proceeds to check the Consent Type (see Step 2 below). |
2. Check Consent Type Configuration
If Consent Capture Mode is enabled, the system identifies the Approved Email Consent Type (object_type__v equals approved_email__v) and checks the zvod_consent_activity_tracking__v field:
- If Blank - Activity tracking consent is not configured. Email activity is tracked for all targets. The activity_tracking_mode__v field on the sent_email__v object is not stamped.
- If Populated - Activity tracking consent is configured. The system then evaluates each individual Campaign Target's consent to determine the activity tracking mode. (See Step 3 below.)
3. Determining Activity Tracking Mode
When zvod_consent_activity_tracking__v is populated, the system looks at the latest Approved Email Multichannel Consent (multichannel_consent__v) opt-in record for each Campaign Target to determine the value for the activity_tracking_mode__v field on the sent_email__v object:
|
Multichannel Consent Activity Tracking |
Sent Email Activity Tracking Mode |
Behavior |
|---|---|---|
|
Populated |
Regular |
Regular activity tracking is enabled for this target. |
|
Blank |
Anonymous |
Activity is tracked, but data is anonymized. |
If a Campaign Target does not have an active opt-in Multichannel Consent record, behavior depends on their Approved Email Consent:
- Implicit Opt-In - If approved_email_opt_type__v on the account__v object is set to implicit_opt_in__v, the email activity is tracked but activity_tracking_mode__v on the sent_email__v object is not stamped
- Explicit Opt-In - If the Target has not yet opted in and if the Campaign Activity has a Scheduled Send Datetime:
- The Campaign Activity Target Execution record has an Outcome of Fail and no Sent Email record is created
- The log can be downloaded from the Campaign Job History record, and has the following message in the Error column: There are no Consent_Header_vod records applicable for this Account. Please review your Consent Capture setup.

