•Data Management Configuration
Summary
Script Name |
Order Price Type Update and Add Payment |
|
Minimum Supported Version |
7.19.0 7.28.0 - name change from Order Update to Order Price Type Update and Add Payment |
|
Source Type |
Single Source |
|
Script Definitions |
Order Price Type Update and Add Payment |
|
Use Case
The Order Price Type Update and Add Payment script updates the price type of existing admissions and balances the payments based on the criteria defined in the script job.
|
Information When you change the price type on a printed admission, the ticket/barcode is automatically canceled and a new ticket is created.
When tickets are a cancelled a 'Cancel Reason' is required. Set a 'Default Value' on the group running the This needs to be set on the Application Security - Group|Attributes page using: •Attribute: TSorderBO. •Attribute Name: Order: Cancel Reason. •Default Value: Ticket Reprint (or something similar). |
|
Information If the order uses the Email delivery method, the new tickets are sent immediately and without any explanation as to why they have been issued. |
Configuration Prerequisites
The following table lists the warning messages that need to be suppressed for the role running the data management job:
Warning Message Number |
Warning Message Text |
4224 |
There is still a balance due on this order. Continue? |
5008 |
This order is overpaid. Continue? |
Source File Format
This script is run using a single .CSV or BI (saved as a text/csv 'Extract Tempate') source file.
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
Order Number |
Order Number |
Customer Services - Order|Summary page |
How the Script Works
The following table outlines the business logic implemented by the script:
Condition |
Action |
Expected Results |
If only Update Price Type is selected from the 'Options' field, the script will only update the admission price types that belong to the events selected in the 'Events' execution field. In this case, 'Events' should be required. Since this can leave orders unpaid or underpaid, to update orders successfully select an 'Unpaid Reason' in the script job. |
The admissions with the existing 'Source Price Type' will be updated with the 'Target Price Type' for the selected in 'Events'. |
All of the orders returned by the Order Price Type Update and Add Payment BI that have admissions matching the 'Source Price Type' and belonging to the selected 'Events', will be updated to the respective 'Target Price Type'. If any order is unpaid or underpaid, it will be updated with the 'Unpaid Reason' selected in the script job. |
If only Add Balance Payment is selected from the 'Options' field, then the script will only balance the payments on the orders. In this case, a 'Payment Method' should be supplied or the script will fail with the following error message, Please select a payment method in script job to balance the payments. |
The script will update all of the orders returned by the Order Price Type Update and Add Payment BI query based on the selected 'Payment Method' to balance the payments. |
All of the orders returned by the Order Price Type Update and Add Payment BI query will be checked. If they are not balanced (due amount is not 0) then, underpaid and overpaid orders will be balanced by adding a sale payment or refund payment equivalent to amount due using the 'Payment Method' selected in the script job. |
If both Update Price Type and Balance Payment are selected from the 'Options' field, then the script will update the price type as well as balance all of the orders that are left unbalanced after having their price type changed. •'Events' is required. •'Payment Method' is required. |
Based on the values in the 'Source Price Type' and 'Target Price Type' dropdowns, the admissions with the existing 'Source Price Type' will be update to the 'Target Price Type' that satisfies the selected 'Events'. Only the orders left unbalanced after having price type changed will have their balances updated. |
All of the orders returned by Order Price Type Update and Add Payment BI query that have admissions that belong to any of the selected in 'Events' and have the same price type as any of selected 'Source Price Type' will be updated to its respective 'Target Price Type'. If a successfully updated order is left unbalanced, then a payment of sale or refund is added, using the 'Payment Method' provided in Script Job. |
Data Management Configuration
The following outlines the data management job configuration:
•Data Management Job Name: Order Price Type Update and Add Payment
•Script Definition: Order Price Type Update and Add Payment (text/html)
Job Criteria Section |
|
Field |
Field Value |
Options |
Add Balancing Payment and/or Update Price Types |
Events |
The name of the event(s). Click |
Payment Method |
The payment method you want to use to update balances from the 'Payment Method Name' dropdown. |
Unpaid Reason |
The unpaid reason that will be used if orders do not balance. |
Source Price Type |
The price type that you want to update. |
Target Price Type |
the price type that you want to update the 'Source Price Type' with. |
|
Information Because the orders returned by the BI are the primary records, the 'Successful Rows' value on the Data Management|Results page will indicate the total number of orders returned regardless of whether or not the orders were updated. |
The following image is an example of the Data Management|Schedule page when creating a job using all of the available source files:
