Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Setup Checklist

Insert excerpt
AE:Set-up ChecklistAE:
Set-up Checklist
nopaneltrue

COMMERCE TASKS

Language String, Setting, HTML widget, etc. Task 4 -
  1. Choose which presentation you would like for your guests' Communication Preferences with regard to marketing communications.

Status
colourBlueYellow
titleoptional

Configure Settings

PRErequisite

2. Show/Hide Opt Out of Marketing

Emails Checkbox
  • Configure Communication Preferences Tab

  • Email Checkbox

    Status
    colourRed
    titlerequired

    Status
    colourYellow
    titleprerequisite

    3. Configure Language Strings for Communication Preferences

    1.

    Status
    colourBlue
    titleoptional

    • Edit account.navigation

    • 2.

      Edit account.

      communicationpreferences

      fields.

      description

      optoutemailcheckbox

      3.
    • Edit account.

      fields

      communicationpreferences.

      optoutemailcheckbox

      description

    Status
    colourYellow
    titleprerequisite

    1. Enable and Configure Communication Preferences Tab

      Status
      colourRed
      titlerequired

    2. Configure 3rd Party Communication Preferences Widget

      Status
      colourBlue
      titleoptional

    Status
    colourGreen
    titlePrerequisitedetailed setup

    Prerequisite Tasks

    Insert excerpt
    AE:Prerequisites Tasks ExcerptAE:
    Prerequisites Tasks Excerpt
    nopaneltrue

    Settings, Language Strings and/or HTML Widgets for this Feature

    ...

    Settings

    1. Show/Hide Opt Out of Marketing Emails Checkbox

    ...

    1. Choose Communication Preferences Presentation

    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

    ...

    Info

    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

    customersettings.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 customersettings.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 Marketing Emails checkbox on the Communications Preferences Tab, go to Configuration > Settings > All Settings and type customersettings.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.

    ...

    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

    Image Added

    My Account

    account.fields.optoutemailcheckbox

    Image Added

    Opt out of our marketing emails.

    account.communicationpreferences.description

    Image Added

    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.

    ...

    Note

    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

    1. Select English and click Edit.

      Image Added
    2. Search for the string resource you wish to update and click Search.

      Image Added
    3. Click Edit.

      Image Added
    4. Update the value to include your desired text and Save.

      Image Added

    Detailed Setup Guide

    1. Enable and Configure the Communication Preferences Tab

    There are several configurable text components to 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:

    ...

    • The 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.

    • The 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 in to 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}

    Note

    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.

    ...

    Language Strings

    • To update a language string, go to Configuration > Languages

      1. Select English and click Edit.

        Image Removed
      2. Search for the string resource you wish to update and click Search.

        Image Removed
      3. Click Edit.

        Image Removed
      4. Update the value to include your desired text and Save.

        Image Removed

    • 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.

      Image Removed
      1. 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.

    ...

    ...

    • Opt In Flow Enabled - Clicking the Opt In Flow Enabled checkbox on the Additional Customer Settings section will change the default status so that when a first-time guest is presented with the Opt-Out of Marketing Emails checkbox in My Account, it is checked. This means that the customer will not have to check the box to opt out of marketing emails, but simply click Save to initiate opting out. If a guest is already opted out of marketing emails, this will be unchecked. See the table below for an explanation of scenarios and corresponding settings.

    Info

    NOTE: There is currently a known issue with the Opt In Flow Enabled checkbox in the Additional Customer Settings section. Checking the checkbox will reset the OutOutEmailCheckboxEnabled setting in All Settings to FALSE, thereby removing the Opt Out of Marketing Emails checkbox from the Communication Preferences tab. So, currently, you can only have this checkbox appear and be defaulted to checked.

    Note

    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 2.12 Release Notes - Aspenware Identity for more information about Consent Models in Identity.

    ...

    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

    • : 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

    Image Added

    “Opt Out of our marketing emails.”

    Language must indicate option to opt out.

    Image Added

    Checked

    Accepts

    Image Added

    “Check here to receive our marketing emails.”

    Language must indicate option to opt in.

    Image Added
    • 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.

        Image Added
      • 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.

        Image Added
    • Click Save.

    ...