•Data Management Configuration
Summary
Script Name |
Update Customer |
Minimum Supported Version |
7.28.0 |
Source Type |
Single Source |
Script Definitions |
Update Customer |
Use Case
The Customer Update script updates values on a set of customers, including 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.
Field Name |
Registry Location |
Field Configuration |
data[1-50] currency[1-10] date[1-10] fixed[1-10] multidata[1-2] |
Registry::EN::Business Objects:: TScustomerBO::Marketing |
Lists: None Mode: •Unbound: Default •Persistable: Default •Optional: Default •Masked: Default •Readable: Yes •Writeable: Yes Subtype: None |
data[1-5] change_of_address_status |
Registry::EN::Business Objects:: TScustomerBO::Addresses |
Lists: None Mode: •Unbound: Default •Persistable: Default •Optional: Default •Masked: Default •Readable: Yes •Writeable: Yes Subtype: None |
data[1-5] phone_number[5-6] |
Registry::EN::Business Objects:: TScustomerBO::Contacts |
Lists: None Mode: •Unbound: Default •Persistable: Default •Optional: Default •Masked: Default •Readable: Yes •Writeable: Yes Subtype: None |
fixed[1-6] integer[1-6] |
Registry::EN::Business Objects:: TScustomerBO::Customer |
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.
This source file contains the customer number (or any of three 'Legacy Account Number' fields) to search for the customer to be updated with the marketing data provided. The following image illustrates the structure required for the customer_source_file:
This source file contains the customer number, customer ID or any of the three legacy account numbers to search for the customer to update with the data provided by the source file.
The source file must contain a column called customer to identify the customer to update as below:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
customer |
'Customer Number' / 'Legacy Account Number [1-3]' (Used as a Source Key Column) |
Customer Services - Customer|Basic page |
|
Information Source column headers that are different from the primitive name are bolded in the tables below. |
Marketing Node
The source file can include the following columns to supply any single-value customer marketing data field using the primitive name as the column header:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
2 |
No |
currency[1-10] |
Currency [1-10] |
Customer Services - Customer|Basic page |
3 |
No |
data[1-10] |
Marketing Data [1-10] |
Customer Services - Customer|Basic page |
4 |
No |
date[1-10] |
Date [1-10] |
Customer Services - Customer|Basic page |
5 |
No |
fixed[1-10] |
Fixed Integer [1-10] |
Customer Services - Customer|Basic page |
Customer Node
The source file can include the following columns from the Customer node, using the primitive name as the column header:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
2 |
No |
bigInteger[1-10] |
Big Integer [1-10] |
Customer Services - Customer|Basic page |
3 |
No |
customer_class |
Customer Class |
Customer Services - Customer|Basic page |
4 |
No |
customer_owner |
Customer Owner |
Customer Services - Customer|Basic page |
5 |
No |
customer_type |
Customer Type |
Customer Services - Customer|Basic page |
6 |
No |
org_fixed[1-6] |
Fixed[1-6] |
Customer Services - Customer|Basic page |
7 |
No |
integer[1-10] |
Integer [1-10] |
Customer Services - Customer|Basic page |
8 |
No |
language |
Language |
Customer Services - Customer|Basic page |
9 |
No |
organization_name |
Organization Name |
Customer Services - Customer|Basic page |
10 |
No |
organization_type |
Account Type |
Customer Services - Customer|Basic page |
11 |
No |
org_phone_number[1-3] |
Phone [1-3] |
Customer Services - Customer|Basic page |
12 |
No |
org_phone_type[1-3] |
Description |
Customer Services - Customer|Basic page |
13 |
No |
price_type_id |
Price Type |
Customer Services - Customer|Basic page |
14 |
No |
rank |
Rank |
Customer Services - Customer|Basic page |
15 |
No |
total |
Total Members |
Customer Services - Customer|Basic page |
16 |
No |
value |
Points |
Customer Services - Customer|Basic page |
Contacts Node
The source file can include the following columns from the Contacts node, using the primitive name as the column header:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
2 |
No |
birth_date |
Date of Birth |
Customer Services - Customer|Advanced page |
3 |
No |
company |
Company Name |
Customer Services - Customer|Advanced page |
4 |
No |
contact_greeting_name |
Greeting Name |
Customer Services - Customer|Advanced page |
5 |
No |
contact_publish_name |
Publish Name |
Customer Services - Customer|Advanced page |
6 |
No |
contact_salutation_name |
Salutation Name |
Customer Services - Customer|Advanced page |
7 |
No |
contact_type |
Contact Type |
Customer Services - Customer|Advanced page |
8 |
No |
context_contact_type |
Context Contact Type |
Customer Services - Customer|Advanced page |
9 |
No |
contact_data[1-5] |
Data [1-5] |
Customer Services - Customer|Advanced page |
10 |
No |
e_address[1-3] |
Work Email/EAddress[2-3] |
Customer Services - Customer|Basic page |
11 |
No |
Customer Services - Customer|Basic page |
||
12 |
No |
first_name |
First Name |
Customer Services - Customer|Basic page |
13 |
No |
gender |
Gender |
Customer Services - Customer|Advanced page |
14 |
No |
job_title |
Job Title |
Customer Services - Customer|Advanced page |
15 |
No |
last_name |
Last Name |
Customer Services - Customer|Basic page |
16 |
No |
maiden_name |
Maiden Name |
Customer Services - Customer|Advanced page |
17 |
No |
martial_status |
Marital Status |
Customer Services - Customer|Advanced page |
18 |
No |
marketing_state |
Marketing State |
Customer Services - Customer|Advanced page |
19 |
No |
middle_initial |
Middle Initial |
Customer Services - Customer|Basic page |
20 |
No |
phone_number[1-6] |
Home Phone Work Phone Mobile Phone Fax Phone[5-6] |
Customer Services - Customer|Advanced page |
21 |
No |
suffix |
Suffix |
Customer Services - Customer|Basic page |
22 |
No |
title |
Title |
Customer Services - Customer|Basic page |
Address Node
The source file can include the following columns from the Address node, using the primitive name as the column header:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
2 |
No |
address_type |
Address Type |
Customer Services - Customer|Advanced page |
3 |
No |
change_of_address_status |
Change of Address Status |
Customer Services - Customer|Basic page |
4 |
No |
city |
City |
Customer Services - Customer|Basic page |
5 |
No |
country |
Country |
Customer Services - Customer|Basic page |
6 |
No |
CP_sort |
Bulk Mail Code |
Customer Services - Customer|Advanced page |
7 |
No |
address_data[1-5] |
Data[1-5] |
Customer Services - Customer|Advanced page |
8 |
No |
end_date |
In use until |
Customer Services - Customer|Advanced page |
9 |
No |
start_date |
In use from |
Customer Services - Customer|Advanced page |
10 |
No |
state |
Province/State |
Customer Services - Customer|Basic page |
11 |
No |
street |
Street |
Customer Services - Customer|Basic page |
12 |
No |
zip |
Postal Code |
Customer Services - Customer|Basic page |
How the Script Works
The following table outlines the actions and expected results of the script:
Condition |
Action |
Expected Results |
A value is supplied through the source file to identify a customer. This can be the: •Customer ID •Customer Number •Legacy Account Number •Legacy Account Number 2 •Legacy Account Number 3 |
The script loads the customer using the supplied value and the value of the 'Customer Identifier' execution field from the script job. |
The customer record is loaded If the customer canno be identified uniquely using the value from the source file and the specified identifier, the script will fail. |
The customer is loaded successfully. |
Using the values supplied by the source file and the execution fields, the script updates the appropriate primitives based on the action for each multi-primitive through the execution fields. If no action is supplied with values for the multi-primitive, the primitive is not updated. |
The customer is updated successfully. |
Data Management Configuration
The following outlines the data management job configuration:
•Data Management Job Name: Update Customer
•Script Definition: Update Customer
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. |
Update Action for Customer Keywords |
The action to use to update the customer’s keywords. |
Customer Keywords |
The supplied value(s) will be used to update the customer’s keywords based on the corresponding action. |
Update Action for Marketing Multidata 1 |
The action to use to update the customer’s marketing 'Multi Data 1' field. |
Customer Marketing Multidata 1 |
The supplied value(s) will be used to update the customer’s marketing 'Multi Data 1' field based on the corresponding action. |
Update Action for Marketing Multidata 2 |
The action to use to update the customer’s marketing 'Multi Data 2' field. |
Customer Marketing Multidata 2 |
The supplied value(s) will be used to update the customer’s marketing 'Multi Data 2' field based on the corresponding action. |
The following image is an example of the Data Management|Schedule page when creating a job using all of the available source files:
Fields That Are Not Updated
The following tables list the fields on Customer, Contact and Address record are not supported/updated by the script:
Customers |
Active Date |
Created On |
Membership Level |
Customer |
Customer Number |
Default Address |
Default Contact |
Duplicate Customer |
Keeper Customer |
Associations |
Merge Description |
Message Sources |
State |
State Change Description |
Legacy Account Number (when it is used as the customer identifier) |
Legacy Account Number 2 (when it is used as the customer identifier) |
Legacy Account Number 3 (when it is used as the customer identifier) |
Contact |
Contact |
Created On |
Contact Address |
Parent |
Parent Table |
Affiliations |
Extended Attributes |
Default (Yes/No) |
Address |
Address |
Created On |
Parent |
Parent Table |
Default (Yes/No) |
