Consent Managed Package Details

The Pitcher Consent Managed Package allows you to set up the Pitcher's Consent application base by extending custom fields to other managed packages and defining the application's functionality.

This document describes the contents and configuration of the latest Pitcher’s Consent Managed Package.

Package Components

A Package Component is a fundamental building block of development. Check this Salesforce Package-able Components Documentation for different supported components which can be packaged.

Custom Objects

Pitcher Consent Managed Package installs four custom objects which are listed below.

Consent Log

The Consent Log (PITCM__Consent_Log__c) object is used to store and track the Consent requests and has essential details stored on record for different purposes. Pitcher Consent Managed Package installs 15 custom fields on the Consent log Object as listed below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
Account	`PITCM__Account__c`	Standard Object
Consent Management	`PITCM__Consent_Management__c`	Custom Object
Consent Topic	`PITCM__Consent_Topic__c`	Custom Object
Consent Type	`PITCM__Consent_Type__c`	Picklist	Type of consent like Data Privacy, Data Storage, or GDPR.
Email	`PITCM__Email__c`	Email	Email field to send the email of consent to the customer.
Error Message	`PITCM__Error_Message__c`	Long Text Area(4000)	Error Stack Trace.
Last Reminder Date	`PITCM__Last_Reminder_Date__c`	Date	Last date and time when the reminder email was sent.
Payload	`PITCM__Payload__c`	Long Text Area(4000)	Stores the JSON Payload coming in the request.
Reminders Sent Count	`PITCM__Reminders_Sent_Count__c`	Number(2, 0)	Number of Reminders sent.
Status	`PITCM__Status__c`	Picklist	Indicates the Status of Double Opt-in or Remote: `Email Sent` `Reminder Sent` `Complete` `Expired` `Failure`.
Contact	`PITCM__Contact__c`	Lookup(Contact)
Language	`PITCM__Language__c`	Text(255)	The source language of the Email to be sent to the customer.
Consent Link	`PITCM__Consent_Link__c`	URL(255)	Link for Double Opt-in or Remote Consent sent to customer.
Account Name	`PITCM__Account_Name__c`	Formula (Text)
Text Short	`PITCM__Text_Short__c`	Formula (Text)
Consent Email Template Name	`PITCM__Consent__Email__Template__Name__c`	Text(255)	Name of template sent.
Reminder Consent Email Template Name	`PITCM__Reminder__Consent__Email__Template__Name__c`	Text(255)	Name of Reminder template sent.

Consent Log Item

The Consent Log (PITCM__Consent_Log_Item__c) object is used to store and track the Consent requests wilt multiple request at the same time. Pitcher Consent Managed Package installs 3 custom fields on the Consent log item Object as listed below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
Consent Log	`PITCM__Consent_Log__c`	Custom Object	Consent Log Master-Detail
Consent Management	`PITCM__Consent_Management__c`	Custom Object	Consent Management Lookup
Consent Topic	`PITCM__Consent_Topic__c`	Custom Object	Consent Topic Lookup

Consent Management

The Consent Management (PITCM__Consent_Management__c) object stores the processed consents with the selected channel types and details linked to Consent Topics and Accounts/Contacts. Pitcher Consent Managed Package installs 25 custom fields on Consent Management Object, as listed below. One of these fields is an external ID, which uniquely identifies Consent Management if created through the Pitcher application and keeps track of their sync status.

Fields and Relationship

Field Label	Field Name	Data Type	Description
All	`PITCM__All__c`	Checkbox	Obsolete
Consent Topic	`PITCM__Consent__Topic__c`	Lookup(Consent Topic)	Consent Topic Lookup
Consent Type	`PITCM__Consent__Type__c`	Picklist	Consent Type from Consent Topic
Contact	`PITCM__Contact__c`	Lookup(Contact)	Contact Lookup
Email	`PITCM__Email__c`	Checkbox	Obsolete
Fax	`PITCM__Fax__c`	Checkbox	Obsolete
Mailings	`PITCM__Mailings__c`	Checkbox	Obsolete
None communication	`PITCM__None__communication__c`	Checkbox	Obsolete
Phone	`PITCM__Phone__c`	Checkbox	Obsolete
Revoked Date	`PITCM__Revoked__Date__c`	Date	Date when the Consent was revoked.
Signed Date	`PITCM__Signed__Date__c`	Date/Time	Date when Consent was signed or completed.
Status	`PITCM__Status__c`	Picklist	Status of the Consent: `Ongoing (Draft)` `Completed` `Revoked` `Double Opt-in Pending` `Double Opt-in Expired` `Remote Consent Pending` `Remote Consent Expired`
Text short	`PITCM__Text__short__c`	Text(255)	Short text at the time when the Consent was captured.
Visit	`PITCM__Visit__c`	Checkbox	Obsolete
Email Value	`PITCM__Email__Value__c`	Email	Email value captured inside Consent.
Phone Value	`PITCM__Phone__Value__c`	Phone	Phone value captured inside Consent.
Fax Value	`PITCM__Fax__Value__c`	Phone	Fax value captured inside Consent.
Email Opt Type	`PITCM__Email__Opt__Type__c`	Picklist	Email Opt Type. `Opt-in` `Opt-out`
Fax Opt Type	`PITCM__Fax__Opt__Type__c`	Picklist	Fax Opt Type. `Opt-in` `Opt-out`
Phone Opt Type	`PITCM__Phone__Opt__Type__c`	Picklist	Phone Opt Type. `Opt-in` `Opt-out`
Account	`PITCM__Account__c`	Lookup(Account)	Account Lookup
Mail Opt Type	`PITCM_Mail__Opt__Type__c`	Picklist	Mail Opt Type. `Opt-in` `Opt-out`
Consent Capture	`PITCM__Consent__Capture__c`	Picklist	Consent captured as F2F or Remote.
Language	`PITCM__Language__c`	Picklist	Consent Language selected.
External ID	`PITCM__External__ID__c`	Text(255) (External ID) (Unique Case Insensitive)	External Id for integrations.
Mail Value	`PITCM__Mail__Value__c`	Text(255)	Mailing Address value captured inside Consent.
Visit Opt Type	`PITCM__Visit__Opt__Type__c`	Picklist	Visit Opt Type. `Opt-in` `Opt-out`
Send Email	`PITCM__Send__Email__c`	Email	Indicates the email where the Consent confirmation is sent.

Consent Management Line

The Consent Management Line (PITCM__Consent_Management_Line__c) object stores the consent type information with the user preference and is linked to Consent Topic Line. Pitcher Consent Managed Package installs 25 custom fields on the Consent Management Line Object, as listed below.

Fields and Relationship

Field Label	Field Name	Data Type
Consent Line Text	`PITCM__Consent_Line_Text__c`	Formula (Text)
Consent Management	`PITCM__Consent_Management__c`	Master-Detail(Consent Management)
Consent Topic Line	`PITCM__Consent_Topic_Line__c`	Lookup(Consent Topic Line)
Opt Type	`PITCM__Opt_Type__c`	Picklist
Value	`PITCM__Value__c`	Text(255)

Consent Topic

The consent Topic (PITCM__Consent_Topic__c) object is the main object which stores all consent details per topic and includes consent channels, texts, types, and validity.

Pitcher Consent Managed Package installs 22 custom fields on the Consent Topic Object, as listed below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
All	`PITCM__All__c`	Checkbox	All channels required opt-in , opt-out
Channel Visibility	`PITCM__Channel__Visibility__c`	Picklist (Multi-Select)	Define which channels (Email, Phone, Fax...) will be visible inside the form.
Consent Type	`PITCM__Consent_Type__c`	Picklist	Type of consent like Data Privacy, Data Storage, GDPR.
Double Opt-in	`PITCM__Double__Opt-in__c`	Checkbox	Enable Double Opt-in.
Email	`PITCM__Email__c`	Checkbox	Obsolete
Email Opt Type	`PITCM__Email__Opt__Type__c`	Picklist	Default Email Opt type value.
Fax	`PITCM__Fax__c`	Checkbox	Obsolete
Fax Opt Type	`PITCM__Fax__Opt__Type__c`	Picklist	Default Fax Opt type value.
IsActive	`PITCM__IsActive__c`	Checkbox	Checkbox to setup if Consent Topic is active
Language	`PITCM__Language__c`	Picklist	Default Language.
Mailings	`PITCM__Mail__c`	Checkbox	Obsolete
Mail Opt Type	`PITCM__Mail__Opt__Type__c`	Picklist	Default Mail Opt type value.
None	`PITCM__None__c`	Checkbox	Obsolete
Phone	`PITCM__Phone__c`	Checkbox	Obsolete
Phone Opt Type	`PITCM__Phone__Opt__Type__c`	Picklist	Default Phone Opt type value,
Remote Signature Mandatory	`PITCM__Remote__Signature__Mandatory__c`	Checkbox	Enable Signature during Remote capture.
Sales Org	`PITCM__Sales__Org__c`	Picklist
Send by Email Mandatory	`PITCM__Send__by__Email__Mandatory__c`	Checkbox	Enable Send by Email Mandatory step.
Signature mandatory	`PITCM__Signature__mandatory__c`	Checkbox	Enable Signature during F2F capture.
Template	`PITCM__Template__c`	Text(255)	Template to be used inside Confirmations emails.
Text long	`PITCM__Text__long__c`	Long Text Area(`32768`)	Consent Legal text to be included as part of the consent to be captured and be included inside pdf.
Text long	`PITCM__Text__long_Rich__c`	RechText Area(131072)	Rich Text Area field to support formatted text
Text sort	`PITCM__Text__sort__c`	Text(255)	Consent Legal subject to be included inside pdf and email template.
Topic Email Text	`PITCH__Topic_Email_Text__c`	RechText Area (131072)	Used for email messages by frontend
Valid To	`PITCM__Valid__To__c`	Date	Expire consent to be available by end users.
Visit	`PITCM__Visit__c`	Checkbox	Obsolete
Visit Opt Type	`PITCM__Visit__Opt__Type__c`	Picklist	Default Visit Opt type value.

Consent Topic Line

The Consent Topic Line (PITCM__Consent_Topic_Lines__c) object stores the consent type details and configurations linked to Consent Topics. Pitcher Consent Managed Package installs 25 custom fields on the Consent Topic Line Object, as listed below.

Fields and Relationship

Field Label	Field Name	Data Type
Account Source Field	`PITCM__Account_Source_Field__c`	Text(80)
Consent Topic	`PITCM__Consent_Topic__c`	Master-Detail(Consent Topic)
Contact Source Field	`PITCM__Contact_Source_Field__c`	Text(80)
Default Opt Type	`PITCM__Default_Opt_Type__c`	Picklist
Display Field	`PITCM__Display_Field__c`	Checkbox
Display Order	`PITCM__Display_Order__c`	Number(18, 0)
IsActive	`PITCM__IsActive__c`	Checkbox
Language	`PITCM__Language__c`	Picklist
Mandatory	`PITCM__Mandatory__c`	Checkbox
text long	`PITCM__text_long__c`	Rich Text Area(32768)
Text short	`PITCM__Text_short__c`	Text(255)

Consent Topic Translation

The consent Topic Translation (PITCM__Consent_Topic_Translation__c) object is used for maintaining translated values for text fields (Text short and Text long) per language for Consent Topic records.

Pitcher Consent Managed Package installs four custom fields on the Consent Topic Translation Object, as listed below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
Consent Topic	`PITCM__Consent_Topic__c`	Master-Detail(Consent Topic)	Language Value
Language	`PITCM__Language__c`	Picklist	Long text value for the selected language.
Text long	`PITCM__Text_long__c`	Long Text Area(32768)	Short text value for the selected language.
Text long	`PITCM__Text_long_Rich__c`	Rich Text Area(131072)
Text short	`PITCM__Text_short__c`	Text(255)	Rich Text Area to support rich formats.
Topic Email Text	`PITCH__Topic_Email_Text__c`	RechText Area (131072)	Used for email messages by frontend

Custom Metadata Objects

Pitcher Consent Management Settings metadata gives almost all the functionalities to control the existing classes for the email templates, multi-language, reminder configurations, disabling of email, and many more.

Pitcher Consent Managed Package installs the following custom metadata objects through the permission set mentioned earlier:

Double Opt-In Multi-Lang Email Config
Pitcher Consent Management Settings
Remote Consent Multi-Lang Email Config
Pitcher Consent Org Wide Settings
Dynamic Custom Fields Setting
Custom Labels

Double Opt-In Multi-Lang Email Config

Pitcher Consent Managed Package installs three custom fields on Double Opt-In Multi-Lang Email Config Metadata, as listed below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
Label	`PITCM__Label__c`	Text(40)	Language or Custom label to reflect multi-lang email configurations.
Email Template Name	`PITCM__Email_Template_Name__c`	Text(255)	API name of Email Template.
Reminder Email Template	`PITCM__Reminder_Email_Template__c`	Text(255)	API name of Reminder Email Template.
DEPRECATED Reminder Email Template Name	`PITCM__Reminder_Email_Template_Name__c`	Text(255)	Obsolete

Managed Metadata Records

English-Canada-Cardio
English-TR
English-US
English
French Canadian
French

Pitcher Consent Management Settings

Pitcher Consent Managed Package installs 22 custom fields on Pitcher Consent Management Settings Metadata, as listed below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
Label	`PITCM__Label__c`	Text(40)	System Settings or Custom label to reflect Consent Settings.
Account: Custom Email Field	`PITCM__Account_CustomEmailField_N__c`	Text(255)	Custom Email field on Account to be referred.
Contact: Custom Email Field	`PITCM__Contact_CustomEmailField_N__c`	Text(255)	Custom Email field on Contact to be referred.
Disable Account Selection	`PITCM__Disable_Account_Selection__c`	Checkbox
Disable Consent outside engagement	`PITCM__Disable_Consent_outside_engagement__c`	Checkbox
Double Opt-In: Completed Status	`PITCM__Double_Opt_In_CompletedStatus_N__c`	Text(255)	Specific Status for Double Opt-in Consent Completed.
Double Opt-In: Custom Email Template	`PITCM__Double_Opt_In_CustomEmailTemplate_N__c`	Text(255)	For customized email sent to the user. Refer to the documentation for the syntax of the email template.
Double Opt-In: Pending Status	`PITCM__Double_Opt_In_PendingStatus_N__c`	Text(255)	Specific Status for Double Opt-In Consent Pending
Double Opt-In: Reminder Iteration	`PITCM__Double_Opt_In_ReminderIteration_N__c`	Number(2, 0)	Reminder Iteration count for the number of times reminder needs to be sent
Person Account: Custom Email Field	`PITCM__Person_Account_CustomEmailField_N__c`	Text(255)	Custom Email field on Person Account to be referred
Remote Consent: Completed Status	`PITCM__Remote_Consent_CompletedStatus_N__c`	Text(255)	Specific Status for Remote Consent Completed
Remote Consent: Custom Email Template	`PITCM__Remote_Consent_CustomEmailTemplate_N__c`	Text(255)	For customized email sent to the user. Refer to the documentation for the syntax of the email template.
Remote Consent: Pending Status	`PITCM__Remote_Consent_PendingStatus_N__c`	Text(255)	Specific Status for Remote Consent Pending
Remote Consent: Reminder Iteration	`PITCM__Remote_Consent_ReminderIteration_N__c`	Number(2, 0)	Reminder Iteration count for the number of times reminder needs to be sent
Send Email Reminder In	`PITCM__Send_Email_Reminder_In__c`	Picklist	In how many hours you want to send the reminder email to the user
Remote Consent: Expired Status	`PITCM__Remote_Consent_ExpiredStatus_N__c`	Text(255)	Specific Status for Remote Consent Expired
Double Opt-In: Expired Status	`PITCM__Double_Opt_In_ExpiredStatus_N__c`	Text(255)	Specific Status for Double Opt-in Consent Expired
Remote Consent: Enable Multi Lang Email	`PITCM__Remote_Consent_Enable_MultiLangEmail_N__c`	Checkbox	Enable Multi-language Remote Email Templates
Double Opt-In: Enable Multi Lang Email	`PITCM__Double_Opt_In_Enable_MultiLangEmail_N__c`	Checkbox	Enable Multi-language Double Opt-in Email Templates
Double Opt-In: Custom Reminder Template	`PITCM__Double_Opt_In_CustomReminderTemplate_N__c`	Text(255)	For customized email sent to the user. Refer to the documentation for the syntax of the email template.
Remote Consent: Custom Reminder Template	`PITCM__Remote_Consent_CustomReminderTemplate_N__c`	Text(255)	For customized email sent to the user. Refer to the documentation for the syntax of the email template.
User: Custom Field Remote Consent Name	`PITCM__User_CustomFieldRemoteConsentName_N__c`	Text(255)	Custom Field on User Object for Multi-language Remote Consent Setting Name.
Disable Sending Consent Email	`PITCM__Disable_Sending_Consent_Email__c`	Checkbox	Disable Email Triggers.
Disable Sending Consent Reminder Email	`PITCM__Disable_Sending_Consent_Reminder_Email__c`	Checkbox	Disable Email Triggers.
User: Custom Field Double Opt-In Name	`PITCM__User_CustomFieldDoubleOptInName_N__c`	Text(255)	Custom Field on User Object for Multi-language Double Opt-In Consent Setting Name.
Overview Send by Email	`PITCM__Overview_Send_by_Email__c`	Checkbox	Enable Send Consent Email by Default.
Enable Remote	`PITCM__Enable_Remote__c`	Checkbox	Enable Remote functionality inside Consent UI.
Reminder Email	`PITCM__Reminder_Email__c`	Checkbox	Setup email to be used as Org Wide Email Address.
Send Email Reminder Iteration In	`PITCM__Send_Email_Reminder_Iteration_In__c`	Picklist	In how many hours you want to send the second+n reminders email to the user.
Disable Account Selection	`PITCM__Disable_Account_Selection__c`	Checkbox	Disable Account selection to enable only Contact option.
Disable Consent Consent Outside Engagement	`PITCM__Disable_Consent_outside_engagement__c`	Checkbox	Not possible to collect F2F consent outside an engagement.
Hard Copy Enabled	`PITCM__Hard_Copy_Enabled__c`	Checkbox	Enable hard copy to enable or not that field visible inside the consent.

Managed Metadata Records

Canada
Salesforce
System Setting

Remote Consent Multi-Lang Email Config

Pitcher Consent Managed Package installs 3 custom fields on Remote Consent Multi-Lang Email Config Metadata, as listed in the screenshot below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
Label	`PITCM__Label__c`	Text(40)	Language or Custom label to reflect multi-lang email configurations.
Email Template Name	`PITCM__Email_Template_Name__c`	Text(255)	API name of Email Template.
Reminder Email Template	`PITCM__Reminder_Email_Template__c`	Text(255)	API name of Reminder Email Template.

Managed Metadata Records

English
French-Canada
French
New Zealand

Pitcher Consent Org Wide Settings

Pitcher Consent Managed Package installs 10 custom fields on Pitcher Consent Org Wide Settings Metadata, as listed in the table below.

Fields and Relationship

Field Label	Field Name	Data Type	Description
User: Custom Field for Consent Setting	`PITCM__User_CustomFieldForConsentSetting_N__c`	Text(255)	User Field to enable multiple Consent Metadata settings
Account: Custom Address Field	`PITCM__Account_CustomAddressField_N__c`	Text(255)	Custom Field on Account Object for Address Field.
Account: Custom Email Field	`PITCM__Account_CustomEmailField_N__c`	Text(255)	Custom Field on Account Object for Email Field.
Account: Custom Fax Field	`PITCM__Account_CustomFaxField_N__c`	Text(255)	Custom Field on Account Object for Fax Field.
Account: Custom Phone Field	`PITCM__Account_CustomPhoneField_N__c`	Text(255)	Custom Field on Account Object for Phone Field.
Contact: Custom Address Field	`PITCM__Contact_CustomAddressField_N__c`	Text(255)	Custom Field on Contact Object for Address Field.
Contact: Custom Email Field	`PITCM__Contact_CustomEmailField_N__c`	Text(255)	Custom Field on Contact Object for Email Field.
Contact: Custom Fax Field	`PITCM__Contact_CustomFaxField_N__c`	Text(255)	Custom Field on Contact Object for Fax Field.
Contact: Custom Phone Field	`PITCM__Contact_CustomPhoneField_N__c`	Text(255)	Custom Field on Contact Object for Phone Field.
Enable Debugging?	`PITCM__Enable_Debugging__c`	Checkbox	For enabling custom debug files on Consent Log for each Consent Reminder Batch processing
Reminder Batch: Days Record Old	`PITCM__Reminder_Batch_DaysRecordOld_N__c`	Number(18,0)	Number of days to execute Reminder batch logic from last consent log update. Default 5 days.

Managed Metadata Records

System Setting

Dynamic Custom Fields Setting

Pitcher Consent Managed Package installs ten custom fields on Dynamic Custom Field Setting Metadata, as listed in the table below.

Fields and Relationship

Field Label	Field Name	Data Type
Account Source Field	`PITCM__Account_Source_Field__c`	Text(255)
Active?	`PITCM__isActive__c`	Checkbox
Consent Topic	`PITCM__Consent_Topic__c`	Text(255)
Consent Type?	`PITCM__Consent_Type__c`	Checkbox
Contact Source Field	`PITCM__Contact_Source_Field__c`	Text(255)
Destination Field	`PITCM__Destination_Field__c`	Text(255)
Mandatory	`PITCM__Mandatory__c`	Checkbox
Read/Write	`PITCM__Read_Write__c`	Checkbox
User Specific Value	`PITCM__User_Specific_Value__c`	Text(255)

Custom Labels

Pitcher Consent Managed Package installs seven custom labels listed in the screenshot below. These are used for proper access to Pitcher application usage. Consent - Rep is targeted at all users that work with Pitcher in the field.

EH_MSG_Consent_Management_Missing
EH_MSG_Email_Missing
EH_MSG_Email_Template_Missing
EH_MSG_Invalid_Consent_Topic_Missing
EH_MSG_No_Metadata
EH_MSG_Request_Body_Missing
EH_MSG_Unhandled_Exception

Custom Tabs

Pitcher Consent Managed Package installs three custom tabs available through the permission set mentioned earlier and can be assigned with custom additional permission sets if required.

Consent Logs - This tab appears when you access the Consent Logs app on Salesforce.
Consent Logs Tab
Consent Management - This tab appears when you access the Consent Management app on Salesforce.
Consent Topics - This tab appears when you access the Consent Topics app on Salesforce.

End-users use all these tabs to look into the orders synced from the Pitcher application.

Global Value Sets

Pitcher Consent Managed Package installs 1 Global value set, which is listed below.

Global Value Set Name	Description
Consent_Languages	This value set can be used for selecting various global languages.
Sales_Org	This value set can be used for setting up the availability of Consent Topic records per user by matching active topics by Sales Org value at the User level.

Apex Classes

Pitcher Consent Managed Package installs 8 Apex Classes which are listed on the screenshot below. These are used for proper application functionality on Pitcher platform general application usage.

DAT_ConsentCommonSQQLs
RST_ConsentManagement
RST_ConsentManagement_TST
SCB_ConsentReminder
SCB_ConsentReminder_TST
SYS_ConsentUtility
SYS_Constants
SYS_Utility

Permission Sets

Pitcher Consent Managed Package installs two permission sets listed in the screenshot below. These are used for proper access to Pitcher application usage. Consent - Rep is targeted at all users that work with Pitcher in the field.

Consent-Admin - This permission set is used to set permissions for business administrators for back-end (Salesforce) usage.
Consent-Rep - This permission set is used to set permissions for front-end usage for sales representatives and account managers.

Installation

To learn how to install this package and the post-installation steps, see https://pitcher-ag.atlassian.net/wiki/spaces/APPS/pages/299106336/Consent+-+Post+Installation+Steps.