Versions Compared

Key

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

...

1. POS Tasks

RTP|One only

  • Set up a Voucher Template in RTP|One, (only product, product/discount, discount, and payment voucher types are supported).

    Status
    colourRed
    titlerequired

  • Create the voucher numbers for your Voucher Templates.

    Status
    colourRed
    titlerequired

  • If a voucher should be sold through the purchase of a product, add the voucher template to the voucher product component of the initial product that “grants” access to the vouchers.

    Status
    colourBlue
    titleoptional

  • In order for vouchers from RTP|One to show in the Aspenware Commerce My Account page, they must have a Report defined on the voucher type. add the voucher product(s) to the component.

    Status
    colourBlue
    titleoptional

  • For Payment Value Vouchers:

    • the voucher must be sold as a transaction in RTP in order to display in the My Account page.

    • Provide AW with:

      • a voucher product header

      • voucher payment method code

      • GL voucher clearing account

    • Update RTP admin to enable vouchers payment methods available for use at AWC location

Status
colourYellow
titlePrerequisite

2. Infrastructure Tasks

  • To update the logo that displays on vouchers in My Account, email support@aspenware.com with a png and svg image of your logo. This change does require a theme update and deployment.

3. Aspenware Commerce Tasks

1. Install Voucher Plugin

Status
colourRed
titlerequired

  • Go to Configuration > Local Plugins and select the Group Aspenware Commerce

  • Scroll to the Plugin Info for Vouchers.

  • Ensure that Installed and Is Enabled are both checked.

  • To enable payment value vouchers in checkout ensure Vouchers are enabled in the “Additional Payments” Plugin

    Status
    colourBlue
    titleoptional

  • To enable multiple payment value vouchers to be used in checkout, ensure “Allow multiple Additional Payments” is enabled in the “Additional Payments Plugin”

    Status
    colourBlue
    titleoptional

2. Configure Language Strings, Settings, and HTML widgets

  • Update the appropriate language strings.

    Status
    colourBlue
    titleoptional

  • Configure the following settings:

    Status
    colourBlue
    titleoptional

    1. customersettings.hideprintvoucherstab

    2. vouchersettings.showbanner

  • Install the following HTML Widgets if you want to utilize the Voucher Banner.

    1. Voucher Banner Plugin HTML Widget

      Status
      colourRed
      titlerequired

    2. Voucher Banner Styling HTML Widget

      Status
      colourBlue
      titleoptional

    3. Voucher/Gift Card Help HTML Widget

      Status
      colourBlue
      titleoptional

3. Set Discount.

Status
colourBlue
titleoptional

  • In Aspenware Commerce Administration go to Promotions > Discounts

    1. Select Add New.

    2. Set up your discount including the appropriate discount amount/percentage.

    3. Click Save.

4. Configure Voucher Email Template

Status
colourBlue
titleOPtional

  1. Go to Content Management > Message Templates and find “Vouchers.EmailVoucher”

  2. Select Edit

    1. Go to “Source Tools”

    2. Find the text below and replace the [INSERT URL TO LOGO HERE] with your store’s logo image url

Status
colourYellow
titleprerequisite

1. Option 1: Create Product Voucher

Status
colourBlue
titleoptional

  • Go to Catalog > Products and search for the fenced product you wish to associate to the voucher and click Edit.

  • Scroll all the way down to the admin.catalog.products.vouchers module.

  • Click Add Voucher Template ID and add it.

  • Configure My Account options and Save.

2. Option 2: Create Discount Voucher

Status
colourBlue
titleoptional

  • Go to Promotions > Discounts in Admin.

  • Click Add New and create the discount.

  • Click Save and Continue Edit.

  • Scroll down to the Requirements tab.

  • In Discount Requirement Type, select ‘Vouchers’. The Voucher Template ID field will then display.

  • Enter the Voucher Template ID and click Update Template ID.

  • Scroll down to the Applied to products section and Add a new product.

3. Option 3: Create Product/Discount Voucher

Status
colourBlue
titleoptional

  • Go to Catalog > Products and search for the fenced product you wish to associate to the voucher and click Edit.

  • Scroll all the way down to the admin.catalog.products.vouchers module.

  • Click Add Voucher Template ID and add it.

  • Configure My Account options and click Save and Continue Edit.

  • Go to Promotions > Discounts in Admin.

  • Click Add New and create the discount.

  • Click Save and Continue Edit.

  • Scroll down to the Requirements tab.

  • In Discount Requirement Type, select ‘Vouchers’. The Voucher Template ID field will then display.

  • Enter the Voucher Template ID and click Update Template ID.

  • Scroll down to the Applied to products section.

  • Click Add a new product to add the product.

  • Check it and click Save.

Status
colourGreen
titleDetailed Setup

...

Installing the voucher plugin is required for the use of voucher redemption. This will both allow the voucher banner to be displayed and show/enable the voucher widget on the product setup.

  • Go to Configuration > Local Plugins >

  • Select Aspenware Commerce from the Group drop-down list. Scroll down to Plugin info for Vouchers.

  • Ensure that both Installed and Is Enabled are checked.

...

To enable payment value vouchers in checkout ensure Vouchers are enabled in the “Additional Payments” Plugin:

  • Go to Aspenware Commerce > Additional Payments > then select “Vouchers” > Click Save

...

To enable multiple payment value vouchers to be used in checkout, ensure “Allow multiple Additional Payments” is enabled in the “Additional Payments Plugin”. If unselected, then guests will only be able to apply one payment value voucher per transaction. To enable multiple:

  • Go to Aspenware Commerce > Additional Payments > then select “Allow Multiple Additional Payments” > Click Save

...

2. Set Discount (If creating a discount voucher)

  • In Aspenware Commerce Administration go to Promotions > Discounts

    1. Select Add New.

    2. Set up your discount according to setup documentation including the appropriate discount amount/percentage

    3. Click Save.

Info

NOTE:A promo code is not required for discount vouchers, however, if you would like the guest to see a promo code on the cart, you may add one. If a guest does not have a voucher and tries to enter the promo code, the discount will not work.

  • If using discount vouchers and limiting usage, make sure the following plugin is installed: Discount Requirements - Cart must contain a certain amount of products by navigating to Configuration > Local plugins.

...

3. Ensure required products are set up.

For information about setting up products, see the Product Configuration Documentation.

4. Create a published but hidden voucher category.

...

When a deployment occurs and the vouchers plugin is installed the email vouchers template will be added to Content Management > Email Templates (if the template already exists it will not overwrite the existing template).

To configure the email template:

  • Go to Content Management > Message Templates

  • Search for “Vouchers.EmailVoucher”

  • Select Edit

    1. Go to “Source Tools”

    2. Find the text below and replace the [INSERT URL TO LOGO HERE] with your store’s logo image URL

    3. Adjust width and height as necessary

      1. Code Block
        <img src="[INSERT URL TO LOGO HERE]" alt="Logo" style="border: none; -ms-interpolation-mode: bicubic; max-width: 100%;" width="150" height="41" align="middle" />

         

...

For discount vouchers or product/discount vouchers, cache product prices must be unchecked. This setting can be found in Settings > Catalog Settings.

Voucher Banner Language Strings

The Voucher feature with Aspenware Commerce is highly configurable with Language Strings. Use the tables below to view and modify string resources and values by going to Configuration > Languages >Edit in Administration, searching for the appropriate string, and verifying/replacing values as desired. For more detail on these strings and screenshot examples, visit the Language Strings Library.

...

Description

Language String Resource

Default Value

(Can be Customized)

Placement

Product vouchers tab

account.myvouchers.productvoucherstab

My Product Vouchers

Product/Other Toggle underneath heading

Other vouchers tab

account.myvouchers.othervoucherstab

My Other vouchers

Product/Other Toggle underneath heading

My vouchers subheader message

account.myvouchers.productvouchers.description

Find your vouchers and take action below.

Text underneath My Vouchers title

Print/view

account.myvoucher.title

%Guest%'s Vouchers

Heading above list of available vouchers

My account column title

account.printvouchers

My Vouchers

Title at the top of page

Email voucher popup message

account.myvouchers.emailpopup.sendvoucher

Enter an email address to send this voucher.

Email Voucher popup window

Email voucher popup text entry box

account.myvouchers.emailpopup.textentry

Email address

Email Voucher popup window - email field

Email voucher popup send button

account.myvouchers.emailpopup.send

Send

Button on Email Voucher popup

Print/View vouchers method

account.printvouchers.terms

Non-transferable. No cash value.

Description on the voucher detail page

Voucher effective date (forthcoming)

account.myvouchers.effectivedate

Effective Date

(Forthcoming)

Description on the voucher detail page

Voucher expiration date

account.myvouchers.expirationdate

Expiration Date

Voucher detail page

Email voucher popup success confirmation

account.myvouchers.emailpopup.success

Voucher successfully sent!

Successful Send popup

Email voucher popup success message

account.myvouchers.emailpopup.success.message

%recipient% will receive your voucher momentarily.

Successful Send popup

Email voucher popup fail message

account.myvouchers.emailpopup.fail

Unfortunately, we were unable to send your voucher.

Fail to send popup

email voucher popup success continue/exit button

account.myvouchers.emailpopup.success.button

Ok

Button on successful send popup

email voucher popup fail continue/exit button

account.myvouchers.emailpopup.fail.button

Ok

Button on fail to send popup

print voucher popup

account.printvouchers

Print Vouchers

Button

print voucher popup

account.printvouchers.description

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

Print popup page

print voucher popup

account.printvouchers.terms

Vouchers are non-refundable and non-transferable.

Print popup page

print voucher popup

account.novouchers

There are no vouchers on your account.

Print popup/no vouchers

Print/View vouchers method

account.printvouchers.terms

Non-transferable. No cash value.

Print popup

...

Note

IMPORTANT: The Voucher Banner Plugin Widget MUST be installed even if you don’t want the banner to be visible. If you do not want the banner to be visible, you can disable it by going to the vouchersettings.showbanner settings and set it to 'FALSE.” It will be defaulted to 'TRUE”.

  • Go to Nop-Templates > Plugins > Html Widgets > Manage HTML Widgets

  • Click Add new Html Widget

  • Enter the following:

    • Name: Voucher (this name is customizable)

    • Visible: checked

    • HTML Content: Select Tools dropdown and select “<> Source Code”

  • Enter: <validate-code></validate-code>

  • Click Save.

  • Select Edit (on the newly added plugin)

  • Select Widget Zones Tab

  • Click Add new record.

  • From Widget Zone drop-down select content_before.

  • Click Update.

  • Click Save.

Add Voucher Banner Styling HTML Widget


Although the voucher banner includes default styling from the site’s overall CSS, the following properties (all or any) can be optionally customized via the widget including banner background color, label weight, label size, button text color, button text size, button background color, and text weight.

  • Go to Nop-Templates > Plugins > Html Widgets > Manage

  • Select Add new Html widget and enter the following:

    • Name: Vouchers Styling (this name is customizable)

    • Visible: Checked

    • Html Content: Select Tools > Source Code

      • Within the text box popup, you can add any of the above properties using the following formatting (bold text is configurable):

...

  • Add Widget Zone

    1. Select the tab Widget Zones Tab (next to Html Widget Settings)

    2. Select Add new record

    3. Select widget zone: head_html_tag

    4. Select Update

Detailed Setup Guide

Determine the type of voucher that best meets your needs (product voucher, discount voucher or product/discount voucher) and choose from the options below for configuration. For more information about the types of vouchers, please see the Vouchers Overview in this Documentation.

...

Product vouchers are used to give specific guests access to a fenced product. Note that Aspenware only supports single use for product vouchers. The most common use case for this type of voucher is a “Friends and Family Lift Ticket” product that is connected to a season pass holder. The pass holder can email the voucher ID to a friend or family member.

  • Go to Catalog > Products and search for the fenced product you wish to associate to the voucher and click Edit.

  • Scroll all the way down to the admin.catalog.products.vouchers module.

  • Enter the voucher template ID (This is the one generated from RTP|One in the Prerequisite step above). Please note that

  • Click Add Voucher Template ID.

  • The Voucher Template ID will then be displayed below as associated with the product.

  • Check “Visible” if you want the voucher to be visible in the guest’s My Account Vouchers tab.

  • Check “Email”, “Redeem”, or “Print/View” depending on which options you’d like to have available to the guest in their My Account Vouchers tab.


  • Click Save and Continue Edit.

  • After the Voucher Template Id has been saved, scroll to the Product attributes section to verify that a new attribute called “Voucher Id” appears as an added attribute. You should not have to alter this. However, if you would like it to appear in a different area or order you may adjust this by adding [Dynamic] in the text prompt to place the voucher attribute into the dynamic component area on the PDP.

...

Configure Discount Voucher

  • Go to Promotions > Discounts in Admin.

  • Click Add New and enter the following:

    1. Name: Enter the name of your discount.

    2. Discount type: Choose ‘Assigned to Products’

    3. Percentage: Check if you want the product to be discounted by a certain percentage.

      1. Discount Percentage: Enter the discount percentage that will be applied.

      2. Maximum Discount Amount: leave blank

    4. Percentage: Leave unchecked if you would like the product to be discounted by a certain dollar amount.

      1. Discount Amount: Enter the amount of the discount.

    5. The rest of the fields can be left blank.

  • Click Save and Continue Edit.

  • Scroll down to the Requirements tab.

  • In Discount Requirement Type, select ‘Vouchers’. The Voucher Template ID field will then display.

  • Enter the Voucher Template ID and click Update Template ID.

  • The requirement will then be displayed.

  • Scroll down to the Applied to products section.

  • Click Add a new product.

  • Search for the product you would like to associate with the Discount Voucher.

  • Check it and click Save.

  • The product is now listed in the Applied to products section.

  • Discount Vouchers can be applied to many products.

  • Click Save.

(Optional) Set Limits on Number of Products in the Cart

...

  • On the Discount, scroll back to the Requirements section and, under ‘Add a new discount requirement’ enter:

    1. Discount requirement type: 'Cart must contain certain amount of products'

    2. Minimum Quantity: Enter a minimum number of products the cart must contain (optional)

    3. Maximum Quantity: Enter a maximum number of products the cart must contain (optional)

    4. Products: Click Add product to add any products that are associated with this requirement.

    5. Click Save.

  • The additional requirement will now appear under Requirements for the product.

...

Configure Product Portion of Product/Discount Voucher

  • Go to Catalog > Products and search for the fenced product you wish to associate to the voucher and click Edit.

  • Scroll all the way down to the admin.catalog.products.vouchers module.

  • Enter the voucher template ID (This is the one generated from RTP|One in the Prerequisite step above.)

  • Click Add Voucher Template ID.

  • The Voucher Template ID will then be displayed below as associated with the product.

  • Check “Visible” if you want the voucher to be visible in the guest’s My Account Vouchers tab.

  • Check “Email”, “Redeem”, or “Print/View” depending on which options you’d like to have available to the guest in their My Account Vouchers tab.


  • Click Save and Continue Edit. (You will notice that the Voucher ID is now listed in the product attributes for this product

  • Click Save and Continue Edit.

  • After the Voucher Template ID Id has been saved, scroll to the Product attributes section to verify that a new attribute called “Voucher ID” appears in the Attributes section for the productId” appears as an added attribute. You should not have to alter this. However, if you would like it to appear in a different area or order you may adjust this by adding [Dynamic] in the text prompt to place the voucher attribute into the dynamic component area on the PDP.

Note

IMPORTANT: Please note that the Voucher Id attribute is case sensitive so it must be named “Voucher Id” and not “Voucher ID.” See Configuration: Product Attributes for information on creating and editing product attributes.

...

Configure Discount Portionof Product/Discount Voucher

  • Go to Promotions > Discounts in Admin.

  • Click Add New and enter the following:

    1. Name: Enter the name of your discount.

    2. Discount type: Choose ‘Assigned to Products’

    3. Percentage: Check if you want the product to be discounted by a certain percentage.

      1. Discount Percentage: Enter the discount percentage that will be applied.

      2. Maximum Discount Amount: leave blank

    4. Percentage: Leave unchecked if you would like the product to be discounted by a certain dollar amount.

      1. Discount Amount: Enter the amount of the discount.

    5. The rest of the fields can be left blank.

  • Click Save and Continue Edit.

  • Scroll down to the Requirements tab.

  • In Discount Requirement Type, select ‘Vouchers’. The Voucher Template ID field will then display.

  • Enter the Voucher Template ID and click Update Template ID.

  • The requirement will then be displayed.

  • Scroll down to the Applied to products section.

  • Click Add a new product.

  • Search for the product you would like to associate with the Discount Voucher.

  • Check it and click Save.

  • The product is now listed in the Applied to products section.

Note

IMPORTANT: You may only include one product here. The Product/Discount voucher is specific to only one product.

...

  • Click Save.

4. (Optional) Create a Dedicated Voucher Redemption Page

...

Info

NOTE: Some resorts may have headers that override Aspenware Commerce styles; if this causes issues with your UI please follow the instructions below to ensure that your styles do not override those needed for the dedicated voucher page.

  • Go to Admin > Content Management > Topics (pages)

  • Select Add New.

  • Make sure the Advanced tab is selected and

    1. Enter the title of your page in the text entry field, this will not show on the page but will be part of the URL e.g. https://shop.yourresort.com/redeemvoucher

    2. Note the name of your URL at the bottom of the module

    3. Add a System Name under the Display module as well (this is the title that will show on your list of Topics (pages))

  • To implement

    1. Within the Body module, select Tools > sourcecode

    2. In the source, paste the following code:

...

Info

NOTE: No CSS changes should be necessary as styles for the page will pull from the client theme.

  • Save and test the new page

For Resorts with Styles that Override the Dedicated Voucher Page

...

In Aspenware Commerce administration dashboard navigate to

  • Nop Templates > Plugins > Html Widgets > Manage html widgets

  • Select Add New Html Widget

  • Name the voucher modal (e.g. Fix Voucher Modal)

  • Select Tools --> <> Source Code

  • Enter the following code in the text entry field:

Code Block
<style>
.ax--box.full-width {    
width: 100% !important;    
margin-left:inherit !important;
}
</style>
  • Select Save and Continue Edit

  • Select Widget Zones

  • From the dropdown select body_start_html_tag_after

  • Select Update

...