Required Fields
  • 13 Nov 2024
  • 2 Minutes to read
  • Dark
    Light

Required Fields

  • Dark
    Light

Article summary

To ensure correct functionality with the Relay package, specific fields within Salesforce must be configured appropriately. This article provides instructions for setting up the required fields and configurations within Salesforce to enable operation of the Relay package.

Minimum Required Fields

The Relay Salesforce package necessitates the inclusion of four essential fields within Salesforce. These fields are crucial for accurate synchronization of data between Salesforce and the Relay Network. The required fields are as follows:

Unique Identifier (CCID)

This field serves as a unique identifier for each user within the Salesforce system. The CCID can be the Salesforce Record ID, a separate internal identifier (excluding account numbers), or an entirely new identifier specifically designated for Relay usage.

IMPORTANT

If you are creating a new field to hold the Relay CCID value and you have more than 200,000 users, you should mark the field as an external id. This will place an index on the custom field to allow for fast lookups.

First Name

The existing 'First Name' field within Salesforce is typically utilized to capture the first name of users. No additional configuration is required for this field.

Mobile Number

The existing 'Mobile Number' field within Salesforce is typically utilized to store the mobile phone numbers of users. This field remains unchanged and does not require additional configuration.

TCPA Consent Value

This field captures the TCPA consent status of users, utilizing specific string values required by Relay. The accepted values are 'Stop', 'Express', or 'Written'. Since these values may not be present in existing fields, a new custom field needs to be created to accommodate this requirement.

Configuring TCPA Consent Value Field

Creating a New Field

If your Salesforce organization does not already have a field to capture TCPA consent values, follow these steps to create a new custom field:

  1. Navigate to Setup > Object Manager.

  2. Select the appropriate object type where you wish to add the TCPA consent field (e.g., Person Account, Contact).

  3. Click on Fields & Relationships and then New Field.

  4. Choose the Picklist data type and proceed with field creation.

  5. Define the picklist values as Stop, Express, and Written to align with Relay's requirements.

  6. Save the new field configuration.

Leveraging Existing TCPA Consent Field

If your Salesforce organization already has a field to capture TCPA consent, but it contains different values from Relay's requirements, consider the following approach:

  1. Create a new custom field specifically designated for Relay TCPA consent values (e.g. RelayConsent__c).

  2. Utilize a formula field to map existing consent values to Relay-specific values (Stop, Express, Written).

  3. Ensure that the formula accurately converts existing values to align with Relay's requirements.

  4. Test the formula thoroughly to validate its functionality.

Conclusion

Configuring the minimum required fields within Salesforce ensures seamless synchronization of data between Salesforce and Relay Network through the Relay Salesforce package. By following the guidelines outlined in this article, you can effectively set up the necessary fields and configurations to optimize the functionality of the Relay Salesforce integration.


Was this article helpful?

ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence