| Table of Contents |
|---|
Setup Checklist
...
1. INFRASTRUCTURE TASKS
...
| Table of Contents |
|---|
Setup Checklist
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
1. INFRASTRUCTURE TASKS | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| |||||||||||||||||||||||||||||||||||
2. COMMERCE TASKS | ||||||||||||||||||||||||||||||||||||
|
| |||||||||||||||||||||||||||||||||||
3. IDENTITY TASKS | ||||||||||||||||||||||||||||||||||||
|
| |||||||||||||||||||||||||||||||||||
1. Configure Theming for Identity
2. Configure Multiple Store-Fronts and Identity
3. Complete Customization Checklist and Send to Aspenware Representative
|
| optional |
| 2. IDENTITY TASKS | ||||||||||||||||||||||||||||||||
Configure Settings and Language Strings
|
| |||||||||||||||||||||||||||||||||||
1. Configure Theming for Identity
2. Configure Multiple Store-Fronts and Identity
3. Complete Customization Checklist and Send to Aspenware Representative
|
|
Prerequisite Tasks
...
Infrastructure Tasks
Terms and Conditions
Identity can be configured to allow guests to review and execute Terms and Conditions as a part of the account creation or sign-in process. In order to complete this configuration, please collect the following below and then send an email to service@aspenware.com. In the email, request that your Identity server be configured for use with Loyalty. Include all required copy and links, organized by T&C 1, T&C 2, etc. Be sure to include your preference for the default setting (checked or unchecked for each T&C setting.)
Terms & Conditions 1 (T&C 1)- Agreement Copy:
Example: I consent to the Terms of the Rewards Program.
Terms and Conditions 1 - Copy for Link and link for modality
Example: Click here to read terms. (embedded link: www.myrewards.com)
HINT: The following HTML elements are supported in checkbox labels:
<b> <strong> <i> <em> <a> <span> <p>
href and the target attributes on an <a> tag. This means that <a href=”google.com” target=”_blank”>Google</a> will render as a working link.
Additionally, <b>, <strong>, <i>, and <em> can be used to format labels with bold or italics if desired. <p> and <span> can be used to break up the content or force line breaks.
Any tags or attributes not listed above will not render. They will be stripped out of the HTML before the content is rendered to the page. This is to ensure that nobody is inserting <script> tags or other elements that could lead to security risks or broken layouts.
| Info |
|---|
NOTE: Terms and Conditions (T&Cs) will be present on the account creation page, login page, and account capture page in an identical fashion. Only the first (Terms and Conditions-1) will execute an action - enroll the customer in the rewards program. Each additional Terms and Conditions are also customizable but do not trigger any action. Any additional Terms & Conditions would require Agreement Copy as well as Copy for link and link for modality. |
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.
Set Up SSL and DNS
Aspenware also recommends that your resort use a custom domain such as login.yourresort.com. This will also require Secure Sockets Layer (SSL) setup and DNS entry.
(Optional) Set Up Twilio for Integration
Although not required, if your resort desires a custom number for Twilio communications, Aspenware is happy to 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.
...
|
Prerequisite Tasks
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Infrastructure Tasks
Terms and Conditions
Identity can be configured to allow guests to review and execute Terms and Conditions as a part of the account creation or sign-in process. In order to complete this configuration, please collect the following below and then send an email to service@aspenware.com. In the email, request that your Identity server be configured for use with Loyalty. Include all required copy and links, organized by T&C 1, T&C 2, etc. Be sure to include your preference for the default setting (checked or unchecked for each T&C setting.)
Terms & Conditions 1 (T&C 1)- Agreement Copy:
Example: I consent to the Terms of the Rewards Program.
Terms and Conditions 1 - Copy for Link and link for modality
Example: Click here to read terms. (embedded link: www.myrewards.com)
HINT: The following HTML elements are supported in checkbox labels:
<b> <strong> <i> <em> <a> <span> <p>
href and the target attributes on an <a> tag. This means that <a href=”google.com” target=”_blank”>Google</a> will render as a working link.
Additionally, <b>, <strong>, <i>, and <em> can be used to format labels with bold or italics if desired. <p> and <span> can be used to break up the content or force line breaks.
Any tags or attributes not listed above will not render. They will be stripped out of the HTML before the content is rendered to the page. This is to ensure that nobody is inserting <script> tags or other elements that could lead to security risks or broken layouts.
| Info |
|---|
NOTE: Terms and Conditions (T&Cs) will be present on the account creation page, login page, and account capture page in an identical fashion. Only the first (Terms and Conditions-1) will execute an action - enroll the customer in the rewards program. Each additional Terms and Conditions are also customizable but do not trigger any action. Any additional Terms & Conditions would require Agreement Copy as well as Copy for link and link for modality. |
...
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.
Set Up SSL and DNS
Aspenware also recommends that your resort use a custom domain such as login.yourresort.com. This will also require Secure Sockets Layer (SSL) setup and DNS entry.
(Optional) Set Up Twilio for Integration
Although not required, if your resort desires a custom number for Twilio communications, Aspenware is happy to 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.
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. |
To begin using Identity, you must install, configure, and activate the Identity plugin. To do so, follow the steps below:
Find and install the Identity Plugin
In the Aspenware Commerce admin panel go to Configuration > Local Plugins
Search the list for ExternalAuth Methods : Identity Authentication
Select Install.
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
Go to Configuration > External Authentication
If the Identity plugin has been successfully installed you will see it on the admin screen.
Select Configure.
Enter your OpenID, ClientID, and OpenID ClientSecret (these are created and provided by Aspenware).
In the Authority to use when connecting to OpenID field enter the web address (URL) that will be using Identity.
Select Save.
Return to the External Authentication Admin page and select Edit.
Select the check box under the Is active column then select Update.
Identity Tasks
Settings and Language Strings
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.
Required Identity Settings
Setting | Values | Description |
|---|---|---|
| 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. |
| 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. |
| 13 is the default | Age limit for guests to create accounts |
| 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. |
| 750 is the default | Only needed if |
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. |
Email Template Customization Settings
Both Identity password emails and verification code emails have standard email templates for forgot password emails and account verification emails. Email templates can be customized to include the resort's logo, links to the resort website, resort address in the email footer, and the resort name.
...
Setting | Description | Specs |
|---|---|---|
| Web-based URL of logo - this setting determines determines what logo displays in the email | |
| This setting determines what footer text displays in the email | Typically used for address, phone number and/or contact email. |
| This setting determines what resort name displays in the email | (i.e. Peak Resort) |
| This setting determines where the user is taken if they click the logo in the email | (i.e. http://aspenware.com ) |
Language Strings
Most language strings within Identity are configurable. These language strings are updated using a JSON file and will be defined during the implementation process of Identity. Most language strings can retain default values, however, the following language strings are recommended for customization. View a full list of language strings.
Login Page Language Strings
...
Description | String Resource | Current Value | Placement |
Login page | account.login.description | Please sign in or create an account. | Displays beneath page title, is a collapsed and invisible if no text is entered. |
Login page | account.login.loginoptions | Email, Username, or Pass ID | Displays above line where user types in username, email, or pass ID |
Login page | account.login.validation.invalid | Email, Username, or Pass ID is invalid. | Displays beneath username entry field when continue button is selected but no characters entered in username field |
Login page | account.login.validation.callservices | We’ve encountered a problem logging you in. Please contact customer service at ###-###-####. | Displays beneath username entry field when email profile matches up with multiple authIDs |
Login page | account.login.callservices.noemailprofile | We’ve encountered a problem logging you in. Please contact customer service at ###-###-####. Error: Account has no email profile. | Displays beneath username entry field when user has a username that is not an email and has no email profile. |
Reset Password Page Language Strings
...
Description | String Resource | Current Value | Placement |
Login → Reset Password Page | account.forgotpassword.description | To reset your password, please enter your email or username and select continue." | Displays beneath title, if no description is entered area is collapsed. |
Login → Reset Password Page | account.forgotpassword.username | Email or username | Displays beneath description above entry field. |
Login → Reset Password Page | account.forgotpassword.validation.success | Success! An email and link for resetting your password has been sent to this address. | Displays beneath email.username field after password reset email is sent. |
Login → Reset Password Page | account.forgotpassword.validation.invalid | Invalid email address, please try again. | Displays beneath email.username field if invalid entry. |
Create Account Page Language Strings
Description | String Resource | Current Value | Placement |
Create Account page | account.create.createaccount | Create an Account | Top of create account page |
Create Account page | account.create.description | Already have an account? | Displays beneath page title. Text area is collapsed if no text is entered. |
Create Account page | account.create.accountexists.signin | Sign in [URL] | active url after “Already have an account” text |
...
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. |
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. |
Force Password Reset (Only if setting PasswordExpirationEnabled is true) Language Strings
Description | String Resource | Current Value |
Login → Force Reset Password | account.passwordexpired.passwordexpired | Password Expired |
Login → Force Reset Password | account.passwordexpired.description | Your current account password has expired. To reset your password, please enter your email or username and select continue. |
Login → Force Reset Password | account.passwordexpired.username | Email or username |
Login → Force Reset Password | account.passwordexpired.validation.success | Success! An email and link for resetting your password has been sent to this address. |
Login → Force Reset Password | account.passwordexpired.validation.invalid | Invalid email address, please try again. |
...