Versions Compared

Key

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

...

Commerce Task 3 -

1. POS TASKS

1. Set up Subscription Product Headers and Hotlists

Status
colourRed
titleRequired

  • Configure subscription product headers in RTP|One as simple products that contain a single access component.

  • Configure 'Cancel' and 'Freeze' hotlists in RTP|One and make note of the respective codes.

  • Configure subscription product headers with access.

  • Set up Freeze hotlist 

  • Set up Cancel hotlist 

2. Set up Validated Customer Procedure

Status
colourBlue
titleoptional

  • Determine if stored procedures are required and contact Aspenware Represesntative for assistance in creating them.

Status
colourYellow
titlePrerequisite

2. INFRASTRUCTURE TASKS

Infrastructure Task 2 -
  • Work with your Aspenware Representative to configure Subscription Processor Azure Function test and prod.

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

3. COMMERCE TASKS

1. Ensure that Subscriptions Plugin is Installed

Status
colourRed
titlerequired

2. Add the Is Subscription Classification

Status
colourRed
titlerequired

3. Create Dummy Product for Subscription Monthly Payment Product

Status
colourRed
titlerequired

4. Configure Subscription Types

Status
colourRed
titleRequiredrequired

Status
colourYellow
titlePrerequisite

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

Status
colourBlue
titleoptional

Status
colourYellow
titlePrerequisite

Configuration Task 5 -

Status
colourRed
titleRequired

Status
colourGreen
titleDetailed Setup

...

  • Configure subscription product headers in RTP|One as simple products that contain a single access component. Because these are ongoing charges that are triggered from the Aspenware Commerce subscription tool to Payeezy or Square, the only charge that will be reconciled to RTP|One is the first deposit charge paid when the order is first placed. Subsequent monthly charges are not sent back to RTP|One.  Therefore, the product pricing setup in RTP|One is very simple.    

  • Configure two Freeze and Cancel hotlists in RTP|One and make note of the respective codes. When a charge fails, or when membership is frozen or canceled, subscription access is hotlisted with either the Cancel or Freeze hotlist, depending on the reason. Hotlists are also removed when subscription statuses go back to “active.”

  • Configure subscription product headers with access.

Info

NOTE: Only supports later hotlisting a single access code, so only one access component should be assigned to subscription products. 

  • Set up Freeze hotlist 

  • Set up Cancel hotlist one access component as hotlisting supports single access code use.

Info

NOTE: The cancel hotlist code will be set to RTP|One in the event that a subscription is canceled by an admin OR if the card on file fails a monthly payment. If clarification is needed as to whether the guest is still in the window where they can update their card and re-activate their access, check the Aspenware Admin tool to see if the Subscription status for the enrollment is failed-declined or canceled. If it is failed-declined, the guest can simply update their card in my account to remove the hotlist.

...

  • Validated Customer Procedure - Like validated prompt but allows restriction on assignment. These require custom SQL and Aspenware support.

    • Custom configuration can be added to the RTP|One stored procedure that prevents assigning the same person the same product type on the same day in subsequent orders.

      • If taking advantage of this rule, may need to add a rule to product headers.

    • Can be built in a way to use onsite

  • Redemption product header creation may be required  (for onsite redemption, add the same validated customer procedure as used online.)

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

...

  • Work with your Aspenware Representative to configure Subscription Processor Azure Function test and prod. The Subscription Processor Azure Function needs to connect to the Aspenware Commerce database and API, so it needs to be whitelisted/given permission to Nop. Aspenware will configure how often the subscription processor runs (req. every 30 seconds). Charges mostly happen at 12:01 am, however, the processor is set to run frequently. If someone updates their card in my account and they are in a declined status, it will charge them immediately, which will allow someone to fix their card on premise and use facilities immediately.

Commerce Tasks

1. Ensure that Subscriptions Plugin is Installed

  • Ensure that the Subscriptions plugin has been installed by your Aspenware Representative. Go to Configuration > Local Plugins search for the Subscriptions plugin. If plugin is not installed (matches image below), contact your Aspenware Service Representative. 

    Image Added

2. Add the Is Subscription Classification

  • Add the Is Subscription classification if not already set up as a product classification. Check that the Is Subscription classification is not already set up before adding a new one.

    • Go to Aspenware Commerce > Product Classifications.

    • Select Add Classification in the upper right-hand corner.

      Image Added
    • Enter the following on the Classifications page:

      • Name : Is Subscription

      • Description: Assign this classification to Subscription Products Only

      • Is Subscription: Check

      • Leave all other checkboxes unchecked.

    • Click Add. THIS PAGE DOESN’T HAVE AN ADD BUTTON

3. Create Dummy Product for Subscription Monthly Payment Product

  • Go to Catalog > Products page in Admin.

  • ClickAdd new to create your new payment product. 

  • Define the following values for this newly created add on product before saving the product: 

    1. Product name: This is the product that will be “sold” with each month’s charge and upon successful charge will be in the order table of the successful charge confirmation email.  Suggested to name it something like “Subscription Monthly Payment.”

    2. Short and Long description: Leave Blank.

    3. Email description: Include anything that should be sent to customers in their monthly charge email. For example: “Your membership for this month has been successfully charged. Membership charges will occur every month on the same day of the month you originally purchased your membership. Tax is included in the price of the product.”

    4. SKU (Product header): LEAVE BLANK

    5. Categories: Make sure this is not added to a published category. 

    6. Published: Check this

    7. Limited to stores: Leave blank

    8. Available start/end dates: Leave blank

    9. Price: Must be $0

    10. Discounts: Leave blank

    11. Tax Exempt: Check this. Subscription product CANNOT BE CONFIGURED WITH TAX.

    12. DO NOT set up product attributes. 

    13. Click Save and Continue Edit.

      Image Added
  • Copy down the Product ID. This can be found in the URL of the product editor page. This ID will be used in the next step to define the subscription charge product in a setting.

    Image Added

  • Go to Configuration > Settings > All Settings and define the monthly payment charge product you just created as the value for the setting subscriptionsettings.subscriptionproductid

Setting

Value

subscriptionsettings.subscriptionproductid

ID of the subscription charge product (Taken from the page URL in the previous step.)

4. Configure Subscription Types

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

  • Use this setting as described in Prerequisite Commerce Step 3.

Setting

Value

subscriptionsettings.subscriptionproductid

ID of the subscription charge product

Language Strings

Updating the content for the area of My Account where guests can manage and view their subscription credit card.

  • Go to Configuration > Languages page in Admin.

  • ClickEdit in the English row.

  • From the Edit Language details - English page, click the String Resources tab.

  • The following content is configurable through Language String resources. 

Language String

Value

Location

account.subscriptions

Subscription Card Management

Within My Account, this is the Title for the page to manage cards associated with subscriptions.

account.subscriptions.description

{Description around updating cards and terms of memberships}

Within My Account, this is the description for the page to manage cards associated with subscriptions.

Account.Subscriptions.Selectmessage

Select subscriptions to update the payment credit card.

Within My Account, this is the message to help guests navigate selecting subscription products they would like to update.

Account.Subscriptions.NoSubscriptions

You have no subscription products.

Within My Account, thisis the message that shows if guest doesn’t have subscription products for themselves or anyone else in their household.

...

HTML Widgets

  • AW Commerce HTML Widgets that must first be completed

Detailed Setup Guide

  1. Step 1 Header

1. Step 1 Header

  • First

...