Versions Compared

Key

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

Setup Checklist

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

1. POS TASKS

POS Task 1

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

Infrastructure Task 2 -

Status
colourRed
titleRequired

Expandtitle

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

Status
colour

RedtitleRequired

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
colourRed
titleRequired

Status
colourYellow
titlePrerequisite

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

Status
colourBlue
titleoptional

Expandtitle

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

Status
colour

Bluetitleoptional

Status
colourYellow
titlePrerequisite

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

Status
colourRed
titleRequired

Code is entered

Configuration Task 5 -

Status
colourRed
titleRequired

Expand
titleExample of Configuration Task

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

Status
colourGreen
titleDetailed Setup

Prerequisite Tasks

Insert excerpt
AE:Prerequisites Tasks Excerpt
AE: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 firstRenewal-specific product headers must be set up in RTP|One.

Note

IMPORTANT: Renewal product headers must be distinct from standard non-renewal product headers. So if offering a season pass as a renewal and regular pass product, then create both an ‘Adult Season Pass’ product header for non-renewers and a ‘Renewal Adult Season Pass’ product header.

  • Linked Product Component Codes must be set up in RTP|One, linking the previous year’s access component to the current or upcoming year’s linked Product Headers.

Info

NOTE: To adjust shop’s display order for renewal products: Display order is determined by the display order of product headers associated to the product component in product component link setup in RTP.

...

Commerce Tasks

Info

NOTE: Renewal products in Aspenware cannot have an attribute combination table defined and can only have a single SKU for the Aspenware product. Setup separate Aspenware products for Renewal Adult Season Pass, Renewal Teen Season Pass, and so on.

Settings, Language Strings and/or HTML Widgets for this Feature

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

  • 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: /wiki/spaces/DB/pages/1040089511

...

  • Confirm that the following product classification(s) are created.

    1. The ‘Is Renewal Product’ Product Classification must be added as a classification if not already set up as a product classification.

      1. To set the ‘Is Renewal Product’ Product Classification up as a new classification go to Aspenware Commerce>Product Classifications and select Add Classification and define the following fields as follows

        1. Name: Is Renewal Product

        2. Description: Assign this classification to renewal products.

        3. Select the checkbox for Is Renewal

      2. Click Add.

    2. The ‘Renewal Lock’ Product Classification must be added as a classification if not already set up as a product classification.

      1. To set the ‘Is Renewal Lock’ Product Classification up as a new classification go to Aspenware Commerce>Product Classifications and select Add Classification and define the following fields as follows

        1. Name: Renewal Lock

        2. Description: Assign this classification to renewal products.

        3. Select the checkbox for Renewal Lock

      2. Click Add.

Language Strings

  1. Go to Configuration > Languages > English > String Resources, whereyou can set specific language strings that apply to the renewal page. Use the following language strings to edit what customers see in the following scenarios.

    1. If a customer does not have any eligible products, they will see configurable messaging on the renewals or linked product page. 

    2. If they are not logged in, they will not see any products and will be shown configurable messaging on the page. 

Resource name

Value

products.renewal.description

Some of your group members are eligible for product renewal

products.renewal.norenewalproducts

You have no products available to renew.

products.renewal.norenewalproducts.title

No Renewal Products

products.renewal.noteligible

It appears that {0} is not eligible for renewal products.

products.renewal.title

Renewal Products

HTML Widgets

  • An HTML widget can be enabled that displays below the category bar and shows configurable messaging that links to the renewal or linked products page for logged in customers and to the login page for users who are not signed in. From Nop Templates > Plugins > HTML Widgets > Manage HTML Widgets, select to edit, or create a new widget for, ‘Renewal Homepage Banner’ widget. From Tools > source code, you can paste in or edit the HTML. The HTML that is configurable is in blue below.

Html widget name

Html content

Widget zone

Renewal Homepage Banner

Code Block
<div class="renewal-banner" vcloak=""> <h2 class="requires-signin">Renew Your Products Now!</h2> <h2 class="requires-signout"><b><a href="/login?ReturnUrl=/linkedproducts">Login</a></b> to Renew Your Passes!</h2> <p class="requires-signin">Visit the <a href="/linkedproducts">renew products</a> page to see your eligible products.</p> </div>

content_before

Detailed Setup Guide

  1. Step 1 Header

  2. Step 2 Header

1. Create Renewal Products

This task assumes that the prerequisite task of configuring the product shell for the Renewal products has been configured according to this Configuration Guide.

  • Go to Catalog > Products and choose to Edit the product.

  • Assign the product to a category that has been set up to be hidden. (Instructions on hiding a category here)

    1. These products are setup as very simple products, so define the SKU and price on the product info tab, unless they are going to be leveraging Aspenware Payment Plan functionality. 

Info

NOTE: IF a product is a renewal product and is going to leverage Aspenware Payment Plan functionality, the following setup is recommended because these products cannot have the product defined on the product info tab and must have the SKU and price defined in the attribute combination table.  

  1. Start by creating a new product attribute called Payment Plan from Catalog > Attributes > Product Attributes

  2. Define a single default value called ‘Is Payment Plan’

  3. Go to all settings and add Payment Plan to the comma separated list for the value of this setting: 'catalogsettings.hiddenattributes'

  4. Then go to edit the desired Renewal payment plan product

  5. Add this new Payment Plan Attribute

    1. Ensure it’s required

    2. Should be Radio button type Control Type

    3. Add [Hidden] in Text Prompt field

    4. The Attribute Value 'Is Payment Plan' must be set to be preselected

    5. This ‘Is Payment Plan’ Attribute value must be simple

  6. Setup only one attribute combination row in the combination table with the SKUand deposit price

    1. Go to the attribute combinations tab

    2. Select Generate several combinations button

    3. From the modal only check ‘Is Payment Plan’ and click Generate

    4. Then add the Product header code and deposit price

  • Next from the Product attributes section, renewal products cannot have a core attribute that has more than one option, but can have add on attributes (see below).

  • Add the AssignedTo attribute to this product

    1. On the assigned to attribute, add { "lock": true } [Assigned To]. This will lock down the assigned customer so that guests cannot change these options. Ensure that your control type is “Textbox”

    2. In all other attributes, re-enter the name of the attribute. Text needs to be included in the text prompt fields for all attributes, though this will not show for customers.

  • You can set up add-on products on Renewal products, but they must be control type checkbox and can only use non attributed add on products ( See page 16)

  • Next from the Specification attributes tab, add the IsRenewal specification attribute to the product. Check Show on product page before adding. This specification attribute ensures that people cannot add these products to their cart if they access these products from a page other than the gated renewal page. 

  • Next, from the Aspenware Commerce Plugins>Product Classifications>Add Assignment page in Admin, select the hidden Category and the renewal product requiring assignment from the category and product dropdowns. 

  • In the Classification table, click the Assign checkbox for Renewal product and Renewal lock classifications

    1. Products flagged with these two classifications will only be available on the (store URL)/renewal or (store URL)/linkedproducts pages if the logged-in customer has previously purchased an RTP product that links to this current product via RTP product component links.