Table of Contents |
---|
Setup Checklist
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
1. POS TASKS |
---|
RTP |
|One Tasks
|
|
Siriusware Tasks
|
| ||||||||||||
2. |
---|
1Risk TASKS | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Configure waiver(s) in 1Risk -
|
| ||||||||||||||||||||||||||
Copy down your unique 1Risk URL (provided by 1Risk’s Charles Mickley (cmickley@1risk.com)
|
| ||||||||||||||||||||||||||
3. COMMERCE TASKS |
Define Settings -
|
title | Example of Commerce Task |
---|
|
| ||||||||||||
Install the Waivers plugin
|
|
Products need to be created in Aspenware Commerce.
|
|
|
|
| |||
1. Review Considerations Prior to Configuration (See Below)
|
|
|
|
| ||||||||||
2. Configure New 1Risk Waiver in Aspenware Commerce -
|
|
|
| |||||
3. Assign Waivers to Products
|
|
|
|
| |||
4. Configure 1Risk Waiver to be optionally completed from a CTA on order confirmation email.
|
|
|
|
|
| ||||||||||||
5. Enable the 1Risk Email Feature.
|
|
|
Prerequisite Tasks
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
POS Tasks
POS Task that must be completed first
Infrastructure Tasks
Infrastructure Task that must be completed first. Remove section if not required
Commerce Tasks
AW Commerce task that must be completed first
Settings, Language Strings and/or HTML Widgets for this Feature
...
Settings
AW Commerce Settings that must first be completed
Language Strings
AW Commerce Language Strings that must first be completed
HTML Widgets
AW Commerce HTML Widgets that must first be completed
Detailed Setup Guide
Step 1 Header
Step 2 Header
1. Step 1 Header
First bullet should provide navigation instructions i.e. Catalog >Attributes >Product attributes
Sub-bullet for step 1. Every step and click should be detailed so that someone could follow with little prior experience.
Sub-bullet for step a. Include screenshots of the step and use skitch to mark up screenshots. It can be downloaded here: https://www.techspot.com/downloads/5705-skitch.html
Expand | ||
---|---|---|
| ||
Hint: Age Range Types should also be adjusted year over year. If age ranges are calculated based on Trip Start, then they will not need to be updated. Once completed for all required age range types move on to create Age Range. |
Info |
---|
Note: When possible use notes, warnings, and hints within info panel macros. See https://aspenware.atlassian.net/wiki/pages/resumedraft.action?draftId=781156460 for more details on these. |
2. Step 2 Header
First bullet should provide navigation instructions i.e. Catalog >Attributes >Product attributes
Sub-bullet for step 1
Sub-bullet for step a
...
DELETE CONTENT AFTER THIS LINE
go to the Glossary page and add the key terms Excerpt Include that you added for your configuration guide.
To add the feature terms to the Glossary, navigate to the glossary and add a header for your feature using an H2. Select the + and then select …view more. Search for Excerpt Include and in the Page Containing the Excerpt search for “Configuration: [FEATURE]” select to hide panel, preview and add.
How-to Guide of this page can be found here: [Internal] Configuration page Setup Guide
...
1. POS Tasks
RTP|One Tasks
The Authorization Type needs to be set up in RTP|One and you need to copy down the code. It should be set to active, ‘Display Online’ needs to be checked, a comment should be defined, the ‘Age Range’ should be set as ‘18-no maximum age’, the authorization text HTML should be configured, and the override security level should be set to 0.
The Authorization Type needs to be assigned to the product component.
When a waiver is signed in 1Risk using the Aspenware Commerce Checkout flow configuration, it also creates an Authorization Profile in the guest’s Customer Manager Profile for the guest within RTP|One.
When a waiver is signed in 1Risk using the Aspenware Commerce Checkout flow configuration, it also creates a liability in the guest's profile in Customer Manager within RTP|One.
Siriusware Tasks
The Liability Form needs to be set up in Siriusare and you need to copy down the ID. The expiration date should be set and copied down, and the minimum age to accept should be set at 18. Set Liability text and HTML to your preferences.
The Liability Form needs to be linked to the Siriusware item.
When a waiver is signed in 1Risk using the Aspenware Commerce Checkout flow configuration, it also creates a liability in the Guest Activity for the guest within Siriusware.
2. 1Risk Tasks
Configure waiver(s) in 1Risk. You need to copy down the waiver 1RiskID (provided by 1Risk) for each waiver.
Copy down the ‘waiverFormid’ (provided by 1Risk). This will only be used for the optional waiver configuration for more details on this configuration option, see Step 1 in the Detailed Setup Guide section.
Copy down your resort’s 1Risk URL (provided by 1Risk).
When a waiver is signed in 1Risk using either the required Aspenware Commerce Checkout flow configuration or the optional Order Confirmation Link configuration, the 1Risk Waiver is stored in 1Risk.
Note |
---|
IMPORTANT: This setup must be done in 1Risk and the 1Risk waiver ID and 1Risk URL, which will be used in configuration below, are provided by 1Risk. Contact Charles Mickley cmickley@1risk.com to obtain these values. |
3. Commerce Tasks
Products need to be created in Aspenware Commerce. For help setting up products, see detailed instructions on setting up products.
Settings
Before setting up specific waivers, there are several settings that are required to be set properly for 1Risk waiver integration to work. Go to Configuration > Settings. Search for the setting below and define the value according to the table below.
Description | Setting | Value |
---|---|---|
Defines POS that will be integrated to for waiver and updates field titles in the Waiver plugin in Aspenware Commerce to use POS specific terms. | waiversettings.1riskpos | IF Siriusware set to SW IF RTP|One set to RTP |
Enable’s the resort’s 1Risk configured waivers to be retrieved. | waiversettings.1riskurl | Enter the 1Risk URL provided by 1Risk (see step above) |
The secret is used by the app to encrypt the data. Once set, this will not have to be configured again or used to integrate any other platforms. | waiversettings.1risksecret | Set to a “secret” (any value you decide) |
Set date format configured in your 1Risk environment. | waiversettings.1riskdateformat | Set to desired date format. Options include:
|
If using the “optional” 1Risk waiver configuration option, The ‘Requires 1Risk’ Product Classification must be added as a classification if not already set up as a product classification.
To set the ‘1Risk Waiver in Email Confirm’ Product Classification up as a new classification go to Aspenware Commerce>Product Classifications and select Add Classification and define the following fields as follows
Name: 1Risk Waiver in Email Confirm
Description: Assign this classification to core products that will leverage optional 1Risk waiver signing in the confirmation email. Do not assign if product is assigned to 1Risk Waiver in the Waiver plugin.
Select the checkbox for Requires 1Risk.
Click Add.
Detailed Setup Guide
Review Considerations Prior to Configuration
Configure New 1Risk Waiver within Aspenware Commerce
Assign 1Risk Waivers to Products
(Optional) Configure 1Risk Waiver to be completed from a CTA on the order confirmation email
1. Review Considerations Prior to Configuration
Do you need to have a record of the waiver being signed in your POS (RTP|One or Siriusware)? If so, checkout waiver configuration is the best option. Follow steps 2 and 3 below.
If answer to 1 is ‘no,’ are you going to require waiver signature for all online orders with products that are assigned waivers? If so, set up waivers to require waiver completion as part of checkout. Follow steps 2 and 3 below.
If answer to 1 and 2 are ‘no,’ are you planning to offer waiver signature as an optional task for all online orders with products that are assigned waivers? If so, set up waivers to offer waiver completion as a CTA on the order confirmation email. Follow step 4 below.
Note |
---|
IMPORTANT: While 1Risk waivers can be configured either be captured in the checkout flow or as a follow-up task after the order has been completed, there is no option to “skip waiver and sign it later” option in the checkout. Waiver signing for a product is configured to be completed either as a required task during checkout or an optional task after an order is completed. |
2. Configure New 1Risk Waiver within Aspenware Commerce
Go to the Aspenware Commerce > Waivers.
Click Add Waiver to open the Add waiver page.
Fill in the following fields (Optional fields are marked with an asterisk here)
Title: Enter the title of the waiver. This name will be visible to guests at checkout.
POS Code, depending on which POS is selected in the the setting ‘waiversettings.1riskpos,’ one of the following fields will appear:
RTP Authorization Type Code: This is the code fromRTP|One (See prerequisite steps above).
Siriusware Form ID: This is the ID of the Siriusware Liability form (See prerequisite steps above).
Collect CC Info: Do not check - not supported for 1Risk
CC Agreement Required: Do not check - not supported for 1Risk
E-signature required: Do not check, not supported for 1Risk (Signing rules come from 1Risk config)
Enable Agree Checkbox: Do not check, not supported for 1Risk (Signing rules come from 1Risk config)
Enable Wet Signature: Do not check, not supported for 1Risk (Signing rules come from 1Risk config)
Capture Waiver HTML: Do not check, not supported for 1Risk (Capture rules come from 1Risk config)
Display in My Account: Do not check, not supported for 1Risk
Consolidate Releases: Do not check, not supported for 1Risk
Is Resort Charge Waiver: Do not check, not supported for 1Risk.
Validate signature: Do not check, not supported for 1Risk.
Start Effective Date: Enter the date that indicates when the release or waiver is valid. (To test this feature, the date must be earlier than today’s date.)
End Effective Date: Enter the date that indicates when the release or waiver is no longer valid. Typically, this is set to the season end date. (To test this feature, the date must be later than today’s date.)
Link Text: Leave blank, not applicable
Custom Comment:
If RTP|One is your POS, options for custom comments include saving the Authorization Type Code {AuthTypeCode}, Signer Name {Signer}, Signed Date {SignedDate}, Browser Name {BrowserName}, and Brownser Version {BrowserVersion} Any words not in curly brackets will also show in the custom comments field. (See Figures A and B.)
If Siriusware - Leave blank, not applicable
1Risk ID: Define value provided by 1Risk for the 1RiskID of the waiver. (See prerequisite task above)
Text area: Enter “Signed in 1Risk”
Click Save.
Figure | Feature Description | Example (Click to Expand) |
---|---|---|
Figure A | Custom Comment: In RTP|One only, if there are entries in this field, custom comments will be viewable in the guest’s authorization profile as shown. | |
Figure B | Custom Comment: This example shows the tokens entered in the Custom Comment field. |
3. Assign 1Risk Waivers to Products
Go to Aspenware Commerce > Waivers in Administration.
Click Assign Waiver to Products.
Select the waiver(s) that should be applied to each product from the Assigned Waiver drop-down(s). Each product can be assigned up to four waivers. If an add-on product requires a separate waiver, then assign the add-on product the desired waiver.
...
4. (Optional) Configure 1Risk Waiver to be completed from a CTA on the order confirmation email
Products can be set up to send guests a link to complete 1Risk waivers upon order completion within the order confirmation email. A 1Risk waiver link is sent to a guest in their order confirmation email if the guest has a product, or products, in their order that are set up to require waivers.
Go to Plugins > Product Classifications > Add Assignment and select the Category containing the product requiring 1Risk waiver signing from the dropdown.
Select the desired product from the Product dropdown.
If waiver collection is specific to a particular attribute combination and does not apply to the entire product, check the desired product attributes.
In the Classification table, Check the Assign checkbox for ‘1Risk Waiver Option in Email Confirm.’
In the SKU field for Requires 1Risk Waiver classification, enter the 1RiskID from 1Risk (see prerequisite tasks).
In the Value field for Requires 1Risk Waiver classification, enter the waiverFormid, which is the shorter string and is an integer.
...
Click Add.
Assignments for Products to Require 1Risk Waiver can be removed by selecting Delete.
To update text that appears in the confirmation email within the table where guests sign their waivers, go to the Configuration > Languages page in Admin, clickEdit in the English row.
From the Edit Language details - English page, click to open the String Resources section.
The following languages are related to waiver signing in the confirmation table.
Description | String Resource | Current Value | Placement |
Email Confirmation with Waivers | messages.order.waivers.name | Products requiring waivers in your order | Email Confirmation Table Header |
Email Confirmation with Waivers | messages.order.waivers.waiver | Waivers to sign | Email Confirmation Table Header |
Email Confirmation with Waivers | messages.order.1riskwaiver | Sign Waiver | Email Confirmation Table Link to Waiver |
Next, go to Content Management>Message Templates, and click Edit to edit the ‘OrderPlaced.CustomerNotification’ email template.
To edit the email HTML, go to Tools>Source Code and adjust the HTML from there in the Source code window. Paste the token '%Order.Waivers%' below into your HTML in the appropriate place.
5. (Optional) Enable 1Risk Email Feature
Warning |
---|
Not supported for Siriusware. |
Configure settings specific to this feature by going to Configuration > Settings > All settings (advanced) and searching for the following settings:
waiversettings.1riskemailapiendpoint is the endpoint that Aspenware calls to retrieve the proper URL from 1Risk that will be delivered in the email template
Click Edit.
Enter the value provided by 1Risk to your resort.
waiversettings.1riskemailapisecret is the special value that gives access to the 1Risk resort waivers.
Click Edit.
Enter the value provided by 1Risk to your resort.
Go to Aspenware Commerce > Waivers.
Find the waiver you would like to add email to and click Edit.
Scroll down to the 1Risk Waivers section and complete the following fields:
Send waiver emails checkbox: Checking this box will enable the email feature.
Minor Age textbox: Enter the age for which the waiver-signer is considered a minor and must be signed by a legal guardian (this should match the minor age set in your 1Risk admin tool). Note that If no age is entered, then all waivers will be considered adult waivers and therefore require emailing if the participant is not the logged-in user.
Click Save.
Customize feature-specific language strings in Configuration > Languages and click English.
Under String Resource, search for the following strings to configure:
Language String | Default Value | Example |
---|---|---|
Aspenware.Waivers.EmailSentText | Email Sent! | |
Aspenware.Waivers.EmailSendButtonText | SEND | |
Aspenware.Waivers.EmailMinorDisplayEmailText | Not {first} {last}'s legal guardian? %Email% this waiver | |
Aspenware.Waivers.EmailMinorSignWaiverText | Are you {first} {last}'s legal guardian? %Sign% this waiver now | |
Aspenware.Waivers.EmailMinorResendEmailText | Didn’t receive the email? Resend the email | |
Aspenware.Waivers.EmailAdultDisplayEmailText | {first} {last} must sign this waiver | |
Aspenware.Waivers.EmailAdultResendEmailText | Didn’t receive the email? Resend the email |