Application Services Interface Reference > Predefined Application Service Interfaces >

Siebel Household/External Household


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

Figure 21.  Siebel Household/External Household ASI

Click for full size image

Table 32 lists the integration components and user keys of the ASI.

Table 32.  Siebel Household/External Household Integration Components
Integration Component
XML Tag
User Keys
Household (primary)
Household
  1. Household Id
  2. Household Integration Id
Related Sales Rep
RelatedSalesRep
  1. Login
  2. Position
  3. Position Division
  4. Position Id
  5. Position Integration Id
Related Organization
RelatedOrganization
  1. Organization Id
  2. Organization Integration Id
  3. Organization Name
Related Contact
RelatedContact
  1. Contact Id
  2. Contact Integration Id
  3. Personal UID, Personal Contact, Primary Organization

Table 33 lists the fields and their attributes.

Table 33.  Siebel Household/External Household ASI Fields
Name
XML Tag
Data Type
Length
Req.
Notes
Household
Category
Category
DTYPE_TEXT
30
 
 
Currency Code
CurrencyCode
DTYPE_TEXT
20
 
Used for picking a related entity.
Fax Number
FaxNumber
DTYPE_PHONE
40
 
 
Household Id
HouseholdId
DTYPE_TEXT
100
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
User key field for Household.
Household Name
HouseholdName
DTYPE_TEXT
50
Y
 
Household Size
HouseholdSize
DTYPE_INTEGER
22
 
 
Household Wealth
HouseholdWealth
DTYPE_CURRENCY
20
 
 
Id
Id
DTYPE_TEXT
30
 
 
Income
Income
DTYPE_CURRENCY
20
 
 
Integration Id
IntegrationId
DTYPE_TEXT
30
 
User key field for Household.
Phone Number
PhoneNumber
DTYPE_PHONE
40
 
 
Revenue
Revenue
DTYPE_CURRENCY
20
 
 
Segment
Segment
DTYPE_TEXT
30
 
 
Status
Status
DTYPE_TEXT
30
Y
 
Type
Type
DTYPE_TEXT
30
 
 
Operation
Operation
DTYPE_TEXT
30
 
 
Related Sales Rep
IsPrimaryMVG
IsPrimaryMVG
 
 
 
This field determines if this child record is the primary one. The value is determined in run time.
Login
Login
DTYPE_ID
15
Y
User key field for Related Sales Rep.
Position
Position
DTYPE_TEXT
50
 
User key field for Related Sales Rep.
Position Division
PositionDivision
DTYPE_TEXT
255
Y
User key field for Related Sales Rep.
Position Id
PositionId
DTYPE_ID
15
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
User key field for Related Sales Rep.
Position Integration Id
PositionIntegrationId
DTYPE_TEXT
30
 
User key field for Related Sales Rep.
Related Organization
IsPrimaryMVG
IsPrimaryMVG
 
 
 
This field determines if this child record is the primary one. The value is determined in run time.
Organization Id
OrganizationId
DTYPE_ID
15
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
User key field for Related Organization.
Organization Integration Id
OrganizationIntegrationId
DTYPE_TEXT
30
 
User key field for Related Organization.
Organization Name
OrganizationName
DTYPE_TEXT
50
Y
User key field for Related Organization.
Related Contact
IsPrimaryMVG
IsPrimaryMVG
 
 
 
This field determines if this child record is the primary one. The value is determined at run time.
Contact Id
ContactId
DTYPE_ID
15
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
User key field for Related Contact.
Contact Integration Id
ContactIntegrationId
DTYPE_TEXT
30
 
User key field for Related Contact.
Date Entered Household
DateEnteredHousehold
DTYPE_UTCDATETIME
7
 
 
Date Exited Household
DateExitedHousehold
DTYPE_UTCDATETIME
7
 
 
First Name
FirstName
DTYPE_TEXT
50
Y
 
Last Name
LastName
DTYPE_TEXT
50
Y
 
Middle Name
MiddleName
DTYPE_TEXT
50
 
 
Person UId
PersonalContact
DTYPE_BOOL
1
Y
User key field for Related Contact.
Personal Contact
PersonUId
DTYPE_TEXT
100
Y
User key field for Related Contact.
Primary Organization Id
PrimaryOrganizationId
DTYPE_ID
15
Y
User key field for Related Contact.


 Application Services Interface Reference 
 Published: 15 May 2003