Versions Compared

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

Tasks

  • Complete required Activity module configuration

    Status
    colourRed
    title

Required
Expand
titleExample of POS Task

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

  • required

  • Set up any required RTP|One Activity Codes.  

    Status
    colour

YellowInfrastructure Task 2 -
  • Red
    title

Prerequisite

2. INFRASTRUCTURE TASKS

  • required

  • Set up any RTP|One Activity Location Codes.

    Status
    colourRed
    title

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

  • Set up RTP|One Sale Location Lock Type for Activity Availability Lock.

    Status
    colourRed
    title

Required
  • REQUIRED

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

  • Create a Core product and ensure a PHC is added.

    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 -

Status
colourBlue
titleoptional

Status
colourYellow
titlePrerequisite

Configuration Task 5 -

Status
colourRed
titleRequired

Expand
titleExample of Configuration Task

Inventory is mapped to product or product variant in the Inventory Pool plugin

Status
colourRed
titleRequired

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
  • Add the time-based activity attributes to the core product.

    Status
    colourRed
    titleRequired

If using non default lock time of 900 seconds, the desired lock time is configured
  • Add the Activity to map to the corresponding RTP|One Activity and Location codes.

    Status
    colour

Blue
  • Red
    title

optional
  • 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

...

  • Complete required Activity module configuration.

  • Create or configure any RTP|One Activity Codes that will be used. Make note of these codes as they will be needed during the Commerce configuration.

  • Create or configure any RTP|One Activity Location Codes that will be used. Make note of these codes as they will be needed during the Commerce configuration.

  • Create or configure an RTP|One Sale Location Lock Type for Activity Availability Lock for the Aspenware Sales Location.

    Image Added

Commerce Tasks

Detailed Setup Guide

Insert excerpt
Detailed Setup Guide Excerpt
Detailed Setup Guide Excerpt
nopaneltrue

  1. Assign Time-Based Activity Functionality to a Core Product

  2. Assign the Product to an Activity

1. Assign Time-Based Activity Functionality to a Core Product

Time-based activities should only be set up for products that are set up in RTP|One as an activity.

HINT: Time-based activities can be dynamically priced, but in order to dynamically price them, they will need an attribute value combination added to the attribute combination table. Even if it is just one attribute for All Ages that is the only option under an Age attribute, this will work. 

  • From the Edit product details page, scroll to the Product attributes tab. 

  • Add the following product attributes: (If these attributes have not already been added, then add them under Catalog > Attributes > Product Attributes

    1. Add the Start Date attribute. Enter ‘[Date] [Dynamic]’ in the text prompt. This should be set up as a Date Picker

      1. No attribute values should be added

    2. Add the Lock ID attribute. Enter ‘[Lock ID]’ in the text prompt. This should be set up as a Textbox.

      1. No attribute values should be added

    3. Add the Time attribute. Enter ‘[Activity Time]’ in the text prompt. This should be set up as a Textbox

      1. It is also recommended to include ‘[Dynamic]’ in the text prompt as this will populate with available activity times for the selected date.

      2. No attribute values should be added

...

  • In order to allow quantity selection for the activity on the product detail page, scroll back to the Product info tab. 

  • In the Inventory section for the Allowed quantities field, add a comma-separated list of the lowest to highest quantity numbers you wish to sell, for example, 1,2,3,4,5,6,7,8.

HINT: To view and edit the Allowed quantities field, you may need to toggle the product editor page view from Basic to Advanced in the upper left corner of the page.

...

2. Assign the Product to an Activity

  • Go to Aspenware Commerce > Activities and click Add activity and enter the following:

    • Product: Select the product that you want to assign as a time-based activity product. 

    • Code: Enter the RTP|One Activity Code (only 1 activity code is supported.)

    • Location: Enter the RTP|One Activity Location Code (only 1 activity location is supported.)

  • Click Save.

...