Setup Checklist
This section is a comprehensive and high level summary of all tasks and prerequisites required for this feature to function properly. This section is purposed for use after an administrator is familiar with configuring this feature as an “audit” checklist. For detailed set-up instructions, jump down to “Prerequisite Tasks” and “Detailed Setup Guide” and then follow up with this checklist to ensure all steps are completed.
1. POS TASKS | |
---|---|
POS Task 1 REQUIRED | PREREQUISITE |
2. INFRASTRUCTURE TASKS | |
| PREREQUISITE |
3. COMMERCE TASKS | |
Commerce Task 3 - REQUIRED | PREREQUISITE |
Language String, Setting, HTML widget, etc. Task 4 - OPTIONAL | PREREQUISITE |
Configuration Task 5 - REQUIRED | DETAILED SETUP |
Prerequisite Tasks
This section describes all requirements that must be completed before you can begin setting up this feature. Once these tasks are complete continue to the next section.
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.
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.
Settings, Language Strings and/or HTML Widgets for this Application
This feature may require updates to the following settings, language strings and/or HTML Widgets. Learn more about how to update and create Settings, Language Strings, and HTML widgets follow the links to the respective section.
Settings
Email Template Customization
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 resorts 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
Updating Messaging in Identity
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 Configurable 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
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
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
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)
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. |
Detailed Setup Guide
Theming for Identity
When using Identity, your client folder will include a background image and your logo image. Horizontal logo images are recommended when using the Identity application. In addition to language strings (listed above), below are the components that resorts may configure upon implementing Identity. All other UI features default to the application.
NOTE: In a multi-store environment, the following can be customized per storefront.
Background
Background Image
Background Overlay (for text readability)
Logo (long and wide logos work best)
Logo URL
Logo Sizes for Mobile, Tablet and Desktop
Primary Color (Buttons, Mobile Header Bar)
Button Details
Button Color
Button Radius (rounding)
Button Hover Color
Button Font Weight (Bold, Normal, etc)
Button Font Size
Button Letter Spacing
Font Details
Heading Font Color
Body Font Color
Link Font Color
Link Hover Font Color
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:
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 if headers and body copy require different font libraries, this is not supported today.
Multiple store-fronts and Identity
Aspenware Commerce can be configured to have multiple store-fronts operating from a single backend admin instance, where product configuration for the shop is done. Each storefront can have its own look and feel, language strings, custom domain, settings, products, and more. Similarly, Identity can be configured to work with multiple storefronts. A single instance of Identity can also be configured to work with multiple completely separate Aspenware Commerce stores, so that if you are logged in to one store you are logged into others, however, there are some limitations around what can be customized across store-fronts or unique shops for Identity.
If using the same Identity across multiple storefronts and/or stores, the custom URL across the single instance of Identity must remain constant. For example, Boyne Resorts uses a single Identity across all of its 7 resorts, so http://shop.bigskyresort.com redirects to http://id.boyneresorts.com but guests coming to this page from the Big Sky shop or Arrival see a Big Sky branded experience and language strings that correspond to Big Sky.
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.
Checklist
Use this checklist when customizing the Identity theme to ensure all steps are completed.
Task | Optional/Required | Status |
---|---|---|
Send background image, logo and button color(s) to Aspenware representative. | REQUIRED | |
Send email logo, footer content, and URL to link to in email to Aspenware representative. | REQUIRED | |
Send any language customizations to Aspenware representative. | OPTIONAL |
Like this page? Click the like button below. Don't like this page and/or want to give feedback about this page, leave a comment below and Aspenware will address to improve this article.