•Data Management Configuration
Summary
Script Name |
Order Update The previous Order Update script has been renamed Order Price Type Update and Add Payment |
|
Minimum Supported Version |
7.28.0 |
|
Source Type |
Single Source |
|
Script Definitions |
Order Update |
|
Use Case
The Order Update script identifies orders to be updated based on the chosen identifier (execution field) and the values provided in the source file. The script updates all marketing primitives and some primitives on the order node in addition to updating comments on the order.
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.
Field Name |
Registry Location |
Field Configuration |
data[1-50] currency[1-10] date[1-10] fixed[1-10] |
Registry::EN::Business Objects:: TSorderBO::Marketing |
Lists: None Mode: •Unbound: Default •Persistable: Default •Optional: Default •Masked: Default •Readable: Yes •Writeable: Yes Subtype: None |
type |
Registry::EN::Business Objects:: TSorderBO::Order |
Lists: Order Type Mode: •Unbound: Default •Persistable: Default •Optional: Default •Masked: Default •Readable: Yes •Writeable: Yes Subtype: None |
deposit_due_date balance_due_date |
Registry::EN::Business Objects:: TSorderBO::Order |
Lists: None Mode: •Unbound: Default •Persistable: Default •Optional: Default •Masked: Default •Readable: Yes •Writeable: Yes Subtype: Standard |
deposit_due_amount |
Registry::EN::Business Objects:: TSorderBO::Order |
Lists: None Mode: •Unbound: Default •Persistable: Default •Optional: Default •Masked: Default •Readable: Yes •Writeable: Yes Subtype: None |
Source File Format
This script is run using a single .CSV or BI (saved as a text/csv 'Extract Tempate') source file.
The following image illustrates the structure required for the order_source_file source file:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
Order |
N/A The provided value is used to identify the order to update based on the Order Identifier' supplied through the execution field. |
Customer Services - Order|Summary page |
2 |
No |
deliverymethod_id |
The 'Delivery Method' on the order |
Customer Services - Order|Summary page |
3 |
No |
deposit_due_date |
Deposit Due Date |
Customer Services - Order|Summary page |
4 |
No |
deposit_due_amount |
Deposit Due Amount |
Customer Services - Order|Summary page |
5 |
No |
balance_due_date |
Balance Due Date |
Customer Services - Order|Summary page |
6 |
No |
type |
Order Type |
Customer Services - Order|Summary page |
7 |
No |
unpaidreason |
Unpaid Reason |
Customer Services - Order|Summary page |
8 |
No |
comments |
Comments |
Customer Services - Order|Summary page |
9 |
No |
currency[1-10] |
Currency [1-10] |
Customer Services - Order|Summary page |
10 |
No |
data[1-50] |
Data [1-50] |
Customer Services - Order|Summary page |
11 |
No |
date[1-10] |
Date [1-10] |
Customer Services - Order|Summary page |
12 |
No |
fixed[1-10] |
Fixed [1-10] |
Customer Services - Order|Summary page |
How the Script Works
The following table outlines the business logic implemented by the script:
Condition |
Action |
Expected Results |
A value is supplied through the source file to identify an order. This can be the Order ID or the Order Number. |
The script loads the order using the supplied value and the value of the 'Order Identifier' execution field from the script job. |
If the order can be identified uniquely using the value from the source file and the specified identifier for an identifier, the order is loaded. The script fails otherwise. |
If any other field values are supplied through the source file. |
The supplied values are updated for the order. |
The order is updated with the values provided in the source file. |
Data Management Configuration
The following outlines the data management job configuration:
•Data Management Job Name: Order Update
•Script Definition: Order Update (text/html)
Job Criteria Section |
|
Field |
Field Value |
Pick Order Identifier |
An identifier to load the order. The default value is Order Number. |
The following image is an example of the Data Management|Schedule page when creating a job using all of the available source files:
