Setup Checklist
This section is a comprehensive and high level summary of all tasks and prerequisites required for this feature to function properly. This section is purposed for use after an administrator is familiar with configuring this feature as an “audit” checklist. For detailed set-up instructions, jump down to “Prerequisite Tasks” and “Detailed Setup Guide” and then follow up with this checklist to ensure all steps are completed.
COMMERCE TASKS | |
---|---|
| PREREQUISITE |
2. Show/Hide Opt Out of Marketing Email Checkbox REQUIRED | PREREQUISITE |
3. Configure Language Strings for Communication Preferences OPTIONAL
| PREREQUISITE |
| DETAILED SETUP |
Prerequisite Tasks
This section describes all requirements that must be completed before you can begin setting up this feature. Once these tasks are complete continue to the next section.
1. Choose how you would like to present marketing communications options. an OPT IN or an OPT OUT flow
When the user opens the My Account Communication Preferences tab, a call is made to their RTP|One Communication Profile to see if the “Do Not Email” checkbox is selected or not.
Based on your preference, their My Account Communication Preferences tab can be displayed in one of two ways. Decide which presentation is preferred.
Opt In Flow Not Enabled (default)
Opt In Flow Enabled
NOTE: If you resort is using Identity, opting in/out of marketing preferences can be set as part of the Create Account flow. See Configuration: Identity Settings.
2. Configure Settings
Setting Name | Function | Default |
---|---|---|
OptOutEmailCheckboxEnabled | Shows/hides the opt-out checkbox on the Communication Preferences Tab. If FALSE, the checkbox does not appear on the tab. If TRUE, the checkbox will appear. | FALSE |
The OptOutEmailCheckboxEnabled setting controls whether the checkbox is displayed on the Communication Preferences Tab allowing guests to make changes to their marketing communication preferences. By default, the setting is set to FALSE and the checkbox does not appear on the Communication Preferences Tab.
To include the Opt Out of Martketing Emails checkbox on the Communications Preferences Tab, go to Configuration > Settings > All Settings and type OptOutEmailCheckboxEnabled in the Name field and click Search. This will locate the setting.
Once the setting is found, click Edit.
Click into the Value field and update it to ‘True’.
Click Update.
3. Configure Language Strings
The Communication Preferences Tab has several configurable language strings available. The following instructions explain what text is configurable and how to edit them.
Language String Name | Function | Default |
---|---|---|
account.navigation | My Account | |
account.fields.optoutemailcheckbox | Opt out of our marketing emails. | |
account.communicationpreferences.description | Blank |
account.navigation language string
This language string configures the “My Account” label on the store homepage. The default text is “My Account.” (In the image below, it has been updated to read “ACCOUNT/SIGN OUT”.
account.fields.optoutemailcheckbox language string
The text that accompanies the checkbox is also configurable through a language string called account.fields.optoutemailcheckbox. This controls the messaging for opting in/out of marketing emails in the My Account communication preferences update flow.
IMPORTANT: Edit the account.fields.optoutemailcheckbox language string to reflect whether Opt In Flow is enabled or not (see below).
Opt In Flow Enabled = Designates opting in (e.g. “Check here to receive Marketing Emails.”)
Opt In Flow Not Enabled = Designates opting out (e.g. “Opt Out of Marketing Emails.”)
account.communicationpreferences.description
The text under the Communication Preferences heading on the page is also configurable through a language string called account.communicationpreferences.description. This could be configured to give guests information about communication preferences such as “We typically send emails about 2 times per month” or “Want to receive the latest deals? Make sure you are receiving our emails!”, or it can be left blank.
To update a language string, go to Configuration > Languages
Select English and click Edit.
Search for the string resource you wish to update and click Search.
Click Edit.
Update the value to include your desired text and Save.
Detailed Setup Guide
1. Enable and Configure the Communication Preferences Tab
There are several configurable text components on the Communications Preferences Tab. To configure these components:
Go to Configuration > Settings > Customer Settings and scroll down to Additional Customer Settings. The last three fields are pertinent to the Communications Preferences Tab. Complete them as follows:
Hide ‘Communication Preferences’ tab: This checkbox is unchecked by default (meaning that the Communication Preferences Tab will display by default on the My Account page). Checking this box will keep the Communication Preferences Tab from being visible on the My Account page.
URL to manage the Communication Preferences: This field enables redirection to a third-party site if your resort utilizes a third party to manage guest communication preferences. The logged-in customer’s email will be passed into the third-party site as a parameter when they click “Manage Preferences.”
The body of the URL is provided by the third-party partner, and we append "/?email={email}" to add the functionality of passing the logged-in user’s email address. Example URL: https://www.myresort.com./shop-email-preferences/?email={email}
IMPORTANT: The third party site needs to be expecting the passed email address, so you will need to work with a representative from that third party to configure this step. It won't work if the third party site is not expecting/accepting the data being passed.
Opt In Flow Enabled: This checkbox determines what designation a check in the checkbox will send to the user’s RTP|One Communication Profile. If Opt In Flow is enabled, then a check sends an “accepts emails” designation to RTP|One. If Opt In Flow is disabled, then a check in the box sends a “declines email” designation to RTP|One. Depending on which presentation you preferred above in the Prerequisite Steps, check or uncheck this box as appropriate.
Opt In Flow Enabled checkbox | Checked Box Sends to RTP|One | Language String account.fields.optoutemailcheckbox See above. | Example of UI |
---|---|---|---|
Unchecked | Declines | “Opt Out of our marketing emails.” Language must indicate option to opt out. | |
Checked | Accepts | “Check here to receive our marketing emails.” Language must indicate option to opt in. |
Leave the remaining fields unchecked.
Click Save.
2. Configure 3rd Party Communication Preferences Widget (Optional)
If your resort utilizes a 3rd party to manage guest communication preferences, a widget can be installed to facilitate that link from the Communication Preferences page in My Account. To configure the widget:
Ensure that the Communications Preferences Page has been enabled (see instructions above in Configure Communication Preferences Tab).
Ensure that the Opt Out of Marketing email checkbox has been disabled (see instructions above in the Settings section called Show/Hide Opt Out of Marketing Emails Checkbox).
Go to Configuration > Settings > Customer Settings.
Scroll to the last 4 items in the Additional Customer Settings section and configure them:
Display a Communications Preferences widget: Checked. This will enable a CTA which enables users to get to the third-party site.
Widget CSS URL: Enter the URL for the Widget CSS.
Widet JavaScript (JS) URL: Enter the URL for the widget JavaScript.
Widget HTML code: Enter HTML code for the widget.
Click Save.