Versions Compared

Old Version 1

changes.mady.by.user Sarah Holst

Saved on

compared with

New Version Current

changes.mady.by.user Sarah Holst

Saved on

Key

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

Setup Checklist

Insert excerpt
AE:Set-up ChecklistAE:
Set-up Checklist
nopaneltrue

1. POS

TASKS POS Task 1

Infrastructure Task 2 -

Status
colourRed
titleRequired

Expand
titleExample of Infrastructure Task
​Confirm that the Azure function app is setup and configured to the desired frequency. -

Tasks

  1. Update/create stored procedures in RTP|One (contact your Aspenware Representative for assistance.)

    Status
    colourRed
    titleRequired

Expand
titleExample of POS Task

Products that need age ranges assigned are created in POS and have age ranges added to POS

Status
colourYellow
titlePrerequisite

2. INFRASTRUCTURE TASKS

    1. Aspenware has created this RTP|One Guide as a starting place for RTP|One customer stored procedure set up: https://aspenware.atlassian.net/wiki/spaces/AE/pages/1347977269/RTP+One+Guide+Validated+Prompt+Setup?moved=true

  2. Obtain RTP|One prompt code(s) for use in Aspenware Commerce configuration.

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

3

2.

COMMERCE TASKS

Commerce Task 3 -

Status
colourRed
titleRequired

Expand
titleExample of Commerce Task
Confirm that the Aspenware Commerce products that will have inventory assigned to them are fully configured with the correct attributes -

Commerce Tasks

Ensure that the products to which you are assigning validated prompt(s) are set up in Aspenware Commerce.

Status
colourRed
titleRequired

Status
colourYellow
titlePrerequisite

Language String, Setting, HTML widget, etc. Task 4 -

Status
colourBlue
titleoptional

Expand
titleExample of Setting Task
​Ensure the setting ‘ecommercesettings.productinventory.cachetime’ is set to your desired cache time - StatuscolourBluetitleoptional Statuscolour

  1. Configure Regular (Non-SheerID) Validated Prompts

    Status
    colour

YellowtitlePrerequisiteConfiguration Task 5 - Inventory is mapped to product or product variant in the Inventory Pool plugin

  1. Red
    titleRequired

Expand
titleExample of Configuration Task

  1. Assign Prompt to Product

    Status
    colourRed
    title

Required

Code is entered

Status
colourRed
titleRequired

If using location in RTP, location code is entered

Status
colourRed
titleRequired

If multi day product, number of days is defined

Status
colourRed
titleRequired

If using non default lock time of 900 seconds, the desired lock time is configured. StatuscolourBluetitleoptional

  1. required

Status
colourGreen
titleDetailed Setup

Prerequisite Tasks

Insert excerpt
AE:Prerequisites Tasks ExcerptAE:
Prerequisites Tasks Excerpt
nopaneltrue

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

  1. Step 1 Header

  2. Step 2 Header

1. Step 1 Header

  • First bullet should provide navigation instructions i.e. Catalog >Attributes >Product attributes

    1. Sub-bullet for step 1. Every step and click should be detailed so that someone could follow with little prior experience.

      1. 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
titleExample of content within a section

  • From the Aspenware Commerce Plugins>Age Range page in Admin, click View Add Range Types in the upper right corner.

  • Click Add Age Range Type.

  • Enter a name and description for the age range type.

  • To set the date used to compare the customer’s age to the required age range, select:

    1. Calculate from Trip Start (this age range type is likely already configured), or 

    2. Calculate from Today’s Date (age range based on purchase date), or

    3. Specify the Calculation Start Date; the customer’s age on this date will be used to determine if they are eligible for the product based on the age ranges

  • Click Add.

  • Age Range Types can be edited and inactivated, but they cannot be hard deleted without contacting Aspenware. 

  • Age Range types that are set to Calculate from Trip Start or Today’s Date will never need to be edited, unless you would like to edit the name. Age Range Types that are calculated from a fixed date however, will need to be edited each year to adjust for the current year.

Image Removed

 

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

    1. Sub-bullet for step 1

      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

...

HINT: Email ski-support@aspenware.com for help gathering requirements and creating custom stored procedures in advance of configuring these prompts in Aspenware Commerce. When emailing support, provide answers to the following form of questions:

  • Requirements Summary: Explain the business requirements you are trying to accomplish through this product to the best of your ability 

    • Is this transferrable? Does the customer need to be validated?

    • What are you expecting this prompt to be validating off of?

      • If Voucher… (Consider using Voucher functionality)

        • Provide Template id

        • Provide Type

        • Answer: Does the SKU added to the cart need to match the product header added to the voucher? 

      • If General Program Profile

        • Provide GPP id

        • Provide rules for how customers are assigned GPPs in RTP

      • If the desire is to create a new table of data /codes to validate off of

        • Provide details on the types of codes that will be created and validated off of

        • Provide whether code will be single-time use or unlimited use code. Unless using vouchers, cannot be several-time use code. Can either be 1 time or unlimited valid for a period of time

        • Do you want to allow the same code to be entered more than once in the same transaction, or be limited to 1 entry.

      • Product 

        • Provide a product or component that you expect a customer to have on their profile to validate against.

      • Access Profile

        • Provide an access profile that you expect a customer to have on their profile to validate against.

      • Other?

        • Provide details

  • Product header code: Pre-build the product in RTP and provide the product header code

  • Aspenware Commerce Product Link: Pre-build the product in Aspenware Commerce and provide the product link

  • Obtain RTP|One prompt code(s) for use in Aspenware Commerce configuration.

Commerce Tasks

  • Ensure that the products to which you are assigning validated prompt(s) are set up in Aspenware Commerce

Detailed Setup Guide

Insert excerpt
Detailed Setup Guide Excerpt
Detailed Setup Guide Excerpt
nopaneltrue

  1. Configure Regular (Non-SheerID) Validated Prompts

  2. Assign Prompt to Product

1. Configure Regular (Non-SheerID) Validated Prompts

  • Go to Aspenware Commerce > Product Prompts in Admin.

  • Select Add Product Prompt and enter the following details:

    1. Text: Prompt text (what you want to be visible to customers.)

    2. Code: RTP|One prompt code.

    3. Prompt type: Select ‘String’

    4. Validate On Checkout Assignment: Check if the prompt in RTP|One is set up to check valid customer assignments. Do not check if the guest should enter a code. 

    5. Is Validation prompt: Check

    6. Is Required: Check

    7. Prevent Duplicates: This disables the ability to use the same prompt value again within the same transaction.  Recommended for single-use vouchers.  

  • Click Add.

...

2. Assign Prompt to Product

  • Return to the Product Prompts page.

  • Click View Assigned Product Prompts.

  • Click Add Product Prompt Assignment.

  • Choose the desired product from the list of products.

  • From the Product Attribute drop-down, select All if the same validation prompt applies to the entire product, or if a validation prompt should only be assigned to one attribute selection, select the attribute to assign the prompt to. 

  • Select the Product Prompt you just created in the previous section.

  • Click Add.

...