•admission_source_best_available
•order_with_payment_source_file
•miscellaneousItems_source_file
•Creating and Executing the Data Management Job
•Data Management Configuration
Summary
Script Name |
Order Load |
Minimum Supported Version |
7.8.0 7.12.0 - Updated 7.16.0 - Job Crieria section added, script definitions consolidated, admission_source_file split into two source files 7.26.0 - Bundles |
Source Type |
Multiple Source |
Script Definitions |
As of 7.16.0: •Order Load Prior to 7.16.0: •Order Load: Using order, admission and payment source files •Order Load: Using order, admission, miscellaneous items, gifts, stored value items, order marketing and payment source files •Order Load: Using order, gifts and payment source files •Order Load: Using order, miscellaneous items and payment source files •Order Load: Using Order, stored value items and payments source files •Order Load: Using order (including payments) and admission source files •Order Load: Using order (including payments) and gifts source files •Order Load: Using order (including payments) and miscellaneous items source files •Order Load: Using order (including payments) and stored value items source files |
Use Case
The Order Load script is used to load order data maintaining their associated line items (admissions, miscellaneous items, stored value items, gifts), payments and marketing data.
Configuration Prerequisites
If fields referenced in the script do not have 'Writable' set to Yes, the script will still run successfully but those fields will not be updated. For more information, refer to Configuring Marketing Data Fields.
Source File Format
This script can be run by using multiple source files .CSV or BI (saved as a text/csv 'Extract Tempate') source files.
The following source files are used with the Order Load script:
1.admission_source_file (Prior to 7.16.0)
2.admission_source_by_seat (as of 7.16.0, split from admission_source_file)
3.admission_source_best_available (as of 7.16.0, split from admission_source_file)
6.order_with_payments_source_file
7.miscellaneousItems_source_file
10.storedValueItems_source_file
admission_source_by_seat
The following image illustrates the structure required for the admission_source_by_seat source file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
admission_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
3 |
No Unless adding a bundle. |
bundle_name |
Bundle Name |
Customer Services - Order|Summary page |
4 |
No Unless the event exists in more than one element on the bundle. |
element_name |
Element Name |
Customer Services - Order|Summary page |
5 |
Yes |
performance_name |
Event Code |
Customer Services - Order|Summary page |
6 |
Yes |
section |
Section |
Customer Services - Order|Summary page |
7 |
Yes |
row |
Row |
Customer Services - Order|Summary page |
8 |
Yes |
seat |
Seat |
Customer Services - Order|Summary page |
9 |
No |
price |
Amount |
Customer Services - Order|Summary page |
10 |
No |
price_type_name |
Price Type ID |
Customer Services - Order|Summary page |
admission_source_best_available
The following image illustrates the structure required for the admission_source_best_available source file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
admission_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
3 |
No Unless adding a bundle. |
bundle_name |
Bundle Name |
Customer Services - Order|Summary page |
4 |
No Unless the event exists in more than one element on the bundle. |
element_name |
Element Name |
Customer Services - Order|Summary page |
5 |
Yes |
performance_name |
Event Code |
Customer Services - Order|Summary page |
6 |
Yes |
quantity |
Show number of admissions based on quantity |
Customer Services - Order|Summary page |
7 |
No |
price_zone_name |
Price Zone |
Customer Services - Order|Summary page |
8 |
Yes |
section |
Section |
Customer Services - Order|Summary page |
9 |
No |
price |
Amount |
Customer Services - Order|Summary page |
10 |
No |
price_type_name |
Price Type ID |
Customer Services - Order|Summary page |
payment_source_file
The following image illustrates the structure required for the payment_source_file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
payment_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
3 |
No |
payment_method |
Payment Method (assumes that the payment method is local) |
Customer Services - Order|Summary page |
4 |
No |
transaction_amount Setting this to -ve will add the payment as a refund. |
Payment |
Customer Services - Order|Summary page |
5 |
No |
memo |
Memo |
Payments pop-up Customer Services - Order|Summary page |
order_source_file
The following image illustrates the structure required for the order_source_file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes (This can be blank, but if the field is required in the Registry, and it's left blank in the source file, an error will occur) |
customer |
Customer |
Customer Services - Order|Summary page |
3 |
No |
delivery_method |
Selected Delivery Method |
Customer Services - Order|Summary page |
order_with_payment_source_file
|
Upload a order_with_payment_source_file using the 'order_source_file' data source. |
The following image illustrates the structure required for the order_with_payment_source_file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes (can be blank) |
customer |
Customer Number |
Customer Services - Order|Summary page |
3 |
No |
create_date |
Created On |
Customer Services - Order|Summary page |
4 |
Yes |
delivery_method |
Selected Delivery Method |
Customer Services - Order|Summary page |
5 |
No |
payment_method |
Payment Method (assumes that the payment method is local) |
Customer Services - Order|Summary page |
6 |
No |
transaction_amount Setting this to -ve will add the payment as a refund. |
Payment |
Customer Services - Order|Summary page |
7 |
No |
memo |
Memo |
Customer Services - Order|Summary page |
miscellaneousItems_source_file
The following image illustrates the structure required for the miscellaneousItems_source_file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
miscItems_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
3 |
Yes |
item |
Miscellaneous Item |
Customer Services - Order|Summary page |
4 |
No unless adding a bundle |
bundle_name |
Bundle Name |
Customer Services - Order|Summary page |
5 |
No |
option |
Option |
Customer Services - Order|Summary page |
6 |
Yes |
quantity |
Quantity |
Customer Services - Order|Summary page |
7 |
No |
price |
Unit Amount |
Customer Services - Order|Summary page |
marketing_source_file
The following image illustrates the structure required for the marketing_source_file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
marketing_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
3 |
No |
data1 |
Marketing Data 1 |
Customer Services - Order|Summary page |
|
Information Additional 'Marketing Data' fields can be are provided in marketing_source_files. They should be made 'Readable' and 'Writeable' through the Registry or by overwriting permissions before the job is executed. For more information, refer to Configuring Marketing Data Fields. |
gifts_source_file
The following image illustrates the structure required for the gifts_source_file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
gift_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
3 |
No unless adding a bundle |
bundle_name |
Bundle Name |
Customer Services - Order|Summary page |
4 |
Yes |
gift_name |
Gift |
Customer Services - Order|Summary page |
5 |
Yes |
fund_name |
Fund Name |
Customer Services - Order|Summary page |
6 |
Yes |
appeal_name |
Appeal |
Customer Services - Order|Summary page |
7 |
Yes |
pledge_amount |
Pledge Amount |
Customer Services - Order|Summary page |
8 |
Yes |
pledge_date |
Pledge Date |
Customer Services - Order|Summary page |
storedValueItems_source_file
The following image illustrates the structure required for the storedValueItems_source_file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
order_reference_key |
N/A - Uniquely identifies each record |
N/A |
2 |
Yes (can be blank) |
customer |
Customer Number |
Customer Services - Order|Summary page |
3 |
No |
delivery_method |
Selected Delivery Method |
Customer Services - Order|Summary page |
4 |
No |
payment_method |
Payment Method (assumes that the payment method is local) |
Customer Services - Order|Summary page |
5 |
No |
transaction_amount |
Payments |
Customer Services - Order|Summary page |
How the Script Works
The following table outlines the actions and expected results of the script:
Condition |
Action |
Expected Results |
The order_reference_key must have a value that can be referred by other line items (gift_reference_key or marketing_reference_key) to create an order. |
The order_reference_key looks for a corresponding reference_key from other source files which should match the order_reference_key to create an order with information linked in all source files based on this key.
|
The order record will be created with all of the information provided in all of the source files that are linked with the order_source_file by the order_reference_key. |
Each order should have at least one line item (admissions, gifts, stored value items). |
Script looks for each order linked to any line item based on the script description used. If all of the required fields are not completed an error will occur. |
A new order with the line item is created. |
To avoid error messages if a payment record is missing from an order 'Default Unpaid Reason' in Registry. For more information, refer to Unpaid Reasons. |
If the a default 'Unpaid Reason' is not set then an error message will appear. |
An unpaid order is created if a default 'Unpaid Reason' is set. |
All fields set as 'Required' Yes in the Registry must have values in the source files. |
Script checked if all of the required files are received from the source data. |
If any fields that are set as 'Required' Yes in the Registry and are not supplied in the source data, the script will fail. |
The script can also add bundles to the orders (optional) along with single line items if bundle_name is not blank. |
For bundles with reserved seats, general admission seats will be added with the provided row and seat or quantity respectively, for the provided event. Miscellaneous items and gifts can be added as part of a bundle. |
Admissions, miscellaneous items and gifts will be added as a part of a bundle when bundle_name is provided. Stored value items are added directly from the bundle configuration without providing any information in source file. |
Creating and Executing the Data Management Job
Script Definition Configuration
The following tables outline the script definition configuration:
Script Definition Name: Order Load: Using order, admission and payment source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
admission_source_file |
Comma Separated Values |
admission_reference_key |
order_source_file |
order_reference_key |
payment_source_file |
Comma Separated Values |
payment_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using order, gifts and payment source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
gifts_source_file |
Comma Separated Values |
gift_reference_key |
order_source_file |
order_reference_key |
payment_source_file |
Comma Separated Values |
payment_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using order, miscellaneous items and payment source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
miscellaneousItems_source_file |
Comma Separated Values |
miscItems_reference_key |
order_source_file |
order_reference_key |
payment_source_file |
Comma Separated Values |
payment_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using Order, stored value items and payments source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
storedValueItems_source_file |
Comma Separated Values |
storedValueItem_reference_key |
order_source_file |
order_reference_key |
payment_source_file |
Comma Separated Values |
payment_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using order, admission, miscellaneous items, gifts, stored value items, order marketing and payment source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
storedValueItems_source_file |
Comma Separated Values |
storedValueItem_reference_key |
order_source_file |
order_reference_key |
payment_source_file |
Comma Separated Values |
payment_reference_key |
order_source_file |
order_reference_key |
miscellaneousItems_source_file |
Comma Separated Values |
miscItems_reference_key |
order_source_file |
order_reference_key |
admission_source_file |
Comma Separated Values |
admission_reference_key |
order_source_file |
order_reference_key |
gifts_source_file |
Comma Separated Values |
gift_reference_key |
order_source_file |
order_reference_key |
marketing_source_file |
Comma Separated Values |
marketing_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using order (including payments) and admission source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
admission_source_file |
Comma Separated Values |
admission_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using order (including payments) and gifts source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
gifts_source_file |
Comma Separated Values |
gift_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using order (including payments) and miscellaneous items source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
miscellaneousItems_source_file |
Comma Separated Values |
miscItems_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Script Definition Name: Order Load: Using order (including payments) and stored value items source files
Application Script: Order Load (text/plain)
Source Section |
||||
Source Name |
Source Type |
Source Key Column |
Parent Source Name |
Parent Key Column |
order_source_file |
Comma Separated Values |
order_reference_key |
Blank |
Blank |
storedValueItems_source_file |
Comma Separated Values |
storedValueItems_reference_key |
order_source_file |
order_reference_key |
Execution Fields |
|||||||
Name |
Label |
Field Type |
Type |
Max # Values |
Default Value |
Order |
Display on New Row / Required |
customer_identifier |
Customer Identifier |
Standard |
string |
1 |
customer |
10 |
Yes / No |
Data Management Configuration
The following outlines the data management job configuration:
•Data Management Job Name: Order Load with All Item Source Files (for example)
•Script Definition: Order Load: Using order, admission, miscellaneous items, gifts, stored value items, order marketing and payment source files
Job Criteria Section |
|
Field |
Field Value |
Customer Identifier |
Any value from the customer identifiers list can be used, based on the values in the source file to identify a customer uniquely. The default value is set to Customer Number. |
Other data management jobs can be created using different combinations of source files based on the available script definitions.
The following image is an example of the Data Management|Schedule page when creating a job using all of the available source files:
