Application Services Interface Reference > Predefined Application Service Interfaces >

Siebel Contact/External Contact


The Siebel Contact/External Contact ASI is an ASI for customer information management-related business processes. This ASI facilitates inbound and outbound contact data synchronization between a Siebel application and any external system. Figure 15 describes the Siebel Contact/External Contact ASI structure and Table 21 lists the field definitions.

Figure 15.  Siebel Contact/External Contact ASI

Click for full size image

Table 20 lists the integration component and user keys of the Siebel Contact/External Contact ASI.

Table 20.  Siebel Contact/External Contact Integration Components
Integration Component
XML Tag
User Keys
Contact
Contact
  1. Contact ID
  2. Integration ID
  3. Person UId
  4. First Name, Middle Name, Last Name
Related Account
RelatedAccount
  1. Id
  2. Integration Id
  3. Account, Account Organization
Personal Address
PersonalAddress
  1. Id
  2. Integration Id
Related Communication Address
RelatedCommunicationAddress
  1. Id
  2. Integration Id
  3. Alternate Email Address, Communication Address Medium, Communication Address Name
Alternate Phone
AlternatePhone
  1. Id
  2. Integration Id
  3. Alternate Phone #, Alternate Phone Medium Type, Alternate Phone Name
Related Households
RelatedHouseholds
  1. Id
  2. Integration Id
  3. HH Name, Household Number
Related Organization
RelatedOrganization
  1. Id
  2. Integration Id
  3. Organization
Related Sales Rep
RelatedSalesRep
  1. Id
  2. Integration Id
  3. Division, Position
  4. Login

Table 21 lists the fields and their attributes.

Table 21.  Siebel Contact/External Contact ASI Fields
Name
XML Tag
Data Type
Length
Req.
Notes
Contact
Preferred Language Code
PreferredLanguageCode
DTYPE_TEXT
3
 
Language code needs to be maintained.
Work Phone Extension
WorkPhoneExtension
DTYPE_TEXT
10
 
 
Personal Title
PersonalTitle
DTYPE_TEXT
15
 
Bound by MR_MS LOV.
Income Currency Code
IncomeCurrencyCode
DTYPE_TEXT
20
 
Used for picking a related entity.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key for Contact Header.
Manager Integration Id
ManagerIntegrationId
DTYPE_TEXT
30
 
 
Preferred Communications
PreferredCommunications
DTYPE_TEXT
30
 
Bound by CONTACT_LANGUAGE LOV.
Status
Status
DTYPE_TEXT
30
 
Bound by CONTACT_STATUS LOV.
Alias
Alias
DTYPE_TEXT
50
 
 
Assistant
Assistant
DTYPE_TEXT
50
 
 
Email Address
EmailAddress
DTYPE_TEXT
50
 
 
First Name
FirstName
DTYPE_TEXT
50
 
User key for Contact Header.
Last Name
LastName
DTYPE_TEXT
50
 
Can not be nulled.
User key for Contact Header.
Manager First Name
ManagerFirstName
DTYPE_TEXT
50
 
Used for picking related entity.
Manager Last Name
ManagerLastName
DTYPE_TEXT
50
 
Used for picking related entity.
Manager Middle Name
ManagerMiddleName
DTYPE_TEXT
50
 
Used for picking related entity.
Middle Name
MiddleName
DTYPE_TEXT
50
 
User key for Contact Header.
Job Title
JobTitle
DTYPE_TEXT
75
 
 
Manager Primary Organization
ManagerPrimaryOrganization
DTYPE_TEXT
100
 
Used for picking related entity.
Manager UID
ManagerUId
DTYPE_TEXT
100
 
Used for picking related entity.
Person UId
PersonUId
DTYPE_TEXT
100
 
Can not be nulled.
Time Zone Name
TimeZoneName
DTYPE_TEXT
100
 
Used for picking related entity.
Gender
Gender
DTYPE_TEXT
1
 
Bound by SEX_MF LOV.
Birth Date
BirthDate
DTYPE_DATETIME
7
 
 
Income Exchange Date
IncomeExchangeDate
DTYPE_DATETIME
7
 
 
Manager Id
ManagerId
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
Time Zone Id
TimeZoneId
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
Cellular Phone #
CellularPhone
DTYPE_TEXT
40
 
 
Fax Phone #
FaxPhone
DTYPE_TEXT
40
 
 
Home Phone #
HomePhone
DTYPE_TEXT
40
 
 
Income
Income
DTYPE_CURRENCY
22
 
 
Social Security Number
SocialSecurityNumber
DTYPE_TEXT
11
 
 
Suppress All Calls
SuppressAllCalls
DTYPE_BOOL
1
 
 
Suppress All Emails
SuppressAllEmails
DTYPE_BOOL
1
 
Can not be nulled.
Suppress All Mailings
SuppressAllMailings
DTYPE_BOOL
1
 
 
Work Phone #
WorkPhone
DTYPE_PHONE
40
 
 
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key for Contact Header.
operation
operation
DTYPE_TEXT
30
 
System field.
Personal Address
Personal City
PersonalCity
DTYPE_TEXT
50
 
 
Personal Country
PersonalCountry
DTYPE_TEXT
50
 
 
Personal Postal Code
PersonalPostalCode
DTYPE_TEXT
30
 
 
Personal State
PersonalState
DTYPE_TEXT
10
 
Bound by STATE LOV.
Personal Street Address
PersonalStreetAddress
DTYPE_TEXT
200
 
 
Personal Street Address 2
PersonalStreetAddress2
DTYPE_TEXT
100
 
 
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key field for Related Personal Address.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key field for Related Personal Address.
operation
operation
DTYPE_TEXT
30
 
System field.
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
This field determine if this child record is the primary one. The value is determined in run time.
Related Communication Address
Alternate Email Address
AlternateEmailAddress
DTYPE_TEXT
100
 
 
Communication Address Medium Type
CommunicationAddressMediumType
DTYPE_TEXT
30
 
The default is "Email".
Communication Address Name
CommunicationAddressName
DTYPE_TEXT
50
 
 
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key field for Related Communication Address.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key field for Related Communication Address.
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
This field determine if this child record is the primary one. The value is determined in run time.
operation
operation
DTYPE_TEXT
30
 
System field.
Alternate Phone
Alternate Phone #
AlternatePhone
DTYPE_TEXT
100
 
 
Alternate Phone Medium Type
AlternatePhoneMediumType
DTYPE_TEXT
30
 
The default is "Phone".
Alternate Phone Name
AlternatePhoneName
DTYPE_TEXT
50
 
 
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key field for Related Alternate Phone.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key field for Related Alternate Phone.
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
This field determine if this child record is the primary one. The value is determined in run time.
operation
operation
DTYPE_TEXT
30
 
System field.
Related Account
Account
Account
DTYPE_TEXT
100
 
User key for Related Account.
Account Location
AccountLocation
DTYPE_TEXT
50
 
User key for Related Account.
Account Organization
AccountOrganization
DTYPE_TEXT
100
 
User key for Related Account.
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key for Related Account.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key for Related Account.
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
This field determine if this child record is the primary one. The value is determined in run time.
Related Household
HouseHold Name
HouseHoldName
DTYPE_TEXT
50
 
 
Household Number
HouseholdNumber
DTYPE_TEXT
100
 
This field is read-only. The default is "Id."
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key for Related Household.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key for Related Household.
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
This field determine if this child record is the primary one. The value is determined in run time.
Related Organization
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key field for Related Organization.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key field for Related Organization.
Organization
Organization
DTYPE_TEXT
50
 
 
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
This field determine if this child record is the primary one. The value is determined in run time.
Related Sales Rep
Division
Division
DTYPE_TEXT
255
 
Used for picking a related entity.
User key field for Related Sales Rep.
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by Siebel application on insertion and cannot be updated.
User key field for Related Sales Rep.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key field for Related Sales Rep.
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
This field determine if this child record is the primary one. The value is determined in run time.
Login
Login
DTYPE_TEXT
50
 
User key field for Related Sales Rep.
Position
Position
DTYPE_TEXT
50
 
User key field for Related Sales Rep.


 Application Services Interface Reference 
 Published: 15 May 2003