Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

  • Configure Product Header Codes or DCIs for scanning by native POS scanners. REQUIRED

    1. For Siriusware, set up the product as a “Regular Item” that creates an access record.

    2. For RTP|One, set up the Product Header as an access product.

PREREQUISITE

2. Infrastructure Tasks

  • Ensure scanners are configured for both test and production and test this functionality end to end. REQUIRED

PREREQUISITE

3. Commerce Tasks

  • Assign ‘Send Print-at-Home Notification’ product classification to the product. REQUIRED

  • Configure the ‘OrderPlaced.PrintAtHomeCustomerNotification’ email template through Content Management>Message Templates. REQUIRED

PREREQUISITE

  • Configure 'ordersettings.orderidprefix.' The value here must match the value that is configured for the Order Processor Order ID. REQUIRED

  • SIRIUSWARE ONLY: Set "OrderProcessing.SendExternalPrintAtHomeNotification" to TRUE REQUIRED

PREREQUISITE

  • Assign Print at Home Notification to product. REQUIRED

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

  • Configure the Product Header Codes(s) or DCI in your resort POS according to the rules that make this product eligible for scanning by the native POS scanners.

    1. In Siriusware consider setting up your item as a ‘Regular Item’ that ‘creates an Access record,' like the example below.

NOTE: Any Siriusware product sold as “Print At Home” must be correctly configured as a “validation” product, rather than a “redemption” product**. In other words, the QR code generated by the Siriusware product should be configured in such a way that it will scan on a Siriusware-programmed hand scanner, and validate appropriately in the Siriusware system. The Configuration below manages the process by which the code generated by Siriusware is converted to a readable QR Code, and delivered to the guest. Little validation or configuration of the product is discussed in this guide, as that happens in Siriusware

(**Validation vs. Redemption: A validation product allows the guest access to a gate, venue, lane, etc. when they present their QR code for scanning. A redemption product requires the guest to present their code and receive a separate piece of media – lift ticket, RFID Card, etc. to gain access.)

  • Step for Siriusware resorts to kick off the SW Web Host so that orders to ensure a “sales number” in SW is completed - this is required to get the order into a state where it will send the follow up email. Irish Milandin can provide some help with these exact steps

  • Any RTP|One Product Header sold as “Print At Home” must be correctly configured with a product component that is set up as an access product, like the example below.

NOTE: When configured in Commerce, this functionality is only able to display the access product as a QR code and cannot currently display other values from RTP|One as QR codes.

Infrastructure Tasks

  • Ensure your scanners are configured for both test and production Siriusware or RTP|One to test this functionality end to end.

  • See comment above as we’ll need to add some kind of function check. This may only be true for SW resorts. Irish Milandin will know.

Commerce Tasks

  • There is a new product classification called ‘Send Print-at-Home Notification’. When assigned to a product, this is meant to trigger sending a follow-up email if the product is purchased with a QR code for the Axess Code of the Ticket. This uses a new OrderPlaced.PrintAtHomeCustomerNotification message template that includes a %Order.Barcodes% message token. If you wish to use print at home functionality, contact your Aspenware representative to ensure these items are all in place for your test and production sites.

  • To configure the print at home email template go to Content Management>Message Templates and Edit to edit the ‘OrderPlaced.PrintAtHomeCustomerNotification’ email template. 

    • To edit the email HTML, go to Tools>Source Code and adjust the HTML from there in the Source code window. In the body portion of the email template, paste the following code and customize as desired. Do not remove the %Order.Barcodes% message token.

      <p style="margin: 0;">Hello %Order.CustomerFullName%,</p>
      
      <p>Below is the voucher for your RESORT ticket.</p>
      
      <p>Add details on redemption.</p>
      
      <div class="”block”" style="text-align: center;">%Order.Barcodes%</div>
      
      <p>Order Number: PK%Order.OrderNumber% <br /> Date Ordered: %Order.CreatedOn% <br /><br /> %Order.Product(s)%<br /> <br /> Terms of print at home tickets here.</p>
      
      </td>
      
  • Additional styling can be applied to information within the %Order.Barcodes% table using email CSS, using the following div classes.

  • For more details on email configuration, refer to https://hub.aspenware.net/main/Configuration:-Emails.1251868693.html

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

  • Go to Configuration > Settings > All Settings and search for 'ordersettings.orderidprefix.' The value here must match the value that is configured for the Order Processor Order ID. Ask your Aspenware Representative what your Order Processor Order ID is if you are unsure.

  • SIRIUSWARE ONLY: In Aspenware Commerce, under Configuration> Settings> All Settings, locate  "OrderProcessing.SendExternalPrintAtHomeNotification"

    1. If this is set and the value is TRUE, then the print at home email will be sent from the Status function and not the Order Processor. This should be true for Siriusware resorts.

IMPORTANT: The OrderProcessing.SendExternalPrintAtHomeNotification setting is a Siriusware only setting, and it should not be set or it should be FALSE for RTP|One resorts.

EXPLANATION:

Current print at home functionality works by the order processor calling an endpoint "api/orderprocessing/ordercleanup/{orderId:int}" which checks reservations for a print a home classification and sends accordingly.

For Siriusware this will not work because when the order processor runs, Siriusware hasn't finished processing the order on its end and we do not yet have a "sale_no" which is required to generate the print at home email. To get around this issue the Status Function calls a new endpoint named "api/orderprocessing/sendprintathomenotification/{orderId:int}" that will send the email using the now ready "sale_no." There is a new setting that needs to be set to TRUE for Siriusware environments so that the order processor doesn't attempt to send these emails, since the "sale_no" isn't available at that time. This setting is called OrderProcessing.SendExternalPrintAtHomeNotification and will be defaulted to FALSE.

Detailed Setup Guide

1. Assign Send Print at Home Notification

  • From Plugins>Product Classifications>Add Assignment, select the desired category and product.

  • If print at home functionality is only desired for a particular attribute combination, check the desired product attribute values that are associated to print at home products. If the entire product should be set up as a Print-at-Home product, do not check any of the attribute options.

NOTE: The Print at Home Classification may need to be turned on by your Aspenware representative. 

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.


  • No labels