Setup Checklist
This section is a comprehensive and high level summary of all tasks and prerequisites required for this feature to function properly. This section is purposed for use after an administrator is familiar with configuring this feature as an “audit” checklist. For detailed set-up instructions, jump down to “Prerequisite Tasks” and “Detailed Setup Guide” and then follow up with this checklist to ensure all steps are completed.
1. POS TASKS | |
---|---|
| PREREQUISITE |
2. INFRASTRUCTURE TASKS | |
Infrastructure Task 2 - REQUIRED | PREREQUISITE |
3. COMMERCE TASKS | |
Commerce Task 3 - REQUIRED | PREREQUISITE |
Language String, Setting, HTML widget, etc. Task 4 - OPTIONAL | PREREQUISITE |
1. Update Email Template Content OPTIONAL
2. Add Barcode or QR Code to Order Confirmation Emails OPTIONAL
3. Configure Print-at-Home Email Functionality OPTIONAL
| DETAILED SETUP |
Prerequisite Tasks
This section describes all requirements that must be completed before you can begin setting up this feature. Once these tasks are complete continue to the next section.
POS Tasks
Ensure that products set up for print-at-home in RTP|One are set up to generate an Access code. An Access code must be generated so that the correct data needed for email sending will be generated.
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
This feature may require updates to the following settings, language strings and/or HTML Widgets. Learn more about how to update and create Settings, Language Strings, and HTML widgets follow the links to the respective section.
Settings
AW Commerce Settings that must first be completed
Language Strings
AW Commerce Language Strings that must first be completed
HTML Widgets
AW Commerce HTML Widgets that must first be completed
Detailed Setup Guide
The following emails are sent from the ecommerce store: Order confirmations, Password Reset emails, and Find Me by Email Verification Code. The mechanism for sending emails depends on resort-specific setup and may include a 3rd party vendor API, SMTP servers, or utilizing SendGrid’s API. This section covers editing the text of these three email templates and changing or setting up the method for sending emails.
Update Email Template Content
Add Barcode or QR Code to Order Confirmation Emails
Configure Print-at-Home Email Functionality
1. Update Email Template Content
Email templates can be modified using nopCommerce Message templates. The confirmation email details typically include the long descriptions of products included in the customer’s order. To update any of the email templates, follow the steps below.
Go to Content Management > Message Templates page.
Search for the message template by scrolling through the list (it’s in alphabetic order.)
Click Edit to update the desired active email templates to open the Edit message template details page. (Active templates are indicated by a blue checkmark in the Is Active column.)
The following elements are configurable:
Subject: Enter the subject line for the email
Body: Enter the contents of the email
All of the templates have some dynamic content based on the customer and/or order information. The dynamic content in each email template is included in the table below.
To edit the email HTML, go to Tools > Source Code and adjust the HTML from there in the Source code window.
There are six email templates that are active, detailed in the following table.
Message template name | Email type | Dynamic elements |
---|---|---|
Customer.PasswordRecovery | Password Reset Email Sent when customer selects to receive a forgot password email. | %Store.Name% - The store’s Name Configured in Store Settings |
Customer.SendFindAccountResetPassword | Password Reset Email Sent when customer attempts to find their account but already has an active authentication profile with the designated information. | %Store.Name% - The store’s Name Configured in Store Settings |
Customer.SendVerificationCodeForEmail | Find Me by Email Verification Code Sent when a customer enters an email address in Find me by email form and the information matches a customer record in RTP. This email sends a code that verifies the email address so the user can create an account tied to the RTP record. | %Code% - A unique code to be used in Find Me by Email Verification Code to associate a new account to the account in RTP. |
Customer.UsernameRecovery | Username Verification Sent when a customer enters their email to retrieve their username. Must use the email associated to the account with their authentication profile. | %Customer.Username% - The customer’s username that is associated to the email they entered. |
OrderPlaced.CustomerNotification | Order Confirmation Sent when a customer successfully completes an order. Contains information on the purchased products, order details, and any additional order or pickup information included in the message template. | %Store.Name% - The store’s Name Configured in Store Settings %Order.CustomerFullName% - The full name of the customer who placed the order %Order.OrderNumber% - The nopCommerce order number. The resort’s initials are appended to the front of the order number to match the alternate order ID created in RTP. %Order.CreatedOn% - The order creation date %Order.Product(s)% - A table of the products ordered, including add-ons, quantities, and prices
|
Customer.FailedSubscriptionPayment | Sent when monthly subscription charge fails, prompting guest to update their email in my account. | Link to my account to update subscription credit card %Store.URL%/customer/customersubscriptions#/ |
2. Add Barcode or QR Code to Order Confirmation Emails
Order confirmation emails have the ability to include a barcode or QR code with the external order ID, which makes looking up orders easy for front-line staff. This barcode or QR code is the same ID that is already displayed on the order confirmation email, usually your prefix + the nop order ID (e.g. PK12345, in barcode or QR code form.)
Go to Content Management > Message Templates page,
Search for the OrderPlaced.CustomerNotification email template by scrolling through the list (it’s in alphabetic order.)
Click Edit.
In Body, go to Tools > Source Code and adjust the HTML from there in the Source code window.
Paste the code below into your HTML in the appropriate place. The order prefix is highlighted in blue below should be updated to your order prefix.
If the barcode should go at the end of the email, paste the code after %Order.Products%
If the barcode should be placed at the beginning of the email, place the code before the Billing Address portion of the body.
For BARCODE FORMAT: <center><a href="https://barcode.tec-it.com/barcode.ashx?data=[PREFIX]%Order.OrderNumber%&code=Code128&multiplebarcodes=false&translate-esc=false&unit=Fit&dpi=96&imagetype=Gif&rotation=0&color=%23000000&bgcolor=%23ffffff&qunit=Mm&quiet=0"> <img src="https://barcode.tec-it.com/barcode.ashx?data=[PREFIX]%Order.OrderNumber%&code=Code128&multiplebarcodes=false&translate-esc=false&unit=Fit&dpi=96&imagetype=Gif&rotation=0&color=%23000000&bgcolor=%23ffffff&qunit=Mm&quiet=0" style="margin-top: 5px; width: 150px; height: 150px; margin-left: 5px; margin-bottom: 5px; border: 7px solid #fff;" /> </a></center> |
---|
For QR CODE FORMAT: <center><a href="https://chart.googleapis.com/chart?chs=300x300&cht=qr&chl=[PREFIX]%Order.OrderNumber%"><img src="https://chart.googleapis.com/chart?chs=200x200&cht=qr&chl=[PREFIX]%Order.OrderNumber%" border="0" style="margin-top: 5px; width: 150px; height: 150px; margin-left: 5px; margin-bottom: 5px; border: 7px solid #fff" /></center> |
3. Configure Print-at-Home Email Functionality
If a customer checks out with a product set up for print-at-home functionality, they will be emailed a QR code that can be used as their ticket on site. This functionality should NOT be set up on Reload product variants. It should only be set up for product variants offering new media or no media.
NOTE: The Print-at-Home Classification may need to be turned on by your Aspenware Representative.
IMPORTANT: Keep in mind products setup for print-at-home in RTP|One must be set up to generate an Access code because the Access code is sent via the email as a barcode. An Access code must be generated so that the correct data needed for email sending will be generated.
Go to Aspenware Commerce > Product Classifications
Click Add Assignment.
Select the Category containing the product requiring print at home from the drop-down.
Select the desired Product from the Product dropdown.
If print-at-home functionality is only possible for a particular attribute combination, check the desired product attribute values on the Product Classification Assignment page that are associated with print-at-home products. For example, if setting up a ticket product, only new media tickets should be enabled for print-at-home, not reload, so the add new media attribute value should be checked, see example below.
Scroll down to the Classification table and click the Assign checkbox for the ‘Send Print at Home Notification’ classification.
Click Add.
Like this page? Click the like button below. Don't like this page and/or want to give feedback about this page, leave a comment below and Aspenware will address to improve this article.