| Table of Contents |
|---|
Setup Checklist
...
1. POS Tasks
RTP|One only
...
| 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 -
3. Set discount.
Status | | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| colour | Red | title | required1. Install Voucher Plugin
2. Configure Language Strings, Settings, and HTML widgets -
| 2. Aspenware Commerce Tasks |
| |||||||||||||||||||||||||||||||||||||||||||||||||||
1. Enable Print/View Vouchers in My Account 3. Set discount.
1. Enable Print/View Vouchers in My Account
2. Set Up the Voucher Product
3. Configure Email Voucher Template
Go to Content Management > Message Templates Search for “Vouchers.EmailVoucher” Select Edit Go to “Source Tools” 2. Set Up the Voucher Product
|
|
3. Configure Email Voucher Template
4. Add Voucher Requirement (For Product/Discount Voucher ONLY)
5. (Optional) Limit Discount Application (For Product/Discount Voucher ONLY)
|
|
...
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. |
...
2. Set Discount (If creating a discount voucher)
In Aspenware Commerce Administration go to Promotions > Discounts
Select Add New.
Set up your discount according to setup documentation including the appropriate discount amount/percentage
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. |
| Info |
|---|
NOTE: 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. |
...
Settings, Language Strings and/or HTML Widgets for this Feature
...
For discounts, cache product prices must be unchecked. This setting can be found in Settings > Catalog Settings.
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.
...
| 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):
...
| 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.
...
2. Set Up the Voucher Product
| 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" />
4. If Product/Discount Voucher - Add the voucher requirement
Once you have your discount preliminarily set up you will need to add the voucher requirement and the voucher template ID for the selected voucher product.
...
Go to Promotions > Discounts > Edit the desired discount.
...
Once entered you will see the text field to enter the voucher template ID
...
Enter the ‘voucher template ID’ from RTP|One from which the voucher codes will be issued
| Note |
|---|
IMPORTANT: This is the same voucher template ID as has been applied to your product in the product catalog |
Assign the product to the discount (you may only assign one product to this discount
| Info |
|---|
NOTE: While you may only assign one product to your discount when setting up product-discount vouchers, attribute combinations may result in the discount being applied to different SKUs and prices e.g. child vs. adult lift ticket |
Click Save
...
.
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.
...
2. Set Up the Voucher Product
| 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" />
4. Add Voucher Requirement (For Product/Discount Voucher ONLY)
Once you have your discount preliminarily set up you will need to add the voucher requirement and the voucher template ID for the selected voucher product.
Go to Promotions > Discounts > Edit the desired discount.
From the Discount requirement type field, select ‘Vouchers’
Once entered you will see the text field to enter the voucher template ID
Enter the ‘voucher template ID’ from RTP|One from which the voucher codes will be issued.
| Note |
|---|
IMPORTANT: This is the same voucher template ID as has been applied to your product in the product catalog. |
Assign the product to the discount (you may only assign one product to this discount
| Info |
|---|
NOTE: While you may only assign one product to your discount when setting up product-discount vouchers, attribute combinations may result in the discount being applied to different SKUs and prices e.g. child vs. adult lift ticket |
Click Save
...
5. (Optional) Limit Discount Application (For Product/Discount Voucher ONLY)
To prevent a discount from being applied to more than one eligible item in the cart another requirement must be added to the product.
| Info |
|---|
NOTE: When this restriction is in place, the guest will only be able to add 1 of the eligible items to their cart. If another of the same item is added, the discount will be removed altogether. |
Go to Promotions > Discounts, select the discount, and click Edit to update the desired discount.
On the Edit discount details page, scroll down to Requirements and select ‘cart must contain a certain amount of products’from the discount requirement type dropdown.
Set Maximum Quantity = 1 and Minimum Quantity = 1
Click Add Product
Add the appropriate products to which the discount voucher and the discount applies.
Click Save.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...