Page Comparison

...

...

• Install the Voucher Banner Plugin HTML Widget

This plugin-HTML widget creates the voucher banner.

• 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 newly added plugin)

• Select Widget Zones Tab

• Click Add new record.

• From Widget Zone drop-down select content_before.

• Click Update.
  

  Image Removed

• Click Save.
  

Detailed Setup Guide

1. Enable Print/View Vouchers from My Account

2. Installing the Voucher Plugin

3. Set Up the Voucher Product

1. Enable Print/View Vouchers from My Account

The My Account section of the Peak site includes, for logged in customers, a sidebar that allows access to a Print Vouchers page. When a customer accesses this page, any RTP|One voucher assigned to the logged-in guest or anyone in their defined RTP|One household will be displayed. 

Each voucher can be viewed and printed. Payment value vouchers include the balance remaining in the print voucher view. Active vouchers are shown initially, and inactive vouchers can be viewed if the Inactive Vouchers section is expanded. The following settings and language strings can be used to enable or disable the functionality and customize the display of Print/View Vouchers.

• Go to Configuration > Settings > All Settings (advanced) and search for the setting customersettings.hideprintvoucherstab in the name field.

  1. Edit the setting, and change the Value to 'False; to enable Print/View Vouchers in My Account. 

  2. Change the Value to ‘True’ to disable Print/View Vouchers in My Account. 

• Language strings are available to customize the text on the My Vouchers page. See above in Settings, Language Strings, and HTML Widgets for details and specific strings.

...

2. Install the Voucher Plugin

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.

  Image Removed

3. Set Up the Voucher Product

• Go to Catalog > Products and click Add new. Enter the product details and click Save and Continue Edit. (If you have successfully installed the voucher plugin, there will be a new widget at the bottom of your product setup page named “Vouchers” as well as a new (automatically injected) voucher attribute. )

...

• In the Vouchers section of the product page, enter the Voucher Template ID (from RTP|One) and click Add Voucher Template ID.

• Aspenware Commerce will validate that the voucher template is not being used on any other Commerce product.

• Click Save.

• After the Voucher Template ID has been saved, you should find a new attribute called “Voucher ID” on your product. 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 (e.g. adding [Dynamic] in the text prompt would place the voucher attribute into the dynamic component area on the PDP.) Verify that the voucher attribute has been added.

...

Enhanced Vouchers - My Account

Aspenware’s newest enhancements to voucher redemption includes the ability to both email and redeem a product voucher via their My Account page. These features are configurable within the product voucher setup and allow resorts to select whether each voucher can be printed, emailed, and/or viewed. Selecting “redeem” from My Account validates the voucher and directs guests to a fenced PDP. There, guests can add their special product using their unique product voucher to the cart. Selecting “email” allows guests to enter an email address and share their voucher. The voucher email template (which is installed via the vouchers plugin) can be customized within Aspenware Commerce admin Configuration > Message Templates. Once received, guests can either copy paste their received voucher ID into the resort’s voucher banner or redeem directly from the email by selecting the “redeem” button. For more information or for configuration details see 2.12.7 - Aspenware Commerce Release Guide - Enhanced Vouchers (Phase II).

Enhanced Vouchers - Voucher Banner Styling

Resorts can now style their voucher banner using our new voucher banner html-widget and language strings. The html-widget allows administrators to configure the banner size and color as well as text and button size and color. For details on how to configure your banner see 2.12.7 - Aspenware Commerce Release Guide - Enhanced Vouchers (Phase II).

With this release Aspenware Commerce has introduced more customization options to its new voucher banner, new my account features including the ability to redeem and email vouchers directly from my account. See the Aspenware Commerce Release Notes for a description or see below for configuration details. These custom properties are introduced via a new widget. Follow the guidelines below to customize your voucher banner.

For quick links select from the below:

Customized Voucher Banner
Voucher Banner Language Strings
Configuring Product Vouchers in My Account (redeem, email, view, print)
My Vouchers Language Strings
Email Vouchers Email Template

2. Customize Voucher Banner

Custom properties for the voucher banner are available via an HTML Widget. If you are already using the vouchers plugin, the voucher banner will have already been installed. If you are unsure or need to install the plugin, verify by searching within the route below:

Nop Templates > Plugins > Html Widgets > Manage Html Widgets > Voucher Toolbar

Image Added

HTML Widgets

1. Voucher Banner Plugin HTML Widget

2. Voucher Banner Styling HTML Widget

1. Install the Voucher Banner Plugin HTML Widget

This plugin-HTML widget creates the voucher banner.

• 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 newly added plugin)

• Select Widget Zones Tab

• Click Add new record.

• From Widget Zone drop-down select content_before.

• Click Update.
  

  Image Added

• Click Save.
  

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

<style>

:root {
--voucher-banner-background-color: #00cc99;
--voucher-label-weight: normal;
--voucher-label-color: #4d4dff;
--voucher-label-size: 0.875rem;
--voucher-button-text-color: #99ff33;
--voucher-button-text-size: 1.5em;
--voucher-button-background-color: #ff0066;
--voucher-text-weight: 500;

}

</style>

...

Detailed Setup Guide

1. Enable Print/View Vouchers from My Account

2. Installing the Voucher Plugin

3. Set Up the Voucher Product

1. Enable Print/View Vouchers from My Account

The My Account section of the Peak site includes, for logged in customers, a sidebar that allows access to a Print Vouchers page. When a customer accesses this page, any RTP|One voucher assigned to the logged-in guest or anyone in their defined RTP|One household will be displayed. 

Each voucher can be viewed and printed. Payment value vouchers include the balance remaining in the print voucher view. Active vouchers are shown initially, and inactive vouchers can be viewed if the Inactive Vouchers section is expanded. The following settings and language strings can be used to enable or disable the functionality and customize the display of Print/View Vouchers.

• Go to Configuration > Settings > All Settings (advanced) and search for the setting customersettings.hideprintvoucherstab in the name field.

  1. Edit the setting, and change the Value to 'False; to enable Print/View Vouchers in My Account. 

  2. Change the Value to ‘True’ to disable Print/View Vouchers in My Account. 

• Language strings are available to customize the text on the My Vouchers page. See above in Settings, Language Strings, and HTML Widgets for details and specific strings.

...

2. Install the Voucher Plugin

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.

  Image Added

...

Once installed, you are ready to add the new voucher banner styling html widget:

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

   1. Custom Properties

      1. voucher banner background color

      2. voucher label weight

      3. voucher label size

      4. voucher button text color

      5. voucher button text size

      6. voucher button background color

      7. voucher text weight

   2. To customize go to Nop-Templates > Plugins > Html Widgets > Manage

   3. Select Add new Html widget

   4. Name: Vouchers Styling (this name is customizable)

   5. Select “Tools > <> Source code

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

      2. <style>

         :root {
         --voucher-banner-background-color: #00cc99;
         --voucher-label-weight: normal;
         --voucher-label-color: #4d4dff;
         --voucher-label-size: 0.875rem;
         --voucher-button-text-color: #99ff33;
         --voucher-button-text-size: 1.5em;
         --voucher-button-background-color: #ff0066;
         --voucher-text-weight: 500;

         }

         </style>

See example below:

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

Configure Banner Language Strings

Two new language strings have been added to the new voucher banner to allow admins to configure the banner title separate from the content text (see image above). (For more on banner language strings see 2.12.5 Release Guide.

These new language strings can be seen below:

...

Description

...

String Resource

...

Current Value

...

Placement

...

Voucher banner title text

...

voucher.plugin.cta.title

...

Have a voucher to redeem?

...

Left side of voucher banner.

...

Voucher banner content text

...

voucher.plugin.cta.text

...

Check your voucher ID and redeem here.

...

Second sentence in voucher banner.

My Account Voucher Enhancements

If the vouchers plugin is installed, the latest voucher enhancements to my account allow for showing and hiding my voucher buttons for product vouchers (payment vouchers remain the same). If both payment and product vouchers exist and the new plugin is installed, the vouchers will appear in a tabbed format for users to toggle between the two types of vouchers. Follow the configuration instructions below to customize these features.

1. Add a voucher product and assign the voucher template ID

   1. If you do not already have a voucher product added follow the product setup portion of Aspenware Commerce 2.12.5 Configuration Guidelines for Enhanced Vouchers

   2. Once your voucher has been added you will find the following new options

      1. Image Removed

      2. If you would like the voucher to be visible in My Account, make sure that “visible” is selected AND the appropriate instructions for displaying vouchers via RTP have been followed (i.e. a report has been added to the voucher type)

   3. Check and uncheck the My Account button options to hide/display the presented buttons

      1. Image Removed

          

Language Strings

...

Description

...

Resource Name

...

Value

...

Location/Miro Ref. #

...

Product vouchers tab

...

account.myvouchers.productvoucherstab

...

My Product Vouchers

...

1

...

Other vouchers tab

...

account.myvouchers.othervoucherstab

...

My Other vouchers

...

2

...

My vouchers subheader message

...

account.myvouchers.productvouchers.description

...

Find your vouchers and take action below.

...

3

...

My vouchers description

...

account.printvouchers.description

...

...

3- Same positioning on product and other vouchers tab

...

Print/view

...

account.myvoucher.title

...

%Guest%'s Vouchers

...

4

...

My account column title

...

account.printvouchers

...

My Vouchers

...

6

...

Email voucher popup message

...

account.myvouchers.emailpopup.sendvoucher

...

Enter an email address to send this voucher.

...

7

...

Email voucher popup text entry box

...

account.myvouchers.emailpopup.textentry

...

Email address

...

8

...

Email voucher popup send button

...

account.myvouchers.emailpopup.send

...

Send

...

9

...

Print/View vouchers method

...

account.printvouchers.terms

...

Non-transferable. No cash value.

...

19

...

Voucher effective date (forthcoming)

...

account.myvouchers.effectivedate

...

Effective Date

...

17

...

Voucher expiration date

...

account.myvouchers.expirationdate

...

Expiration Date

...

18

...

Email voucher popup success confirmation

...

account.myvouchers.emailpopup.success

...

Voucher successfully sent!

...

12

...

Email voucher popup success message

...

account.myvouchers.emailpopup.success.message

...

%recipient% will receive your voucher momentarily.

...

13

...

Email voucher popup fail message

...

account.myvouchers.emailpopup.fail

...

Unfortunately, we were unable to send your voucher.

...

15

...

email voucher popup success continue/exit button

...

account.myvouchers.emailpopup.success.button

...

Ok

...

14

...

email voucher popup fail continue/exit button

...

account.myvouchers.emailpopup.fail.button

...

Ok

...

3. Set Up the Voucher Product

• Go to Catalog > Products and click Add new. Enter the product details and click Save and Continue Edit. (If you have successfully installed the voucher plugin, there will be a new widget at the bottom of your product setup page named “Vouchers” as well as a new (automatically injected) voucher attribute. )

...

• In the Vouchers section of the product page, enter the Voucher Template ID (from RTP|One) and click Add Voucher Template ID.

• Aspenware Commerce will validate that the voucher template is not being used on any other Commerce product.

• If you would like the voucher to be visible in My Account, make sure that visible is selected AND the appropriate instructions for displaying vouchers via RTP|One have been followed (i.e. a report has been added to the voucher type.)

• Check and uncheck the My Account button options (to hide/display the presented buttons view/print, redeem, email.)

• Click Save.

• Check and uncheck the My Account button options to hide/display the presented buttons

• After the Voucher Template ID has been saved, you should find a new attribute called “Voucher ID” on your product. 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 (e.g. adding [Dynamic] in the text prompt would place the voucher attribute into the dynamic component area on the PDP.) Verify that the voucher attribute has been added.

...

1. Image Added

Email Voucher Email Template

...