| Table of Contents |
|---|
Setup Checklist
...
1. POS Tasks
...
RTP|One only
Define a Report on the voucher type in RTP|One if you want vouchers to show in My Account.
Status colour Blue title optional Set up the voucher products in RTP|One and note the Voucher Template ID(s).
Status colour Red title required
...
| Status | ||||
|---|---|---|---|---|
|
...
2. Aspenware Commerce Tasks
...
1. Install Voucher Plugin
| Status | ||||
|---|---|---|---|---|
|
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.
2. Configure Language Strings, Settings, and HTML widgets -
| Status | ||||
|---|---|---|---|---|
|
Update the approrpiate language strings:
This feature includes many language strings for a highly customizable user interface. See below for an extensive list of these strings.Configure the following settings:
customersettings.hideprintvoucherstab
vouchersettings.showbanner
Install the following HTML Widgets if you want to utilize the Voucher Banner.
Voucher Banner Plugin HTML Widget
Voucher Banner Styling HTML Widget
...
| Status | ||||
|---|---|---|---|---|
|
...
1. Enable Print/View Vouchers in My Account
| Status | ||||
|---|---|---|---|---|
|
Update customersettings.hideprintvoucherstab to ‘False’.
(Optional) Customize Language Strings (see below.)
...
| Status | ||||
|---|---|---|---|---|
|
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).
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.
| Info |
|---|
NOTE: If the voucher toolbar is missing, you can add this plugin-HTML widget by following the instructions found in the 2.12.5 Release Guide. |
| Info |
|---|
NOTE: Make sure that the Voucher Banner Plugin HTML Widget is installed, the vouchersettings.showbanner setting is configured, and the banner Language Strings are configured. See above in the Settings, Language Strings, and HTML Widgets section for details on these items. |
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
...
| Table of Contents |
|---|
Setup Checklist
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
1. POS Tasks | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RTP|One only
|
| ||||||||||||||||||||||||
2. Aspenware Commerce Tasks | |||||||||||||||||||||||||
1. Install Voucher Plugin
2. Configure Language Strings, Settings, and HTML widgets -
|
| ||||||||||||||||||||||||
1. Enable Print/View Vouchers in My Account
2. Set Up the Voucher Product
3. Configure Email Voucher Template
|
|
Prerequisite Tasks
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
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).
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.
| Info |
|---|
NOTE: If the voucher toolbar is missing, you can add this plugin-HTML widget by following the instructions found in the 2.12.5 Release Guide. |
| Info |
|---|
NOTE: Make sure that the Voucher Banner Plugin HTML Widget is installed, the vouchersettings.showbanner setting is configured, and the banner Language Strings are configured. See above in the Settings, Language Strings, and HTML Widgets section for details on these items. |
Settings, Language Strings and/or HTML Widgets for this Feature
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
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. Use the tables below to view and modify string resources and values by 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.
Voucher Banner Language Strings
Update these strings to configure the voucher banner title separate from the content text:
Description | Language String Resource | Default Value (Can be Customized) | 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. |
Page Banner Input Box | voucher.plugin.input.text | YOUR VOUCHER NUMBER | Inside text entry box in banner |
Voucher Validation Popup Language Strings
Update these strings to configure the voucher banner title separate from the content text:
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 NUMBERPlacement | ||
Voucher Popup | voucher.plugin.modalheader.text | Voucher Validation | Title of voucher popup | |
Voucher Popup | voucher.plugin.validationwait.text | Please wait while we validate your voucher ID. | Appears within popup if validation is not immediate. | |
Voucher Popup | voucher.plugin.validationsuccess.text | Voucher ID successfully verified. Click redeem to continue. | Appears within popup once voucher ID successfully verified. | |
Voucher Popup | voucher.plugin.invalidcode.text | Voucher ID is invalid. | Appears within popup if ID is invalid or other error occurs. | |
Voucher Popup | voucher.plugin.continuebutton.text | Redeem | Appears within popup - button | |
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 | Okbutton.label | CONFIRM VALUE | Appears within banner- button |
My Vouchers Language Strings
Update these strings to configure My Vouchers:
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) |
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 |
HTML Widgets
1. Voucher Banner Plugin HTML Widget
...
| Info |
|---|
NOTE: Once installed and made visible, administrators can enable and disable the banner via the voucher banner settings in “All Settings,” |
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.
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):
...
Enable Print/View Vouchers from My Account
Set Up the Voucher Product
Configure Email Voucher Template
1. Enable Print/View Vouchers from My Account
...
| Info |
|---|
NOTE: In order for vouchers from RTP|One to show in My Account, they must have a Report defined on the voucher type. |
Go to Configuration > Settings > All Settings (advanced) and search for the setting customersettings.hideprintvoucherstab in the name field.
Edit the setting, and change the Value to 'False; to enable Print/View Vouchers in My Account.
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.
...
| Info |
|---|
NOTE: Make sure you have retrieved the appropriate product voucher template ID from RTP|One (this should not be included on any other 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.
...
3. Configure Email Voucher
...
Template
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
Go to “Source Tools”
Find the text below and replace the [INSERT URL TO LOGO HERE] with your store’s logo image url
Adjust width and height as necessary
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" />
...