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