Configure Relay Message List LWC

Updated on 13 Nov 2024
7 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

This article documents all of the Relay Message List component’s configuration properties. Each instance of the component maintains its own property settings. The component’s properties can be changed at anytime.

To access the Relay Message List properties, edit the page layout.
1. Click the gear icon (1).
2. Select the Edit Page option (2).

rn-sfdc-lwc-edit_page

Locate the existing Relay component within the page layout and click on it. Clicking the Relay component will open its property editor on the right side of the window.
Edit the properties and save.

Component Properties Panel

NOTES
Many of the properties require you to provide a Salesforce field name.
This field name must be a the fully qualified field name of the record whose page you are actively editing. Do not provide the field’s label for these properties.
The field name can use Salesforce dotted notation to access a parent field of the current record. For example, if you are on the Contact record and would like to provide the CCID Field as the ID of the contact’s parent Account record you could provide the value of: Account.ID
When providing a custom field name be sure you include the __c as part of the field name. For example: RelayCCID__c
For the individual Address fields, make sure you have a solid grasp on how Salesforce compound fields are accessed. See the Salesforce Docs: Address Compound Fields

rn-sfdc-lwc-message_list_properties

Property	Description
Relay Client ID	Optional. This field only needs to be populate when your org is setup for multi-client use. The majority of installations are not setup for multi-client use. If you are using the multi-client setup, then provide the Relay Client ID for this component. Each component instance can specific a different Client ID.
Experience Filter	Optional. Provide a list of Relay message labels used to filter the list of messages presented in the components main view. If providing more than one label, separate each with the pipe symbol (`\|`). This property can be used in conjunction with the Experience Filter Field property at which point the two field’s values will be combined together. NOTE A Relay message can have zero or more labels associated to it. If the provide filter value matches any of the message labels it will be add to the visible list. If both experience filter values are left blank then all of the available Relay messages will be displayed.
Experience Filter Field	Optional. Provide the field name whose value contains a list of Relay message labels, each separated with the pipe symbol (‘\|’). Typically this field will be of type formula that dynamically builds the list of label filters based on other values of the current record. For example, you could create a dynamic message filter based on the products/services/membership the user currently has. Thus, ensuring that only the messages that apply to the user are presented to the agent for sending. This property can be used in conjunction with the Experience Filter property at which point the two field’s values will be combined together. NOTE A Relay message can have zero or more labels associated to it. If the provide filter value matches any of the message labels it will be add to the visible list. If both experience filter values are left blank then all of the available Relay messages will be displayed.
Launch With	Select the method which the message will be sent to the user. Valid options are: Onboarding: Use the Relay onboarding method to onboard the user and send the selected message(s). Messaging: Use the Relay messaging method to send the selected message(s) to the user. NOTE: The user must have been previously onboarded. Read Only: The component will be a read only view preventing the agent from sending any messages. However, the agent will still be able to see which messages have previously been sent and viewed by the user. The agent is also able to preview any message content.
Deactivate Previous Connections	IMPORTANT This option is only valid when the Launch With property is set to Onboarding. It will be ignored with any other Launch With value. Determine if previous user’s connections will be removed from the user profile in the Relay system. A connection is a mobile number and TCPA consent value. If this option is enabled then during the onboarding process, all previous connections will be removed from the user’s profile (stored in Relay) and the newly provide information will be added.
Enable Multi Selection	If checked, then the agent is able to select multiple Relay messages to send all at once. You can send a maximum of 10 messages at one time. If un-checked, then the agent can select and send a single Relay message at a time. RECOMMENDATION 👍 When leveraging the ability to send multiple messages at once, Relay strongly encourages you to use in-conjunction with the Top-of-Feed trigger property. CAUTION Do not spam your users with messages as this will often lead to them opting out. The Relay platform has additional global spam protection. So if your agents sends a block of ten messages and then tries to send another block of ten messages, the Relay platform will prevent the subsequent block of messages from being sent until fifteen minutes of no messages being sent for the user has passed.
CCID Field	Required. Provide the field name that contains the value to be used for the Relay CCID.
Consent Field	Required. Provide the field name that contains the TCPA consent value in Relay format.
Mobile Phone Field	Required. Provide the field name that contains the user’s mobile phone number.
First Name Field	Required. Provide the field name that contains the user’s first name.
Last Name Field	Optional. Provide the field name that contains the user’s last name.
Date of Birth Field	Optional. Provide the field name that contains the user’s date of birth. The provided field should have a field data type of Date.
Last 4 SSN	Optional. Provide the field name that contains the last four digits of the user’s social security number. CAUTION Do not provide the user’s full social security number to Relay network.
Secondary Account ID Field	Optional. This property allows you to provide an alternate, secondary, identifier for the user.
Address Street Field	Optional. The street field name for the address. For example, this field is known as MailingStreet on Contact.
Address City Field	Optional. The city field name for the address. For example, this field is known as MailingCity on Contact.
Address State Code Field	Optional. The state field name for the address. For example, this field is known as MailingState on Contact.
Address Postal Code Field	Optional. The postal code field name for the address. For example, this field is known as MailingPostalCode on Contact.
Client Message Tag	Optional. Allows you to provide a field name whose value will be passed through the Relay platform. All Relay messages events, generated from this LWC instance, will contain this value.
Top-of-Feed Trigger	Optional. If this field is populated, then any selected messages will be posted to the user’s Feed without sending an SMS for each message. Then, after posting all the messages to the Feed, this messages will be sent with an SMS containing a link to send the user to the top of their feed. RECOMMENDATION 👍 Relay recommends using this property when the Enable Multi Selection property has been checked. This will restrict the number of SMS messages to one, regardless of how many messages have been selected by the agent.
Enable Debugging	If enabled, the LWC will display the calculated values, based on their property settings above, for the following fields: CCID, First Name, Last Name, Consent, Mobile Phone Number. This can aid in troubleshooting the field names your are providing for this component. NOTE While editing this component’s properties, once you change a property value and tab to the next field the component’s preview display will automatically be updated.

HINT - Verifying Field Values Before Sending
You can verify field values before sending the experience to Relay by leveraging the Relay LWC debugging information when configuring it.
Edit the Relay LWC as described above
Notice several debugging values are automatically displayed
Anytime you change a Relay field configuration and tab to the next field the debug value will automatically be updated
To verify a value for a configuration option that is not visible in the DEBUG section, simply change the Last Name setting to the field you want to verify. Just remember to change it back before saving.

HINT - Locating Message Labels Used for Filtering
The message filter labels are defined in the Relay CXB Message Builder when creating or editing messages. Labels can be added or removed at any time and are automatically reflected in Salesforce the next time the list is refreshed.
The below image show where in the Relay CXB the message filter labels are created. In this example, all messages will be filtered out unless they contain the sfdc label. If you would like display all of the Relay messages targeting the “Go Digital” campaign, update the LWC Experience Filter value to contain “sfdc | go_digital” (without the quotes).

Was this article helpful?

What's Next

Mapping Relay CXB Fields to LWC

Table of contents

Component Properties Panel