Versions Compared

Key

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

This feature is supported for: Resorts that use RTP|One as their POS.

Warning

This feature is not supported for: Resorts that use Siriusware as their POS.

Setup Checklist

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

1. POS

TASKS POS Task 1

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

Tasks

  • Set up general component for AW Additional Payment Component.

    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

Commerce Task 3 -
  • For each alternate payment method (Gift Cards, Vouchers, Stored Value) being used, complete the following

    • Create payment method product header.

    • Obtain and copy down the payment method code

    • Obtain and copy down new GL clearing account for each payment method.

    • Attach the new GL clearing account to the newly created product header

  • Ensure Aspenware adds the header codes and payment method code to the Unit rtp-config.json file.

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

3. COMMERCE TASKS

  • Share the following report with accounting contact(s) at the resort to see how accounting flows with alternate payments. If questions arise, connect with Kevin Vogle (k.vogle@aspenware.com)

    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 -
  • Work with your Aspenware Representative to create a GL export report with additional payment clearing accounts along with credit account.

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

2. Commerce Tasks

Ensure that the Additional Payments Plugin is installed.

Status
colour

Blue

Red
title

optional

Required

Status
colourYellow
titlePrerequisite

Configuration Task 5 -

Configure Additional Payment

Status
colourRed
titleRequired

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

titleExample of Configuration Task

Status
colour

Red

Green
title

RequiredCode is entered If using non default lock time of 900 seconds, the desired lock time is configured. Statuscolour

Detailed Setup

Update Messaging for Additional Payments on Payment Step

Status
colour

RedtitleRequired

If using location in RTP, location code is entered

Status
colourRed
titleRequired

If multi day product, number of days is defined

Status
colourRed
titleRequired

Blue
title

optional

Optional

Status
colourGreen
titleDetailed Setup

Prerequisite Tasks

Insert excerpt
AE:Prerequisites Tasks ExcerptAE:
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 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

...

  • Set up a general component called AW Additional Payment Component.

  • If using Gift Cards

    1. Set up a gift card payment product header in RTP|One and send this new header code to your Aspenware Representative.

      1. Price the header at $0 and make it available for a long date range (i.e. out to 2050).

      2. Don’t add any header rules.

      3. The header needs to be set up for the Aspenware/Online sales location

    2. Obtain existing gift card payment method code and send the new payment method code to your Aspenware Representative.

      1. Ensure the Aspenware/Online location is added to the Payment Method and the Payment Authorization Profile.

    3. Obtain new GL gift card clearing account. This must be a unique and new GL clearing account. Send the new GL clearing account to your Aspenware Representative to use for creating the GL export report.

    4. Attach the new GL clearing account to the newly created gift card payment product header (created in step a).

    5. Aspenware will add the header code and payment method code (created above) to the Unity rtp-config.json file.

Info

NOTE: Aspenware recommends that you follow RTP’s best practices when issuing or printing your gift cards. In addition to being unique, all gift card numbers should all:

  1. Be 16 digits long

  2. Have the same 4 digit prefix for each batch (e.g. you print 10,000 GCs)

  3. Be generated with and pass the Mod 10/Luhn algorithm

...

Info

NOTE: Aspenware Commerce only supports a single gift card payment method code, GL clearing account, and product header for gift cards.

For additional information and best practices for gift cards see Gift Card Setup Recommendations.

  • If using Stored Value:

    1. Set up a stored value product header in RTP|One and send this new header code to your Aspenware Representative.

      1. Price the header at $0 and make it available for a long date range (i.e. out to 2050).

      2. Don’t add any header rules.

      3. The header needs to be set up for the Aspenware/Online sales location

    2. Obtain existing stored value payment method code and send the new payment method code to your Aspenware Representative.

    3. Obtain new GL stored value clearing account. This must be a unique and new GL clearing account. Send the new GL clearing account to your Aspenware Representative to use for creating the GL export report.

    4. Attach the new GL clearing account to the newly created stored value product header (created in step a).

    5. Aspenware will add the header code and payment method code (created above) to the Unity rtp-config.json file.

Info

NOTE: Aspenware Commerce only supports a single stored value payment method code, GL clearing account, and product header for stored value.

  • If using Vouchers:

    1. Set up a voucher payment product header in RTP|One and send this new header code to your Aspenware Representative.

      1. Price the header at $0 and make it available for a long date range (i.e. out to 2050).

      2. Don’t add any header rules.

      3. The header needs to be set up for the Aspenware/Online sales location

    2. Obtain existing voucher payment method code and send the new payment method code to your Aspenware Representative.

    3. Obtain new GL voucher clearing account. This must be a unique and new GL clearing account. Send the new GL clearing account to your Aspenware Representative to use for creating the GL export report.

    4. Attach the new GL clearing account to the newly created voucher payment product header (created in step a).

    5. Aspenware will add the header code and payment method code (created above) to the Unity rtp-config.json file.

Info

NOTE: Aspenware Commerce only supports a single payment voucher payment method code, GL clearing account, and product header for voucher payments.

  • Share the following report with accounting contact(s) at the resort to see how accounting flows with alternate payments. If questions arise, connect with Kevin Vogle (k.vogle@aspenware.com)

View file
nameNopCommerceAdditionalPaymentsTSheet.xlsx

  • To see an example of how alternate payments will display within a transaction, review the following screenshot.

    Image Added
  • If using alternate payments:

    • Install Nop4U

    • Work with your Aspenware Representative to create a GL export report with additional payment clearing accounts along with credit account.

Commerce Tasks

  • Ensure the Additional Payments plugin is installed by going to Configuration > Local Plugins. If the plugin has the Uninstall button listed like the example below, it is installed. If it looks different from the example below, contact your Aspenware Representative to install this plugin on your test and live shops. 

...

Detailed Setup Guide

Insert excerpt
Detailed Setup Guide Excerpt
Detailed Setup Guide Excerpt
nopaneltrue

1. Configure Additional Payment

  • Go to Configuration>Settings>All settings and search for the following settings in Name. Set the Vaue to as follows.

Name

Value

Description

shoppingcartsettings.showgiftcardbox

True

Enables the Gift Card and Voucher box on the payment step of checkout

Checkout.additionalPaymentsConfiguration.AreGiftCardsActive

True

Enable payment with gift cards, also complete the plugin task below to enable this.

Checkout.additionalPaymentsConfiguration.AreVouchersActive

True

Enable payment with vouchers, also complete the plugin task below to enable this.

Checkout.additionalPaymentsConfiguration.IsStoredValueActive

True

Enable payment with stored value, also complete the plugin task below to enable this.

  • Go to Aspenware Commerce > Additional Payments and enter the following:

    • Allow Multiple Additional Payments: Check to support accepting more than one voucher or gift card value to be entered in a single order. If restricting guests to using only one voucher or gift card per order, leave this unchecked. 

    • Enabled Payment Types: Check each additional payment that should be turned on for your shop: Vouchers, Gift Card and Stored Value. Keep in mind that RTP|One pre-work (detailed above) is required before paying with any of these methods will work. 

...

2. Update Messaging For Additional Payments on the Payment Step

Most additional payments editable content is built on the premise that both Gift Cards and Vouchers are enabled (in the step above). For example, even if you're not using Gift Cards, that’s fine, but in order to customize the messaging, it is required to have both Vouchers and Gift Cards enabled in the plugin (Detailed above).

  • First, to update the messaging below the Apply button, configure the HTML widget titled ‘Gift Card and Voucher Help’ using the detailed instruction guide for HTML widgets: Configuration and Library: HTML Widgets

  • Second, to update messaging on the payments page for alternate payments, configure the following language strings using the detailed instruction guide for language strings: Language Strings Library

Resource name

Value

Description

account.login.checkout.payment.storedvaluebalance

You have <strong>${balance}</strong> in snow cash available. Apply this to your order?

Display stored value balance to use for guest if available.

account.login.checkout.payment.storedvaluelabel

Stored Value

Stored value header if stored value is configured for shop and guest has available stored value balance.

account.login.checkout.payment.vouchergiftcardplaceholder

Gift Card or Voucher

Placeholder text inside the Voucher/Gift Card entry box

Image Added

Info

NOTE: If the messaging changes you made don’t take, ensure that both Gift Cards and Vouchers are enabled (in the step above). For example, even if you're not using Gift Cards, that’s fine, but in order to customize the messaging, it is required to have both Vouchers and Gift Cards enabled in the plugin (Detailed above).

Common Troubleshooting

Q: How do I share payment value vouchers with customers in the My Account section so they can use these vouchers for payment on the payment step?

For payment value vouchers, ensure they are set to a payment value/recipient in order for it to show in My Account.  The Voucher Type being used also has to have a ‘Report' defined in its setup.  It doesn't matter what report it is but it has to be defined as something in order for the voucher to show in My Account.  We may also have to add some SQL security to the user we are using as there is a call into RTP to check the account holders’ vouchers in order to display them.

​Any payment value voucher can be used as payment on the site but only ones that are also recipient can show in My Account. 

Q: In the past we had different payment value vouchers with different accounts tied to them.  So I just need to know on a go-forward if we need to standardize those into one account, or if I can use multiple GL accounts?

You can still use as many 'voucher GL accounts' as you'd like so you are not limited to just one.  When the voucher is created using the payment value type in RTP, just assign any GL accounting you want there.  The only GL account that is used every time is the new voucher clearing GL account which should be added to header, 157477.  That will be offset/reconciled with the Aspenware Commerce GL Report which we'll create if it's not already.  That will show a differentiation of credit card vs. voucher payment orders that are created.

Q: Do you support multiple voucher codes or gift cards per transaction?

A: Yes, we do support this. When configuring the Alternate payments plugin in Aspenware Commerce, ensure that you check the box Allow Multiple Additional Payments if you wish to support this.

Q: My GL Clearing Account in RTP and the GL Clearing Account Report in Aspenware Commerce are not matching up. Help!

A: If an order fails to process to RTP on the day it was placed in Aspenware Commerce due to an order failure, the GL Clearing account can be out of sync. Aspenware can help identify orders that failed and were processed days later if you are questioning the GL Clearing Account data.

Q: Can I pay with some of my order with an alternate payment and the rest with Affirm?

No, Affirm requires that the entire balance of the order be paid with Affirm if Affirm is the selected payment method.

Q: We do not want to allow guests to use stored value when purchasing season passes. Is there a way to restrict stored value on Aspenware for specific products or is this a global setting? If it is a global setting, is it possible to turn this feature off when we launch?

A: Unfortunately this is a store-wide setting and can't be restricted to specific products. To turn it off you just need to uncheck stored value in the additional payments section of Aspenware Administration.

...