Versions Compared

Key

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

...

1. Planning Tasks

  • Complete the Identity Implementation Worksheet after meeting with your Aspenware representative to kick off the implementation and send it to your Aspenware representative.

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

2. Infrastructure Tasks

  • Set Up Azure Architecture

    Status
    colourRed
    titleRequired

  • Set Up SSL and DNS for Identity URL

    Status
    colourRed
    titlerequired

  • Set Up Email for Integration

    Status
    colourRed
    titlerequired

  • Add your GTM ID for Google Analytics tracking and configure GTM according to documentation (coming soon)

    Status
    colourBlue
    titleoptional

  • Set Up Twilio for Integration

    Status
    colourBlue
    titleoptional

  • Terms and Conditions configuration

    Status
    colourBlue
    titleoptional

Status
colourYellow
titlePrerequisite

3. Identity Tasks

  • Configure Settings and Language Strings

    Status
    colourRed
    titlerequired

    • Required Identity Settings

    • Email Template Customization Settings

    • Create Account/Claim Account Settings

    • General Messaging and Hard-Coded Error Messages

    • Login Page Language Strings

    • Reset Password Page Language Strings

    • Create Account Page Language Strings

    • Claim Account Language Strings

    • Force Password Reset Language Strings

Status
colourYellow
titlePrerequisite

  • Configure Theming for Identity

    Status
    colourRed
    titleRequired

  • Configure Multiple Store-Fronts and Identity

    Status
    colourBlue
    titleoptional

Status
colourYellow
titlePREREQUISITE

4. Commerce Tasks

  • Install and Enable the Identity Plugin in Aspenware Commerce

    Status
    colourRed
    titlerequired

  • Enable reCAPTCHA for the Identity Plugin (optional)

    Status
    colour

Yellow
  • Blue
    titleoptional

Status
colourGreen
titlePREREQUISTEdetailed setup

Prerequisite Tasks

Insert excerpt
Prerequisites Tasks Excerpt
Prerequisites Tasks Excerpt
nopaneltrue

...

Aspenware also recommends that your resort use a custom domain for the Identity app, such as IIS Windows Server. This will also require Secure Sockets Layer (SSL) setup and DNS entry. If you don’t have Aspenware Commerce, you’ll also want to set up a custom FQDN and SSL for Unity as well, Commerce customers will already have SSL and DNS for Unity configured. The process to set up SSL and DNS for Identity will be very similar to the process to configure SSL for Commerce detailed in this guide: https://hub.aspenware.net/main/How - to - generate - .pfx - file -for-new%2Frenewed-SSL-cert.1429471268.html. for new/renewed SSL cert. Work with your Aspenware representative to upload this and also to set up SSL renewal annual reminders.

...

Although not required, if your resort desires a custom number for Twilio communications, Aspenware can integrate with individual Twilio accounts. For setup, we will need Twilio Account SID, Account API Token, and the From Number. Contact your Aspenware Representative for assistance with this. For assistance setting up the service in Aspenware Commerce, see the https://docs.google.com/document/d/1-La2RXLa1pT5wDPTXHiDZ8INpVKNYWLWML6hz261-l4/edit guide. Setting Up Twilio. You’ll securely share the required API keys and additional fields with your Aspenware Representative.

...

Contact your Aspenare Representative to discuss implementing this feature. Determine the following configuration options:

  1. Should the checkbox be unchecked by default forcing the guest to check the box to receive marketing emails, or should the checkbox be preselected forcing the guest to uncheck the box if they do not want to receive marketing emails.

  2. What do you want the copy to be? By default, it reads “Opt into marketing emails.”

Code Block
{
    "STORE URL GOES HERE(do not include protocol ie: https://)": [
        {
            "id": 1,
            "isConsented": false,
            "isConsentedDefaut": true,
            "showCheckBox": true,
            "showConsentText": true,
            "showConsentLink": false,
            "checkedRequired": false,
            "consentText": "Opt into marketing emails",
            "consentLinkUrl": "empty",
            "consentLinkText": "empty",
            "customApiActions": [
                {
                    "customApiActionTypeId": 3,
                    "apiUrl": "",
                    "apiHeaders": {},
                    "apiPostPayload": {}
                },
                {
                    "customApiActionTypeId": 4,
                    "apiUrl": "",
                    "apiHeaders": {},
                    "apiPostPayload": {}
                }
            ]
        }
    ]
}

...

  • The following settings need to be configured as well, depending on how you want the Terms and Conditions features to behave. Again, please let your Aspenware Representative know your preferences and answers to the following settings so we can properly configure your environment.

    1. Do you wish to display the Loyalty enrollment checkbox?

    2. Will there be a link within the text next to the checkbox?

    3. Is enrolling required to proceed with Create Account and/or Login?

    4. Should the consent checkbox be pre-selected by default or un-checked?

Note

IMPORTANT: These checkboxes should only be enabled if Loyalty is configured for your store. This checkbox will only appear if a customer who is logging in does not already have a loyalty sign-up. By clicking the box and accepting, the guest would enroll in the program. In subsequent logins, the loyalty program enrollment would not appear.

...

Info

NOTE: In a multi-store environment, the following can be customized per storefront.

  1. Background

    1. Background Image

    2. Background Overlay (for text readability)

  2. Logo (long and wide logos work best)

    1. Logo URL

    2. Logo Sizes for Mobile, Tablet, and Desktop

  3. Primary Color (Buttons, Mobile Header Bar)

  4. Button Details

    1. Button Color

    2. Button Radius (rounding)

    3. Button Hover Color

    4. Button Font Weight (Bold, Normal, etc)

    5. Button Font Size

    6. Button Letter Spacing

  5. Font Details

    1. Heading Font Color

    2. Body Font Color

    3. Link Font Color

    4. Link Hover Font Color

    5. A single custom font can be supported for those who use CSS to import their custom fonts. Font customizations will apply to the Identity application, but the email font will be standardized as Helvetica for all customers. Supply the font URL to your Aspenware Representative, similar to the example below:

      Image Modified
Note

IMPORTANT: At this time fonts are not customizable for those who use Javascript to import their custom fonts. When custom fonts are not available, Identity will use Helvetica and Arial if the browser doesn’t support Helvetica.

Also, note that only a single font is supported for Identity, so using different font libraries for headers and body copy is not currently supported.

...

Other limitations include language strings, if two stores are operating out of a single Aspenware Commerce Instance, i.e. they share an admin backend, then they can have unique branding, but the language strings must remain the same across the stores. If two stores use the same Identity but have separate Aspenware Commerce admin instances, they can have unique brands AND language strings. For example, Boyne Mountain and Boyne Highlands, sister resorts in Michigan also use the same Identity as the other Boyne Resorts (http://id.boyneresorts.com), however, these two storefronts share a single Aspenware Commerce Admin, so the Identity language strings for these two store-fronts are shared. In the image below, the items in yellow are shared across the store front’s views of identity, and the items in blue are unique.

...

Commerce Tasks

1. Install and Enable the Identity Plugin in Aspenware Commerce

Note

IMPORTANT: If you plan on using Aspenware Commerce’s Identity plugin, be sure to notify Aspenware that you will need it included as part of your release.

...

  • Find and install the Identity Plugin

    1. In the Aspenware Commerce admin panel go to Configuration > Local Plugins

    2. Search the list for ExternalAuth Methods : Identity Authentication

      Image Modified
    3. Select Install.

    4. Once installation is complete, select Restart application to apply changes at the top of the page.

Info

NOTE: This restart can take up to 7 minutes to complete and should occur during low-traffic times.

  • Configure Identity External Authentication

    1. Go to Configuration > External Authentication

      1. If the Identity plugin has been successfully installed you will see it on the admin screen.
         

        Image Modified
    2. Select Configure.

      1. Enter your OpenID, ClientID, and OpenID ClientSecret (these are created and provided by Aspenware).

        Image Modified
      2. In the Authority to use when connecting to OpenID field enter the web address (URL) that will be using Identity.

      3. Select Save.

    3. Return to the External Authentication Admin page and select Edit.

      1. Select the check box under the Is active column then select Update.

        1. Image Modified

...

2. Enable reCAPTCHA for the Identity Plugin (optional)

The reCAPTCHA v3 API helps resorts detect abusive traffic without user interaction. Instead of showing a CAPTCHA challenge (as with older versions), reCAPTCHA v3 returns a score. Resorts can then choose the most appropriate action for their websites according to this score. Because scores are determined by monitoring user interaction on your site, Aspenware recommends implementing reCAPTCHA as soon as possible (and across all available interactions) to begin site monitoring. In addition to disabling such monitoring at any time, reCAPTCHA v3 thresholds can also be adjusted in the reCAPTCHA admin dashboard to be more or less tolerant of risky activities and related actions. See below for instructions on how to enable reCAPTCHA v3 on Aspenware Identity.

In order to use reCAPTCHA v3 you will need to register your site and get your reCAPTCHA public and private keys.

...

  • Work with your Aspenware Representative (support@aspenware.com) to configure reCAPTCHA for Identity. You will need to provide them with the following THREE configuration elements:

    • 1. Site Key and Secret Key you obtained from Google upon adding reCAPTCHA.

      Image Added
    • 2. The desired locations on which you would like reCAPTCHA v3 to monitor. Options include Create Account, Login, Recover Account, Password Reset and Claim Account. Aspenware recommends resorts enable reCAPTCHA v3 to all locations for the maximum benefit.

    • 3. The ReCaptcha v3 Score Threshold number to begin monitoring your site.

Info

NOTE: reCAPTCHA learns by seeing real traffic on your site. For this reason, scores in a staging environment or soon after implementing may differ from production. As reCAPTCHA v3 doesn't ever interrupt the user flow, you can first run reCAPTCHA without taking action and then decide on thresholds by looking at your traffic in the admin console. The recommended default threshold setting is 0.5. A threshold of 1 will ensure that NO ACTION is ever taken.

In general, the best score a user can get is a 1 and the worst (almost certainly a bot) is a zero. If a user scores below the threshold, the selection made in your admin dashboard will determine the action taken. For more information on assessment scores thresholds visit Google’s reCAPTCHA documentation.

...