Page Comparison

...

Prerequisite Tasks

...

POS Tasks

• In order for vouchers from RTP|One to show in my account, they must have a Report defined on the voucher type.

• Set up the voucher products in RTP|One and note the Voucher Template ID(s).

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

...

Configuration Step

...

Setting Name

...

Value

...

Print/View Vouchers in My Account

...

customersettings.hideprintvoucherstab

...

False = Enable Print/View Vouchers

True = Disable Print/View Vouchers

...

Install Banner Plugin HTML Widget

...

vouchersettings.showbanner

...

True = show the banner

False= do not show banner

Language Strings

The Voucher feature with Aspenware Commerce is highly configurable with Language Strings. The following table contains all of the strings that are available for the various components of the voucher functionality. For more detail on these strings and screenshot examples, visit the Language Strings Library.

Description

...

Language String Resource

...

Default Value

(Can be Customized)

...

My Vouchers

...

account.printvouchers

...

Print Vouchers

...

My Vouchers

...

account.printvouchers.description

...

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

...

My Vouchers

...

account.printvouchers.terms

...

Vouchers are non-refundable and non-transferable.

...

My Vouchers

...

account.novouchers

...

There are no vouchers on your account.

...

Page Banner

...

voucher.plugin.cta.text

...

GOT A BUDDY PASS? OR OTHER VOUCHER TO REDEEM? DO IT IN ONE CLICK HERE:

...

Page Banner Input Box

...

voucher.plugin.input.text

...

YOUR VOUCHER NUMBER

...

Voucher Popup

...

voucher.plugin.modalheader.text

...

Voucher Validation

...

Voucher Popup

...

voucher.plugin.validationwait.text

...

Please wait while we validate your voucher ID.

...

Voucher Popup

...

voucher.plugin.validationsuccess.text

...

Voucher ID successfully verified. Click redeem to continue.

...

Voucher Popup

...

voucher.plugin.invalidcode.text

...

Voucher ID is invalid.

...

Voucher Popup

...

voucher.plugin.continuebutton.text

...

Redeem

...

Voucher Popup

...

voucher.plugin.button.label

...

confirm voucher

...

Voucher banner title text

...

voucher.plugin.cta.title

...

Have a voucher to redeem?

...

Voucher banner content text

...

voucher.plugin.cta.text

...

Check your voucher ID and redeem here.

...

Product vouchers tab

...

account.myvouchers.productvoucherstab

...

My Product Vouchers

...

Other vouchers tab

...

account.myvouchers.othervoucherstab

...

My Other vouchers

...

My vouchers subheader message

...

account.myvouchers.productvouchers.description

...

Find your vouchers and take action below.

...

My vouchers description

...

account.printvouchers.description

...

...

Print/view

...

account.myvoucher.title

...

%Guest%'s Vouchers

...

My account column title

...

account.printvouchers

...

My Vouchers

...

Email voucher popup message

...

account.myvouchers.emailpopup.sendvoucher

...

Enter an email address to send this voucher.

...

Email voucher popup text entry box

...

account.myvouchers.emailpopup.textentry

...

Email address

...

Email voucher popup send button

...

account.myvouchers.emailpopup.send

...

Send

...

Print/View vouchers method

...

account.printvouchers.terms

...

Non-transferable. No cash value.

...

Voucher effective date (forthcoming)

...

account.myvouchers.effectivedate

...

Effective Date

...

Voucher expiration date

...

account.myvouchers.expirationdate

...

Expiration Date

...

Email voucher popup success confirmation

...

account.myvouchers.emailpopup.success

...

Voucher successfully sent!

...

Email voucher popup success message

...

account.myvouchers.emailpopup.success.message

...

%recipient% will receive your voucher momentarily.

...

Email voucher popup fail message

...

account.myvouchers.emailpopup.fail

...

Unfortunately, we were unable to send your voucher.

...

email voucher popup success continue/exit button

...

account.myvouchers.emailpopup.success.button

...

Ok

...

email voucher popup fail continue/exit button

...

account.myvouchers.emailpopup.fail.button

...

Ok

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 Removed

• 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:

...

Prerequisite Tasks

POS Tasks

• In order for vouchers from RTP|One to show in my account, they must have a Report defined on the voucher type.

• Set up the voucher products in RTP|One and note the Voucher Template ID(s).

• 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

Commerce Tasks

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

Settings, Language Strings and/or HTML Widgets for this Feature

Settings

Language Strings

The Voucher feature with Aspenware Commerce is highly configurable with Language Strings. The following table contains all of the strings that are available for the various components of the voucher functionality. For more detail on these strings and screenshot examples, visit the Language Strings Library.

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:

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

  • Name: Voucher (this name is customizable)

  • Visible: Checkedchecked

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

• • 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):

Image Added

Detailed Setup Guide

1. Enable Print/View Vouchers from My Account

2. 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 guests, 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.

...

• Image Modified

...

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

...