Versions Compared

Key

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

Setup Checklist

...

Example of POS Task

1. POS TASKS

POS Task 1

Status
colourRed
titleRequired

Expand
title

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

Status
colourYellow
titlePrerequisite

2. INFRASTRUCTURE TASKS

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.

-

Status
colourRed
titleRequired

Status
colourYellow
titlePrerequisite

3. 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 -

Status
colour

Red

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

Expandtitle

Example of Configuration TaskInventory is mapped to product or product variant in the Inventory Pool plugin

Status
colour

Red

Green
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.

Status
colourBlue
titleoptional

Status
colourGreen
titleDetailed Setup

Prerequisite Tasks

...

POS Tasks

  • POS Task that must be completed first

Infrastructure Tasks

  • Infrastructure Task that must be completed first. Remove section if not required

Detailed Setup

Prerequisite Tasks

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

POS Tasks

  • If using Stored Value:

    • Set up stored value product header

    • Obtain existing stored value payment method code

    • Obtain new GL stored value clearing account

    • Do admin for stored value to make payment methods available for use at nop location

  • If store value is not desired, but guests have stored value on their accounts, use the HTML Widget to hide. Add to temporary CSS widget -

stored-value, .stored-value + .or {

display: none !important;

}

  • If using Gift Cards and Vouchers:

    • Set up gift card product header code. 

    • Obtain the existing gift card payment method code

    • Set up new GL gift card clearing account

    • Set up voucher product header code.

    • Obtain existing voucher payment method code

    • Set up new GL voucher clearing account

    • Admin for gift cards to make payment methods available for use at nop location

    • Admin for vouchers to make payment methods available for use at nop location

Infrastructure Tasks

  • If using alternate payments setup GL Export

    • Install Nop4U

    • Create GL export with additional payment clearing accounts along with credit account

Commerce Tasks

  • AW Commerce task that must be completed first

...

  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

...

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

...

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.

...

 

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

Insert excerpt
AE:Like this Page Excerpt
AE:Like this Page Excerpt
nopaneltrue

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

Real Example of this page can be found here: https://aspenware.atlassian.net/wiki/spaces/DB/pages/edit-v2/1037172926

...