Application
|
RCE
|
Target Name Space
|
http://www.oracle.com/retail/integration/base/bo/CustomerDesc/v1
|
Version
|
1.0
|
Description
|
|
XSD Structure
|
|
|
XML-Schema Name:CustomerDesc
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CustomerDesc in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
CustomerRef:CustomerRef
|
*
|
0
|
1
|
Unique identifier for customer.
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
AlternateKeys
|
*
|
0
|
999
|
Contains list of alternates keys associated with the customer.
This must no include sensitive customer information like
nationalIDs, credit card numbers, passport numbers etc.
|
|
|
|
|
|
|
customer_type |
customer_type |
0 |
1 |
Contains the customer type: regular customer or business.
|
dps_user |
user_type |
RSB |
38,0 |
Yes |
user type |
first_name |
varchar2120 |
0 |
1 |
Customer first name
|
dps_user |
first_name |
RSB |
40 |
No |
First name of customer/user. |
last_name |
varchar2120 |
0 |
1 |
Customer Last name
|
dps_user |
last_name |
RSB |
40 |
No |
Last name of customer/user |
middle_name |
varchar2120 |
0 |
1 |
Customer middle name |
dps_user |
middle_name |
RSB |
40 |
No |
Middle name of customer/user |
company_name |
varchar2250 |
0 |
1 |
If this customer is a business, this field contains the name of the business.
|
RXM_USER |
company_name |
RSB |
40 |
No |
Company name of user. |
contact_by_mail |
xs:boolean |
0 |
1 |
Indicates if the customer wants to be contacted by mail.
Defaults to false if not specified.
|
RXM_USER |
RECEIVE_MAIL |
RSB |
1,0 |
No |
Boolean to know if user can be contacted by mail |
contact_by_phone |
xs:boolean |
0 |
1 |
Indicates if the customer wants to be contacted by phone.
Defaults to false if not specified.
|
RXM_USER |
RECEIVE_PHONE |
RSB |
1,0 |
No |
boolean value for contact by phone |
contact_by_email |
xs:boolean |
0 |
1 |
Indicates if the customer wants to be contacted by email.
Defaults to false if not specified.
|
DPS_USER |
RECEIVE_EMAIL |
RSB |
38,0 |
No |
enum field with options yes and no |
contact_by_fax |
xs:boolean |
0 |
1 |
Indicates if the customer wants to be contacted by fax.
Defaults to false if not specified.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
gender |
gender_type |
0 |
1 |
Contains the customer gender.
|
dps_user |
gender |
RSB |
38,0 |
No |
Gender of user. Options: male, female |
ethnicity |
ethnicity_type |
0 |
1 |
Contains the customer ethnicity.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
marital_status |
marital_status_type |
0 |
1 |
Contains the customer gender.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
birth_date |
xs:dateTime |
0 |
1 |
Contains the customer birth date.
|
dps_user |
date_of_birth |
RSB |
Date |
No |
DOB of user of type date |
anniversary_date |
xs:dateTime |
0 |
1 |
Contains anniversary date for the customer
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
annual_income |
number20_4 |
0 |
1 |
Annual income for this customer |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
net_worth |
number20_4 |
0 |
1 |
Contains the net worth for this customer |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
highest_education_level |
education_type |
0 |
1 |
Contains the highest education level for this customer |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
industry |
varchar2120 |
0 |
1 |
industry customer belongs to. Sample values 'Consumer', 'Entertaining', 'Medical' etc.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
created_by_loc |
created_by_loc_type |
0 |
1 |
An enum indicating the location type from where the customer got created.
Valid values are 'STORE' (store walk-in), 'WEB' (web channel), 'RENTED' (rented list) and 'Unknown' (unknown).
If this element is missing, then 'UNKNOWN' (unknown) is assumed.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
receipt_preference |
receipt_preference_type |
0 |
1 |
Contains the customer receipt preference. Customer can opt for printed, or email or both printed and email receipts.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
tax_id |
varchar21000 |
0 |
1 |
Contains the federal identifier assigned by a national government.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
tax_certificate |
varchar2230 |
0 |
1 |
Contains the number provided for sales tax exemption issued separately by the state where doing business.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
tax_exempt_reason_code |
varchar220 |
0 |
1 |
Contains the tax exempt reason code.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
job_title |
varchar2100 |
0 |
1 |
Contains the job title.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
CreatedBy
|
*
|
0
|
1
|
The employee that created this customer
|
|
|
|
|
|
|
CustomerPhones
|
*
|
0
|
1
|
Contains all the phones the customer can be reached at
|
|
|
|
|
|
|
CustomerEmails
|
*
|
0
|
1
|
Contains all the emails the customer can be reached at
|
|
|
|
|
|
|
AddrBook
|
*
|
0
|
1
|
Contains all the addresses for this customer, such as 'Home', 'Office'
|
|
|
|
|
|
|
CustomerSegment
|
*
|
0
|
999
|
A collection of customer segments (such as senior_citizen, teacher, veteran,
contractor, etc) that this customer has been assigned to that would impact the
pricing offered to the customer.
|
|
|
|
|
|
|
CustomerPromotion
|
*
|
0
|
999
|
A collection of promotion ids of promotions that this customer may choose to
activate, such as by presenting a coupon, or may automatically be applied to their
purchases for discounting the total.
|
|
|
|
|
|
|
Cards
|
*
|
0
|
1
|
Contains a collection of cards. Here we can save the details of various cards a customer possess. For eg., credit/debit, loyalty/giftcard, etc.
|
|
|
|
|
|
|
CustomerOrg
|
*
|
0
|
1
|
Contains the organization information that the customer belongs to.
|
|
|
|
|
|
|
lcl:LocaleDesc
|
*
|
0
|
1
|
Contains the customer preferred language.
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
create_timestamp |
xs:dateTime |
0 |
1 |
The timestamp at which this record was created. |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
update_timestamp |
xs:dateTime |
0 |
1 |
The timestamp at which this record was last updated. |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:CustomerRef
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CustomerRef in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
customer_id |
varchar214 |
1 |
1 |
Contains the unique identifier for the customer
|
RXM_USER |
EXT_USER_ID |
RSB |
40 |
Yes |
External customer ID , being mapped to commerce profile/user ID. |
|
|
XML-Schema Name:AlternateKeys
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for AlternateKeys in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
type |
varchar230 |
1 |
1 |
Type of the alternate key e.g. PHONE, EMAIL, OROMS_ID, XSTORE_ID etc.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
value |
varchar264 |
1 |
1 |
Value for the specific type of the alternate key.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:CreatedBy
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CreatedBy in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
EmployeeRef:EmployeeRef
|
*
|
0
|
1
|
Contains the id of the employee that created the customer.
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
|
|
XML-Schema Name:EmployeeRef
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for EmployeeRef in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
from_location |
varchar210 |
0 |
1 |
Description is not available. |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
to_location |
varchar210 |
0 |
1 |
Description is not available. |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
employee_id |
varchar210 |
1 |
1 |
Description is not available. |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:CustomerPhones
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CustomerPhones in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
PhoneDesc:PhoneDesc
|
*
|
0
|
99
|
Contact Phone
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
|
|
XML-Schema Name:PhoneDesc
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for PhoneDesc in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
phone_id |
number22 |
0 |
1 |
Unique identified for the phone
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
phone_number |
varchar230 |
1 |
1 |
Phone number
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
phone_type |
phone_type |
0 |
1 |
Phone type. For ORPOS if the field is not populated will default to value "HOME".
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
phone_extension |
varchar230 |
0 |
1 |
Contains the phone extension
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
primary_phone_ind |
xs:boolean |
0 |
1 |
Indicates whether this phone is the primary contact phone
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
contact_preference_code |
varchar2120 |
0 |
1 |
Indicates the type of communications that this phone is being used for.
Sample values: order information only, promotion info only, marketing, no phone contact
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:CustomerEmails
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CustomerEmails in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
EmailDesc:EmailDesc
|
*
|
0
|
99
|
Contact Email
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
|
|
XML-Schema Name:EmailDesc
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for EmailDesc in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
email_id |
number22 |
0 |
1 |
Unique identifier for the email
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
email_type |
email_type |
0 |
1 |
Contains the email type. For ORPOS if the field is not populated, will default to "HOME".
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
primary_email_ind |
xs:boolean |
0 |
1 |
Indicates whether this email is the primary contact email address. Defaults to false.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
email_address |
varchar264 |
1 |
1 |
Contains the email address.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
format_preference_code |
email_format |
0 |
1 |
Contains the format for the email for example TEXT or HTML.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
contact_preference_code |
varchar2120 |
0 |
1 |
Indicates the type of communications being sent to this email address.
Sample values: order information only, promotion info only, marketing, no contact
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
validated_email_flag |
xs:boolean |
0 |
1 |
If the retailer integrates with an external system that does email validation at the time of adding this record,
this flag is set to true. Absence of this element should indicate "false".
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:AddrBook
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for AddrBook in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
AddrBookEntry
|
*
|
0
|
99
|
Contains a collection of addresses for the customer.
Collection limited to 99 to prevent XML overflow
|
|
|
|
|
|
|
|
|
XML-Schema Name:AddrBookEntry
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for AddrBookEntry in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
address_alias |
varchar2250 |
0 |
1 |
Customer's alias for this address, example My Office Shipping Address
|
RXM_CONTACT_INFO |
ALIAS |
RSB |
120 |
No |
Customer alias address |
primary_addr_ind |
xs:boolean |
0 |
1 |
Indicates whether this address is the primary address to contact the customer.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
primary_billing |
xs:boolean |
0 |
1 |
Indicates whether this address should be considered first as the customer's
billing address.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
primary_shipping |
xs:boolean |
0 |
1 |
Indicates whether this address should be considered first as the customer's
shipping address.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
GeoAddrDesc:GeoAddrDesc
|
*
|
1
|
1
|
Address for this contact
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
ContactDesc:ContactDesc
|
*
|
0
|
1
|
Contains contact for this address
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
|
|
XML-Schema Name:GeoAddrDesc
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for GeoAddrDesc in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
addr_id |
number22 |
0 |
1 |
Unique identifier for this address entry.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
addr_type |
addr_type |
0 |
1 |
The address type can be any of the enumerated values 'Home','Office','Billing','Shipping'
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
address_alias |
varchar2250 |
0 |
1 |
Alias for this address, example 'My Event Venue'
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
address_1 |
varchar2240 |
1 |
1 |
Contains Address Line 1.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
address_2 |
varchar2240 |
0 |
1 |
Contains Address Line 2.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
address_3 |
varchar2240 |
0 |
1 |
Contains Address Line 3.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
address_4 |
varchar2240 |
0 |
1 |
Contains Address Line 4.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
address_5 |
varchar2240 |
0 |
1 |
Contains Address Line 5.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
city |
varchar2120 |
0 |
1 |
Contains the city where the address is located.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
county |
varchar2250 |
0 |
1 |
County where this address is located
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
state_code |
varchar23 |
0 |
1 |
Contains the postal abbreviation for the state, province or territory in which the address is located.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
state_name |
varchar2120 |
0 |
1 |
Indicates the state, province or territory name.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
country_code |
varchar23 |
0 |
1 |
Contains the postal abbreviation of the country in which the address is located
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
country_name |
varchar2120 |
0 |
1 |
Indicates the Country name For e.g Brazil,United States
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
postal_code |
varchar230 |
0 |
1 |
Contains the postal code for the address
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
jurisdiction_code |
varchar210 |
0 |
1 |
ID associated to the tax jurisdiction of the
country-state relationship.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
contact_preference_code |
varchar2120 |
0 |
1 |
Indicates the type of communications being sent to this address.
Sample values are order information only, promotion info only, marketing material, no contact
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
validated_addr_flag |
xs:boolean |
0 |
1 |
If the retailer integrates with an external system that does address validation at the time of adding this record,
this flag is set to true. Absence of this element should indicate "false".
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:ContactDesc
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for ContactDesc in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
contact_id |
number22 |
0 |
1 |
Unique identifier for this contact
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
first_name |
varchar2120 |
0 |
1 |
Contact first name.
ORPOS Usage - For regular customers that are fed into ORPOS from an external customer system, if this field is not populated, ORPOS will prompt for a value. For Customers created by ORPOS, this field needs to be populated. |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
last_name |
varchar2120 |
0 |
1 |
Contact last name.
ORPOS Usage - For regular customers that are fed into ORPOS, if this field is not populated, ORPOS will prompt for a value. For Customers created by ORPOS, this field needs to be populated. |
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
middle_name |
varchar2120 |
0 |
1 |
Contact middle name
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
preferred_name |
varchar2120 |
0 |
1 |
Contact preferred name
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
full_name |
varchar2250 |
0 |
1 |
Contains the full name for a regular customer.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
name_prefix |
varchar2120 |
0 |
1 |
A Title placed before a name. Example Ms, Mr
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
name_suffix |
varchar2120 |
0 |
1 |
The name suffix, can be academic, honorary, professional or generational.
Example: PhD, MBA, PMP, Sr, Jr, JDA
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
fax_number |
varchar220 |
0 |
1 |
Fax number for this contact
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
company_name |
varchar2250 |
0 |
1 |
Contains the name of a business/ organization.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
Phones
|
*
|
0
|
1
|
List of phones for this contact address.
|
|
|
|
|
|
|
Emails
|
*
|
0
|
1
|
List of emails for this contact address
|
|
|
|
|
|
|
|
|
XML-Schema Name:CustomerSegment
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CustomerSegment in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
customer_segment_id |
number22 |
1 |
1 |
Contains the id of the customer segment, such as teacher, veteran, etc.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
customer_segment_name |
varchar2250 |
0 |
1 |
Contains the name of the customer segment, such as teacher, veteran, etc.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:CustomerPromotion
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CustomerPromotion in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
customer_promotion_id |
number22 |
1 |
1 |
Contains the id of a promotion available to this customer, such as a coupon code.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
customer_promotion_name |
varchar2250 |
0 |
1 |
Contains the name of a promotion, such as "But 1 sock get another sock free."
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:Cards
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for Cards in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
CardDesc:CardDesc
|
*
|
0
|
99
|
Customer Card.
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
|
|
XML-Schema Name:CardDesc
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CardDesc in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
card_id |
varchar214 |
0 |
1 |
Unique identifier for the card as defined by the system-of-record, which is usually the customer master system.
Other systems can use this id as an external id. This is not the same as the card's printed number.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
card_number |
varchar240 |
0 |
1 |
The card number printed on the card. This element should not be used for cards with sensitive
account numbers, like credit and debit cards.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
masked_card_number |
varchar240 |
0 |
1 |
The card number that is printed on the card with most of its characters replaced with masking char.
This field should be used for cards with sensitive account numbers, like credit and debit cards.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
card_type |
enum_card_type |
1 |
1 |
Type of card. For eg.,credit, debit, giftcard, loyalty, etc.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
card_status |
enum_card_status_type |
0 |
1 |
Status of the card. Defaults to ACTIVE
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
AddrDesc:GeoAddrDesc
|
*
|
0
|
1
|
Billing address for the card
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
activation_date |
xs:dateTime |
0 |
1 |
The date that the card was activated.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
expiration_month |
number2 |
0 |
1 |
The month that the card will expire.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
expiration_year |
number2 |
0 |
1 |
The year that the card will expire.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:CustomerOrg
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for CustomerOrg in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
organization_id |
varchar214 |
0 |
1 |
Unique identifier for the organization.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
organization_name |
varchar2240 |
0 |
1 |
Contains the name of the organization that customer belongs to.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
organization_type |
varchar2120 |
0 |
1 |
Contains the type of the organization that customer belongs to. This is free form field and can contain
values like 'Charity', 'Booster Club', 'Labor Council' etc
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|