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 | |
|---|---|
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.
Settings and Language Strings
This feature may require updates to the following settings, language strings and/or HTML Widgets. Learn more about how to update and create Settings, Language Strings, and HTML widgets follow the links to the respective section.
Settings
Configuration of the following settings is detailed in the Detailed Setup Guide below.
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 |
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.
This release includes a feature that adds a new language string to the homepage. Previously, the words “My Account” were hard-coded and it was confusing to users who were trying to get to their My Account page. Now that text is configurable and a My Account button has been added to the menu that appears when the guest hovers over the account sign-in/out text that will take them to their My Account page.
To update this string, search for account.navigation. This configures the “My Account” label - which is “My Account” by default (In the image about, it has been updated to read “ACCOUNT/SIGN OUT”.
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 or left blank.
The text for the Opt-out of Marketing Communications checkbox is also configurable through a language string called account.fields.optoutemailcheckbox. This controls the messaging for opting-out of marketing email in both create account and from my account.
IMPORTANT: Edit the account.fields.optoutemailcheckbox language string to reflect with FLOW is enabled. In the example above the OPT OUT flow is enabled. If the OPT IN flow is enabled, the text should read “Opt in to receive our marketing emails.”
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 > Customer Settings and scroll down to Additional Customer Settings. The last three fields are pertinent to the Communications Preferences Tab. Complete them as follows:
The Hide ‘Communication Preferences’ tab 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.
The URL to manage the Communication Preferences 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 in to 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.
.png?version=1&modificationDate=1642107949158&cacheVersion=1&api=v2)
Opt In Flow Enabled - Depending on the decision whether to follow and OPT IN or an OPT OUT flow, check or uncheck this box as appropriate.
Opt In Flow Enabled checkbox | Language String reminder account.fields.optoutemailcheckbox See above. | |
|---|---|---|
OPT IN Flow | Check this box. When a guest creates an account they will be presented with a checked box, opting them IN to receiving emails. To decline or opt out of emails, they would have to uncheck the box. | “Opt Out of our martketing emails.” |
OPT OUT Flow | Leave the box unchecked. When a guest creates an account they will be presented with an unchecked box, meaning that they will not received marketing emailes unless they check the box. | “Opt in to receive our marketing emails.” |
NOTE: Another way of thinking about the Opt In flow is to consider the SQL triggered in account creation. If the opt in flow is enabled, during creation, the guest is assigned a 0 in SQL (Accepts emails). If the opt in flow is enabled and the language string had been edited to “Opt in to our emails.”, upon save of account creation, the setting of 0 is retained (accepts.) If the guest unchecks the box and saves, then the setting in SQL is changed to 1 (declines emails.)
IMPORTANT: Be sure to verify that the settings align for marketing preferences in both the Identity Consent Models and the My Account Settings for Opt In Flow. See the 2.12 Identity Release Notes for more information about Consent Models in Identity.
2. Show/Hide Opt Out of Marketing Emails Checkbox
The OptOutEmailCheckboxEnabled setting controls whether or not the Opt Out of Marketing Emails checkbox is displayed on the Communication Preferences Tab. 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.
Once the setting is changed to ‘True’, the Opt Out of Marketing Emails checkbox appears and is checked by default if the guest does not already have a preference stored in their RTP|One customer profile. The first-time My Account guest is required to uncheck the box to receive marketing emails.
See the following table for an explanation of guest scenarios and corresponding settings.
Desired Scenario for a First-time My Account user | OptOutEmailCheckboxEnabled setting in Configuration > Settings > All Settings | Opt In Enabled Checkbox on Additional Customer Settings in Configuration > Customer Settings |
|---|---|---|
Opt Out of Marketing Emails checkbox does not appear on Communication Preferences Tab | FALSE | N/A |
Opt Out of Marketing Emails checkbox appears on Communication Preferences Tab and is checked by default for customers not already opted out (Customer must uncheck to receive marketing emails) | TRUE | Checked |
Opt Out of Marketing Emails checkbox appears on Communication Preferences Tab and is unchecked by default for customers not already opted out (Customer must check it and save to opt out of marketing emails) | TRUE | Unchecked |
3. 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 Settings > Customer Settings and enter the following:
Display a Communications Preferences widget: Checked
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.
