Versions Compared

Key

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

This guide will review how to set up the My Account Communication Preferences Tab in Aspenware Commerce. For general release notes, see 2.23 Release Notes

Overview

This guide will explain how to set up the Communication Preferences Tab on the My Account Page.

...

Configuration Guide

Language Strings

https://aspenware.atlassian.net/wiki/spaces/DB/pages/1984856125

Overview

Release 2.23 includes the addition of a Communication Preferences Tab to My Account. On this tab, guests will be able to opt in or out of marketing emails or be redirected to a third party to manage their communication preferences. This new functionality enables resorts to determine what is presented as a default to a first-time My Account user. The guest’s preferences will then be stored in their RTP|One profile and the selection will appear on their My Account Communication Preferences page each time they log in.

...

Configuration Guide

1. Edit Language Strings

  • 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

  • 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-intext. [WHAT IS THE LANGUAGE STRING NAME??]Under language strings you have:
    account.navigation" : in/out text that will take them to their My Account page.

    Image Added
    1. To update this string, search for account.navigation. This configures the “My Account” label - which is “My Account” by default

    .
  • Image Removed

...

    1. (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.

...

To update the language string, go to Configuration > Languages, and click Edit. Update the value to include your desired text and save.

...

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

...

2. Configure Communications Preferences Tab

Features of the Communication Preferences Tab are enabled and configured with the following two steps.

  • 1. Show/Hide Opt Out of Marketing Emails Checkbox

  • 2. Configure Communication Preferences Tab

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

    1. Once the setting is found, click Edit.

    2. Click into the Value field and update it to ‘True’.

      Image Added
    3. Click Update.

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

...

2. Configure Communication Preferences Tab

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

    Image Removed
  • Image Added

    The Hide ‘Communication Preferences’ tab checkbox is unchecked by default (meaning that the Communication Preferences Tab will display by default). 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. If your resort utilizes a third-party for communication preferences management, enter the appropriate URL here. The URL will appear on the Communication Preferences Tab in My Account and the user can simply click on it to update their preferences.

    Image Removed
  • Opt In enabled will show the Opt In checkbox on the My Account page, enabling uses to opt in/out of marketing emails. By default, it is unchecked and it will not appear on the My Account Page. Checking the checkbox will make it appear on the page. [WHERE DOES THIS ACTUALLY APPEAR?? COULDN’T SEE IT IN QA]

  • OptOutEmailCheckboxEnabledThe 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}

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.

...

  • 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

...