Siebel Master Data Applications Reference for Industry Applications > Siebel Master Data Applications Messages > Siebel Master Data Application Messages >
Household
UCM Household messages are used in insert, query, update, and delete operations to maintain Household information. LookUpHousehold and LookUpHouseholdByName are used for query operations. UpdateHousehold, InsertHoushold, and DeleteHousehold are message pairs for request and response operations. Figure 18 describes the structure of this message.
Figure 18. UCM Household Structure
|
Table 60. Household Query Integration Components
|
|
|
|
CIFHousehold |
Household |
LookUpHousehold |
UK1:PartyUI UK2: Id |
CIFHouseholdRs |
Household |
LookUpHouseholdResponse |
UK1:PartyUI UK2: Id |
Table 61. Household Query by Name Integration Components
|
|
|
|
CIFHouseholdByName |
Household |
LookUpHouseholdByName |
UK1:PartyUI UK2: Id |
CIFHouseholdByNameRs |
Household |
LookUpHouseholdByNameResponse |
UK1:PartyUI UK2: Id |
Table 62. Household Update Integration Components
|
|
|
|
CIFHouseholdUpdate |
Household |
UpdateHousehold |
UK1:PartyUI UK2: Id |
CIFHouseholdUpdateRs |
Household |
UpdateHouseholdResponse |
UK1:PartyUI UK2: Id |
Table 63. Household Insert Integration Components
|
|
|
|
CIFHouseholdInsert |
Household |
InsertHousehold |
UK1:PartyUI UK2: Id |
CIFHouseholdInsertRs |
Household |
InsertHouseholdResponse |
UK1:PartyUI UK2: Id |
Table 64. Houshold Delete Integration Components
|
|
|
|
CIFHouseholdDelete |
Household |
DeleteHousehold |
UK1:PartyUI UK2: Id |
CIFHouseholdDeleteRs |
Household |
DeleteHouseholdResponse |
UK1:PartyUI UK2: Id |
Table 65. Household Integration Component Fields
|
|
|
|
|
|
Household |
Alias |
Alias |
DTYPE_TEXT |
50 |
|
|
Category |
Category |
DTYPE_TEXT |
30 |
|
Bound by HOUSEHOLD_CATEGORIES |
Currency Code |
CurrencyCode |
DTYPE_TEXT |
20 |
|
Used for picking a related entity. |
Fax Number |
FaxNumber |
DTYPE_TEXT |
40 |
|
|
Household Name |
HouseholdName |
DTYPE_TEXT |
50 |
|
|
Household Number |
HouseholdNumber |
DTYPE_TEXT |
100 |
|
|
Household Size |
HouseholdSize |
DTYPE_INTEGER |
22 |
|
|
Household Wealth |
HouseholdWealth |
DTYPE_CURRENCY |
22 |
|
|
Id |
Id |
DTYPE_ID |
30 |
Y |
This tag is required for ID cross-referencing. Tag stores incoming external ID. |
Income |
Income |
DTYPE_CURRENCY |
7 |
|
|
Integration Id |
IntegrationId |
DTYPE_TEXT |
30 |
|
|
Party UId |
PartyUId |
DTYPE_TEXT |
100 |
|
|
Phone Number |
PhoneNumber |
DTYPE_TEXT |
40 |
|
|
Privacy Code |
PrivacyCode |
DTYPE_TEXT |
30 |
|
Bound by PRIVACY_CODE |
Revenue |
Revenue |
DTYPE_CURRENCY |
22 |
|
|
Segment |
Segment |
DTYPE_TEXT |
30 |
|
Bound by HOUSEHOLD_SEGMENT |
Status |
Status |
DTYPE_TEXT |
30 |
|
Bound by HOUSEHOLD_STATUS |
Suppress All Calls |
SuppressAllCalls |
DTYPE_TEXT |
1 |
|
|
Suppress All Mailings |
SuppressAllMailings |
DTYPE_TEXT |
1 |
|
|
Type |
Type |
DTYPE_TEXT |
30 |
|
Bound by HOUSEHOLD_TYPE |
operation |
operation |
DTYPE_TEXT |
30 |
|
|
Contact |
Contact Integration Id |
ContactIntegrationId |
DTYPE_TEXT |
30 |
|
|
Contact Party UId |
ContactPartyUId |
DTYPE_TEXT |
100 |
|
|
DOB |
DOB |
DTYPE_DATE |
7 |
|
|
First Name |
FirstName |
DTYPE_TEXT |
50 |
4 |
|
IsPrimaryMVG |
IsPrimaryMVG |
DTYPE_TEXT |
1 |
|
|
Last Name |
LastName |
DTYPE_TEXT |
50 |
4 |
|
M/M |
MM |
DTYPE_TEXT |
15 |
|
Bound by MR_MS |
Middle Name |
MiddleName |
DTYPE_TEXT |
50 |
|
|
Person UId |
PersonUId |
DTYPE_TEXT |
100 |
|
|
Related Contact Id |
RelatedContactId |
DTYPE_ID |
15 |
|
|
Related Date Entered Household |
RelatedDateEnteredHousehold |
DTYPE_UTCDATETIME |
7 |
|
|
Related Date Exited Household |
RelatedDateExitedHousehold |
DTYPE_UTCDATETIME |
7 |
|
|
Related Primary Organization Id |
RelatedPrimaryOrganizationId |
DTYPE_ID |
15 |
|
|
Relation to Household |
RelationtoHousehold |
DTYPE_TEXT |
30 |
|
Bound by REL_TO_HOUSEHOLD |
SSN |
SSN |
DTYPE_TEXT |
11 |
|
|
operation |
operation |
DTYPE_TEXT |
30 |
|
System field |
Household Address |
Address Integration Id |
AddressIntegrationId |
DTYPE_TEXT |
30 |
|
|
Address Name |
AddressName |
DTYPE_TEXT |
100 |
|
|
Address Row Id |
AddressRowId |
DTYPE_ID |
15 |
|
|
City |
City |
DTYPE_TEXT |
50 |
4 |
|
Country |
Country |
DTYPE_TEXT |
30 |
|
Bound by COUNTRY |
IsPrimaryMVG |
IsPrimaryMVG |
DTYPE_TEXT |
1 |
|
|
Postal code |
Postalcode |
DTYPE_TEXT |
30 |
|
|
State |
State |
DTYPE_TEXT |
10 |
|
Bound by STATE_ABBREV |
Street Address |
StreetAddress |
DTYPE_TEXT |
200 |
4 |
|
Street Address 2 |
StreetAddress2 |
DTYPE_TEXT |
100 |
|
|
operation |
operation |
DTYPE_TEXT |
30 |
|
System field |
Organization |
IsPrimaryMVG |
IsPrimaryMVG |
DTYPE_TEXT |
1 |
|
|
Organization |
Organization |
DTYPE_TEXT |
50 |
|
|
Organization Id |
OrganizationId |
DTYPE_ID |
30 |
|
|
Organization Integration Id |
OrganizationIntegrationId |
DTYPE_TEXT |
30 |
|
|
operation |
operation |
DTYPE_TEXT |
30 |
|
System field |
Position |
IsPrimaryMVG |
IsPrimaryMVG |
DTYPE_TEXT |
1 |
|
|
Position |
Position |
DTYPE_TEXT |
50 |
|
|
Position Division |
PositionDivision |
DTYPE_TEXT |
255 |
|
|
Position Id |
PositionId |
DTYPE_ID |
15 |
|
|
Position Integration Id |
PositionIntegrationId |
DTYPE_TEXT |
30 |
|
|
Team |
Team |
DTYPE_TEXT |
50 |
|
|
operation |
operation |
DTYPE_TEXT |
30 |
|
System field |
|