Versions Compared

Old Version 4

changes.mady.by.user Jenni Buonanni

Saved on

compared with

New Version 5

changes.mady.by.user Sarah Holst

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
Tip

This feature is supported for: Print at home functionality is now supported for resorts that use either RTP|One or Siriusware as a POS, however this guide is specific to Siriusware print at home enhancements.

This guide will review how to set up Print at Home functionality for Siriusware in Aspenware Commerce. For more information on general release notes, see 2.21 Release Notes.

...

Print at Home functionality is now available for resorts that use Siriusware as POS. This feature was previously only supported for RTP|One.

When a customer purchases a product flagged as a Print-at-Home product, they are immediately sent a separate email that contains access barcodes for each “print at home” product in their order. These barcodes can be used by standard RTP|One or Siriusware scanners for access. Proper POS configuration is required for this feature to work in either RTP|One or Siriusware to grant the guest the correct access type when purchasing the product. Details on these pre-requisite steps are outlined in the configuration notesguide below.

...

Configuration Guide

Prerequisite Steps

...

Configure the product header or DCI in your resort POS according to the rules that make this product eligible for scanning by the native POS scanners.

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

Info

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

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

Info

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.

...

  • In addition to product setup , and your POS environments for test and production,  make make sure your scanners are configured for both test and prod SW production Siriusware to test this functionality end to end.

...

  • There is a new product classification called Send ‘Send Print-at-Home NotificationNotification’. 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’ 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.

      Code Block
      <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>

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

Detailed Configuration Guide

  • 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 setup set up as a Print-at-Home product, do not check any of the attribute options.

...

  • In the Classification table, click the Assign checkbox for the Send Print at Home Notification classification.

  • Click Add.

  • Make sure you have your product set to be auto fulfilled in the Aspenware Commerce using the Autofulfill guide.  

  • 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 OrderID Order ID is if you are unsure.

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

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

Note

IMPORTANT: This is a Siriusware only setting, and it should not be set or it should be false 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 SW Siriusware this will not work because when the order processor runs SW , Siriusware hasn't finished processing the order on their its end and we do not yet have a "sale_no" yet 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 TRUE for SW 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 falseFALSE.