Versions Compared

Key

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

Setup Checklist

...

1. INFRASTRUCTURE TASKS

  • Set Up Azure Architecture

    Status
    colourRed
    titleRequired

  • Set Up SSL and DNS

    Status
    colourRed
    titlerequired

  • Set Up Twilio for Integration

    Status
    colourBlue
    titleoptional

Status
colourYellow
titlePrerequisite

2. COMMERCE TASKS

  • Install and Enable the Identity Plugin in Aspenware Commerce

Status
colourYellow
titleprerequisite

3. IDENTITY TASKS

  • Configure Settings and Language Strings

    Status
    colourBlue
    titleoptional

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

  • Configure Theming for Identity

    Status
    colourRed
    titleRequired

2.
  • Configure Multiple Store-Fronts and Identity

    Status
    colourBlue
    titleoptional

3.
  • Complete Customization Checklist and Send to Aspenware Representative

    Status
    colourRed
    titlerequired

Status
colourGreen
titleDetailed Setup

...

  • Set Up Azure Architecture

    Identity requires Azure setup to create the web application and database and encryption keys in the Azure Key Vault. The Identity App Service can exist with the App Service Plan that also hosts Commerce and Arrival App Services. The Identity database stores configuration for the Aspenware Identity application. This database can consistently be set to an s3 service level under normal and increased traffic times. One database is used for both production and test.

    Image RemovedImage Added

     

  • Set Up SSL and DNS

...

  • 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

    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.
         

    2. Select Configure.

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

      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.

Identity Tasks

Settings

...

The following settings are configurable in Identity and must be set at the Identity client level (configurable per external applications). These cannot be controlled through an Admin interface and must be done by the Aspenware Dev Ops team, contact your Aspenware representative to update these settings.

...

Setting

Values

Description

RequireAccountVerification

True/False

If an account is found, if TRUE, guest will be texted or emailed a code to verify that they are allowed to claim the account, if FALSE, the guest will be able to create an authentication profile on a found account with no verification required.

CheckPassMediaForFindUser

True/False

If TRUE, guest can login using their pass media or RFID number. If FALSE, login with pass number is disabled. If set to true, there are language strings that should be setup to reflect that this is allowed for guests as well.

AgeLimit

13 is the default

Age limit for guests to create accounts

PasswordExpiredEnabled

True/False

When set to TRUE this setting will enforce a password reset for all users logging in through identity with an RTP password date change of today (automatically set in Azure) minus the “PasswordChangeDays” set below. If FALSE, guests will never be forced to reset their password.

PasswordChangeDays

750 is the default

Only needed if PasswordExpiredEnabled is True. This setting subtracts the number of days from today’s date to determine how recently users must have changed their password in order not to force a reset. For example, if set to 7, any user who has created their account or reset their password in the past week will not be sent down the password reset flow.

NEED SETTING NAME for Terms and Conditions 1 check box appearing

 

This 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 Boyne Rewards loyalty sign up. By clicking the box and accepting, the guest would enroll in the program. In subsequent logins, T&C 1 would not appear.

NEED SETTING NAME for Terms and Conditions 1 check box default as checked/unchecked

 

This loyalty sign up checkbox can be set to be enabled by default or disabled by default.

NEED SETTING NAME for Terms and Conditions 2 check box appearing

 

Can be used for generic terms and condition agreement. If enabled, this checkbox would appear on every login, and would not record the action taken by the guest.

NEED SETTING NAME for Terms and Conditions 2 check box default as checked/unchecked

 

This Terms and Conditions sign up checkbox can be set to be enabled by default or disabled by default.

...

Claim Account Language Strings

...

Description

String Resource

Current Value

Placement

Claim Account → Select Account page

account.claim.selectaccount

Select Account

Title displays at top page.

Claim Account → Select Account page

account.claim.description

We found two or more accounts that match information you entered. Please select an account to continue.

Description displays beneath title. If no text is entered, this text box will collapse.

Claim Account → Select Account page

account.claim.select

Select Account

Displays beneath description and above selection dropdown.

Description

String Resource

Current Value

Placement

Claim Account → Verify Account page

account.claim.verify

Verify Account

Title displays at top of page.

Claim Account → Verify Account page

account.claim.verify.description

We found a matching account. Please select a delivery method for your verification code.

Description displays beneath title. If no text is entered, this text box will collapse.

Claim Account → Verify Account page

account.claim.select

Select Account

Displays beneath description and above selection dropdown.

Description

String Resource

Current Value

Placement

Claim Account → Verify Code page

account.claim.verifycode.verifycode

Verify Code

Title displays at the top of page.

Claim Account → Verify Code page

account.claim.verifycode.description

Please enter the code that was sent to your account.

Description displays beneath title. If no text is entered, text box collapses.

Claim Account → Verify Code page

account.claim.verifycode.verificationcode

Verification Code

Displays beneath description and above verification code text entry field.

Description

String Resource

Current Value

Placement

Claim Account → Create Login page

account.claim.createlogin

Create Login

Title displays at the top of page

Claim Account → Create Login page

account.claim.createlogin.description

Your account has been verified. Please enter email and establish password to claim your account and login.

Description displays beneath title. If no text is entered, text box collapses.

Claim Account → Create Login page

account.claim.createlogin.email

Email (Username)

Displays beneath description and above email (username) entry field.

Claim Account → Create Login page

account.claim.createlogin.password

Password

Displays beneath email and above password entry field.

Claim Account → Create Login page

account.claim.createlogin.confirmpassword

Confirm Password

Displays beneath password and above confirm password entry field.

Claim Account → Create Login page

account.claim.createlogin.password.strongpassword

Password must contain at least 6 characters, a lower case character, an upper case character, at least one digit, and a non-alphanumeric character.

Displays beneath password entry field.

Claim Account → Create Login page

account.claim.createlogin.password.required

Password required.

Displays in red beneath password entry field if no password is entered.

Claim Account → Create Login page

account.claim.createlogin.confirmpassword.required

Confirm password required.

Displays in red beneath confirm password entry field if no confirm password is entered.

Claim Account → Create Login page

account.claim.createlogin.password.match

Confirm password must match password.

Displays in red beneath confirm password entry field if passwords do not match.

Claim Account → Create Login page

account.setprofile.enterpassword

Please fill in your information below to claim your account.

 

Force Password Reset (Only if setting PasswordExpirationEnabled is true) Language Strings

...