Versions Compared

Key

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

...

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

1. POS TASKS

POS Task 1 RTP|One only

title

Status
colourRed
titleRequired

Expand

Example 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

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

​Ensure the setting ‘ecommercesettings.productinventory.cachetime’ is set to your desired cache time - StatuscolourBluetitleoptional

Update the following language strings

Status
colourBlue
title

Example of Setting Task

OPTIONAL

  • products.renewal.description

  • products.renewal.norenewalproducts

  • products.renewal.norenewalproducts.title

  • products.renewal.noteligible

  • products.renewal.title

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

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

...

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

POS Tasks

  • POS Task that must be completed first In order for vouchers from RTP|One to show in my account, they must have a Report defined on the voucher type.

Infrastructure Tasks

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

...

Insert excerpt
AE:Setting, Language String and/or HTML Widgets for this feature
AE:Setting, Language String and/or HTML Widgets for this feature
nopaneltrue

Settings

  • AW Commerce Settings that must first be completed

Language Strings

...

Configuration Step

Setting Name

Value

Print/View Vouchers in My Account

customersettings.hideprintvoucherstab

False = Enable Print/View Vouchers

True = Disable Print/View Vouchers

Language Strings

Configuration Step

String resource (do not change)

Default Value

(can be customized)

Print/View Vouchers in My Account

account.printvouchers

Print Vouchers

Print/View Vouchers in My Account

account.printvouchers.description

Vouchers assigned to members of your can be viewed and  printed below

Print/View Vouchers in My Account

account.printvouchers.terms

Vouchers are non-refundable and non-transferable

Print/View Vouchers in My Account

account.novouchers

There are no vouchers on your account

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

Sub-bullet for step 1

...

  1. Enable Print/View Vouchers from My Account

  2. Add Product Classifications to Renewal Product

1. Enable Print/View Vouchers from My Account

The My Account section of the Peak site includes, for logged in customers, a sidebar that allows access to a Print Vouchers page. When a customer accesses this page, any RTP|One vouchers assigned to the logged-in guest or anyone in their defined RTP|One household will be displayed. 

Each voucher can be viewed and printed. Payment value vouchers include the balance remaining in the print voucher view. Active vouchers are shown initially, and inactive vouchers can be viewed if the Inactive Vouchers section is expanded. The following settings and language strings can be used to enable or disable the functionality and customize the display of Print/View Vouchers.

Info

NOTE: In order for vouchers from RTP|One to show in My Account, they must have a Report defined on the voucher type.

  • Go to Configuration > Settings > All Settings (advanced) and search for the setting customersettings.hideprintvoucherstab in the name field.

    1. Edit the setting, and change the Value to 'False; to enable Print/View Vouchers in My Account. 

    2. Change the Value to ‘True’ to disable Print/View Vouchers in My Account. 

  • Go to Configuration > Languages and select the Edit button next to English. Search for the following language strings, and edit them to customize the values in order to change the defaults. 

String resource (do not change)

Default Value (can be customized)

account.printvouchers

Print Vouchers

account.printvouchers.description

Vouchers assigned to members of your can be viewed and  printed below

account.printvouchers.terms

Vouchers are non-refundable and non-transferable

account.novouchers

There are no vouchers on your account


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

...