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

RTP|One only

  • Create renewal specific product headers- must be set to ‘Display’

    Status
    colourRed
    titleRequired

  • Set up ‘Product component link’

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

2.

INFRASTRUCTURE TASKSInfrastructure Task 2 Commerce Task 3

Commerce Tasks

Ensure Linked Products Plugin is installed

Status
colourRed
titlerequired

Status
colourYellow
titlePREREQUISITE

Create ‘IsRenewal’ Specification Attribute -

Status
colourRed
titleRequired

Status
colourYellow
titlePrerequisite

3. COMMERCE TASKS

Create Product Shell(s) for all renewal products (note these products cannot have core product attributes added to them)

Status
colourRed
titleRequired

Status
colourYellow
titlePrerequisite

Confirm the following product classifications are added-

Status
colourRed
titleRequired

  • ‘Is Renewal Product’

  • ‘Renewal Lock’

Status
colourYellow
titlePrerequisite

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

Update the following language strings

Status
colourBlue
titleoptional

  • products.renewal.description

  • products.renewal.norenewalproducts

  • products.renewal.norenewalproducts.title

  • products.renewal.noteligible

  • products.renewal.title

Status
colourYellow
titlePrerequisite

The ‘Renewal Homepage Banner’ is configured in HTML widgets

Status
colourRed
titleRequired

Status
colourYellow
titlePrerequisite

1. Create Renewal Product(s)

  • Add renewal product to a hidden category

    Status
    colourRed
    titleRequired

  • Define product header code in SKU field

    Status
    colourRed
    titleRequired

  • Define product Price

    Status
    colourRed
    titleRequired

  • Add ‘AssignedTo’ attribute with ‘{ "lock": true } [Assigned To]’ in the Text Prompt field with Control type set to ‘Textbox.’

    Status
    colourRed
    titleRequired

  • Add any add-on attributes, ensuring they are set to ‘Checkboxes’ Control Type

    Status
    colourBlue
    titleoptional

  • Add the ‘IsRenewal’ Specification Attribute

    Status
    colourRed
    titleRequired

Status
colour

Yellow

Green
title

PrerequisiteConfiguration Task 5 -

Detailed Setup

2. Add Product Classifications to Renewal Product(s)

  • Add the following Product Classifications

    Status
    colourRed
    titleRequired

    1. Requires Assingment

    2. Is Renewal Product

    3. Renewal Lock

Status
colourGreen
titleDetailed Setup

Complete product setup, adding waivers, and other set up.

Status
colourBlue
titleoptional

Status
colourGreen
titleDetailed Setup

Prerequisite Tasks

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

POS Tasks

  • Renewal-specific product headers must be created in RTP|One.

Note

IMPORTANT: Renewal product headers must be set to ‘Display’ in RTP|One in order for them to display in the Aspenware Commerce renewal area. Conversely, to take renewal products offline, they must be

...

unpublished in Aspenware Commerce and also set to not display 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 For example, create both an ‘Adult Season Pass’ product header for non-renewers and a ‘Renewal Adult Season Pass’ product header.

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

    • When creating a ‘Product Component Link' in RTP|One, first select the prior access component code that must be present on a guests' profile to make them eligible for the new renewal.

    • Then choose the linked product header(s) that are “unlocked” based on having the prior access component. These should be distinct renewal product headers.

    • A modal will pop up for each added product header, complete the following information:

      • Display order: will control the order that the product is displayed on the Aspenware Commerce Linked Product page in relation to other eligible renewal products.

      • Link Effective date: Set to yesterday’s date

      • Link Expiration date: Set to when the link is no longer valid

      • Set Eligibility date type: Set based on your preference

      • Eligibility time frame: Set to ‘Fixed Date’ and the defined date should be set to the earliest previous date someone could purchase last years access. i.e. if your passes went on sale 3/1/2020 last season you will want to define the 'fixed date' as 3/1/2020.

Info

NOTE: To adjust The 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|One. Any adjustments to the shop’s display order can be made there.

...

Commerce Tasks

  • Product Shells for Renewal products Ensure that the Linked Products Plugin is installed by going to Admin > Configuration > Local Plugins and search for “Linked Products”. Check that it is installed and, if not, install it. This plugin is required for linked products.

    image-20240729-152747.pngImage Added

  • Create the' IsRenewal' Specification Attribute if it doesn’t already exist.

    • Go to Catalog > Attributes > Specification attributes and click Add New to create a new attribute if it doesn’t already exist.

      • Name it ‘IsRenewal’

      • Add a new option and input 'True' as the name.

    • Save it

  • Product Shells for renewal product(s) should be created according to the configuration guide.

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 featureAE:
Setting, Language String and/or HTML Widgets for this feature
nopaneltrue

...

  • 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
      1. ‘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

...

  1. to 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

...

Step 1 Header

...

Insert excerpt
Detailed Setup Guide Excerpt
Detailed Setup Guide Excerpt
nopaneltrue

  1. Create Renewal Products

  2. Add Product Classifications to Renewal Product

1. Create Renewal Products

This task assumes that the prerequisite task of configuring the product shell for the Renewal 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
    1. set up as very simple products, so define the SKU and

    price on
    1. Price in the

    product
    1. Product info

    tab
    1. section, 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.  

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

  • Define a single default value called

‘Is Payment
  • ‘Payment Plan’

  • Go to all settings and add

Payment Plan Setup
  • ‘Payment Plan’ to the comma-separated list for the value of this setting: 'catalogsettings.hiddenattributes'

  • Then go Catalog > Products to edit the desired Renewal payment plan product

  • 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

    • Go to the Attributes section and click Add a new attribute.

      1. From the Attribute drop-down, select ‘Payment Plan’

      2. Enter ‘[Hidden]’ in Text Prompt field

      3. Check Is Required

      4. Set Control Type to 'Radio Button List'

    • Click Save and Continue Edit

    • In the Values section, click Add a new value.

      1. Set Attribute value type to ‘Simple’

      2. Name it 'Payment Plan'

      3. Check Is preselected

      4. Do not set the other options.

    • Save it.

    • Go back to product details and click on the Attribute combinations tab to set up only one attribute combination row in the combination table with the

    SKUand
    • SKU and deposit price.

  • Go to the attribute combinations tab

      1. Select Generate several combinations button.

      2. From the modal only check

    ‘Is Payment
      1. ‘Payment Plan’ and click Generate.

      2. Then add the

    Product
      1. product header code in the SKU field 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. in the Price field.

    • Click Save.

    • Go to the Attributes section and click Add a new attribute to add the AssignedTo attribute. This will lock down the assigned customer so that guests cannot change these options.

      1. From the Attribute drop-down, select ‘AssignedTo’.

      2. Enter ‘{ "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”In all other attributes, re-enter the name of the attribute. Text needs to be included in the text prompt fields for all attributes
      1. ’ in Text Prompt field.

      2. Set Control Type to 'Text'.

    • Click Save and Continue Edit

    • From here, add desired add-on products to the product. A renewal product cannot have a core attribute added to it but can have add on attributes. Follow the configuration guide for simple add-on products to add standard add-ons to the renewal product.

      • Attributes used to associate add-on products to renewal products must use the Control type of ‘CHECKBOXES’. Using the CHECKBOXES control type enables the add-on to be selected or deselected on the PDP during the purchase flow.

        Image Added
    Note

    IMPORTANT: For renewal products, something needs to be typed in the Text prompt field for EVERY attribute, 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. Next, open the Specification attributes section and select Add attribute to add the ‘IsRenewal’ specification attribute. This will ensure that if someone does somehow locate the standard PDP for this renewal product they will not able to add it to the cart, and this product can only be added to the cart through the gated renewal page.

      • Choose ‘Custom text’ from the Attribute type drop-down.

      • Select the ‘IsRenewal’ attribute.

      • Type ‘Yes’ in the Value field.

      • Check Show on product details page.

      • Save it.

    • Save the overall renewals product.

    2. Add Product Classifications to Renewal Product. 

    • Go to Aspenware Commerce > Product Classifications > Add Assignment, and select the hidden Category where the renewal product lives, and the renewal Product requiring assignment.

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

      Products flagged with these two

      next to the following classifications

      • 'Requires Assignment''

      • ‘Is Renewal Product’

      • 'Renewal lock'

    • Click Add.

    HINT: Products flagged with the renewal classifications will only be available on the (store URL)/renewal or (store URL)/

    ...

    linked products pages if the logged-in customer has previously purchased an RTP|One product component that links to this current product via

    ...

    product component

    ...

    link configuration.

    ...

    ...