17Oracle Customer Hub (UCM) and Data Governance Manager Web Services Reference

Oracle Customer Hub (UCM) and Data Governance Manager Web Services Reference

This chapter provides reference information for Oracle Customer Hub (UCM) and Oracle Data Governance Manager Web services. It includes the following topics:

• About Oracle Customer Hub (UCM) Web Services and Oracle CRMML

• Core Oracle Customer Hub (UCM) Web Services

• Organization Service

• PersonService

• GroupService

• Financial Account Service

• Organization Match Service

• PersonMatchService

• OrganizationCrossReferenceService

• PersonCrossReferenceService

• GroupCrossReferenceService

• FinancialAssetCrossReferenceService

• Overview of Siebel Outbound Web Services

• Publish Subscribe Service

• Configuring Publish and Subscribe

• Enabling or Disabling Oracle Customer Hub (UCM)Services

• About Merge Publish Service

• Verifying Merge Publish Settings

• Overview of Oracle Customer Hub (UCM) Data Enrichment Web Services

• Process of Configuring Data Enrichment

• Third-Party Data Enrichment Fields

• Oracle Data Governance Manager Web Services

• SystemsRegistration Service

• ConsolidateListImportService

• MasterService

• ConsolidateService

• ShareService

• CleanseCompletenessService

• GovernService

About Oracle Customer Hub (UCM) Web Services and Oracle CRMML

With the release of Oracle Customer Hub (UCM) 8.2, Service Oriented Architecture and Web service enablement of Oracle Customer Hub (UCM) features is taking the place of Oracle’s Customer Relationship Management Markup Language (CRMML) proprietary format.

Oracle Customer Hub (UCM) uses industry-standard Web Services Definition Language (WSDL) for publishing Web services to external systems. In earlier versions of Oracle Customer Hub (UCM) Oracle’s CRMML, an XML based markup language, provided the means for data exchange. CRMML was used for communication within Oracle Customer Hub (UCM). For example, it was used for inbound request-response type and in publish-subscribe types of message delivery.

CRMML comprises two parts:

• Header. It contains the following:

  • Information identifying the sending and receiving systems

    This information was used by Oracle Customer Hub (UCM) for security verifications

  • A message descriptor identifying the message

• Body. It contains one or more message elements representing the following:

  • Inbound requests from an external application to insert, query, update, or delete a database object

  • Outbound response to a requested transaction

  • Outbound publication messages to be sent to an external subscribing application.

For more information on Oracle CRMML, see ASIs and Messages for Oracle Master Data Management Applications.

Core Oracle Customer Hub (UCM) Web Services

The following Web services are used to execute core Oracle Customer Hub (UCM) operations. These Web services include:

• Organization Service

• PersonService

• GroupService

• Financial Account Service

• Organization Match Service

• PersonMatchService

• OrganizationCrossReferenceService

• PersonCrossReferenceService

• GroupCrossReferenceService

• FinancialAssetCrossReferenceService

Organization Service

Use this Web service to perform all operations related to the organization and or the account object. This Web service is used for all party operations. Oracle Customer Hub (UCM) organization messages are used in insert, query, update and delete operations to maintain organization information.

OrganizationService Operations

For a list of the operations associated with this Web service, see the following table.

Table OrganizationService Operations

Name	Description
createOrganization	Creates an organization record.
updateOrganization	Updates an existing organization record.
deleteOrganization	Deletes an organization record.
getOrganization	Retrieves organization records, based on a user query.

Request Message Description: createOrganization

For a description of this request message, see the following table.

Table Request Message Description: createOrganization

Node	Description	Type
SwiOrganizationIO	Required. An instance of the integration object, SwiOrganizationIO. Account is the parent header and the nodes which follow in this table are considered child records.	Integration Object
The following nodes apply to SwiOrganizationIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
AccountStatus	Status of the account.	String
AccountValue	Value of the account.	String
CurrencyCode	Currency code being used by the account.	String
DUNSNumber	Dun and Bradstreet data universal numbering system. This value is a number.	String
IntegrationId	Integration ID.	String
Location	Account location.	String
MainPhoneNumber	Phone contact of the account.	String
Name	Account name.	String
NumberofEmployees	Number of employees in the organization.	String
PartyTypeCode	Party type code.	String
PartyUId	Party unique ID.	String
Status	Status.	string
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfAccount_BusinessAddress	Optional. Account business address.	Integration Component
ListOfFincorpDepositAccount	Optional. Financial corporation deposit account.	Integration Component
ListOfFincorpLoanAccount	Optional. Financial corporation account loan details.	Integration Component
ListOfContact	Optional. Contact details of the account.	Integration Component
ListOfUcmAccountPrivacy	Optional. Privacy details of the account.	Integration Component
ListOfRelatedSalesRep	Optional. Details of related sales representatives.	Integration Component
ListOfSubAccount	Optional. Details of subordinate accounts associated with the parent account, if any.	Integration Component
ListOfRelatedOrganization	Optional. Details of the related organization.	Integration Component
ListOfRelatedIndustry	Optional. Details of related industries to the account.	Integration Component

Response Message Description: createOrganization

For a description of this response message, see the following table.

Table Response Message Description: createOrganization

Node	Description	Type
SwiOrganizationIO	An instance of the integration object, SwiOrganizationIO.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: updateOrganization

For a description of this request message, see the following table.

Table Request Message Description: updateOrganization

Node	Description	Type
SwiOrganizationIO	Required. An instance of the integration object, SwiOrganizationIO. Account is the parent header and the nodes which follow in this table are considered child records.	Integration Object
The following nodes apply to SwiOrganizationIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
AccountStatus	Status of the account.	String
AccountValue	Value of the account.	String
CurrencyCode	Currency code being used by the account.	String
DUNSNumber	Dun and Bradstreet data universal numbering system, number.	String
IntegrationId	Integration ID.	String
Location	Account location.	String
MainPhoneNumber	Phone contact of the account.	String
Name	Account name.	String
NumberofEmployees	Number of employees in the organization.	String
PartyTypeCode	Party type code.	String
PartyUId	Party unique ID.	String
Status	Status.	string
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfAccount_BusinessAddress	Optional. Account business address.	Integration Component
ListOfFincorpDepositAccount	Optional. Financial corporation deposit account.	Integration Component
ListOfFincorpLoanAccount	Optional. Financial corporation account loan details.	Integration Component
ListOfContact	Optional. Contact details of the account.	Integration Component
ListOfUcmAccountPrivacy	Optional. Privacy details of the account.	Integration Component
ListOfRelatedSalesRep	Optional. Details of related sales representatives.	Integration Component
ListOfSubAccount	Optional. Details of subordinate accounts associated with the parent account, if any.	Integration Component
ListOfRelatedOrganization	Optional. Details of the related organization.	Integration Component
ListOfRelatedIndustry	Optional. Details of related industries to the account.	Integration Component

Response Message Description: updateOrganization

For a description of this response message, see the following table.

Table Response Message Description: updateOrganization

Node	Description	Type
SwiOrganizationIO	An instance of the integration object, SwiOrganizationIO, with the list of operated records.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: deleteOrganization

For a description of this request message, see the following table.

Table Request Message Description: deleteOrganization

Node	Description	Type
SwiOrganizationIO	Required. An instance of the integration object, SwiOrganizationIO. Account is the parent header and the nodes which follow in this table are considered child records.	Integration Object
The following nodes apply to SwiOrganizationIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
AccountStatus	Status of the account.	String
AccountValue	Value of the account.	String
CurrencyCode	Currency code being used by the account.	String
DUNSNumber	Dun and Bradstreet data universal numbering system, number.	String
IntegrationId	Integration ID.	String
Location	Account location.	String
MainPhoneNumber	Phone contact of the account.	String
Name	Account name.	String
NumberofEmployees	Number of employees in the organization.	String
PartyTypeCode	Party type code.	String
PartyUId	Party unique ID.	String
Status	Status.	string
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfAccount_BusinessAddress	Optional. Account business address.	Integration Component
ListOfFincorpDepositAccount	Optional. Fincorp deposit account.	Integration Component
ListOfFincorpLoanAccount	Optional. Fincorp account loan details.	Integration Component
ListOfContact	Optional. Contact details of the account.	Integration Component
ListOfUcmAccountPrivacy	Optional. Privacy details of the account.	Integration Component
ListOfRelatedSalesRep	Optional. Details of related sales representatives.	Integration Component
ListOfSubAccount	Optional. Details of subordinate accounts associated with the parent account, if any.	Integration Component
ListOfRelatedOrganization	Optional. Details of the related organization.	Integration Component
ListOfRelatedIndustry	Optional. Details of related industries to the account.	Integration Component

Response Message Description: deleteOrganization

For a description of this response message, see the following table.

Table Response Message Description: deleteOrganization

Node	Description	Type
SwiOrganizationIO	The same request instance of the integration object, SwiOrganizationIO.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any	String

Request Message Description: getOrganization

For a description of this request message, see the following table.

Table Request Message Description: getOrganization

Node	Description	Type
SwiOrganizationIO	Required. An instance of the integration object, SwiOrganizationIO. Account is the parent header and the following are the child.	Integration Object
The following nodes apply to SwiOrganizationIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
AccountStatus	Status of the account.	String
AccountValue	Value of the account.	String
CurrencyCode	Currency code being used by the account.	String
DUNSNumber	Dun and Bradstreet data universal numbering system, number.	String
IntegrationId	Integration ID.	String
Location	Account location.	String
MainPhoneNumber	Phone contact of the account.	String
Name	Account name.	String
NumberofEmployees	Number of employees in the organization.	String
PartyTypeCode	Party type code.	String
PartyUId	Party unique ID.	String
Status	Status.	string
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfAccount_BusinessAddress	Optional. Account business address.	Integration Component
ListOfFincorpDepositAccount	Optional. Fincorp deposit account.	Integration Component
ListOfFincorpLoanAccount	Optional. Fincorp account loan details.	Integration Component
ListOfContact	Optional. Contact details of the account.	Integration Component
ListOfUcmAccountPrivacy	Optional. Privacy details of the account.	Integration Component
ListOfRelatedSalesRep	Optional. Details of related sales representatives.	Integration Component
ListOfSubAccount	Optional. Details of subordinate accounts associated with the parent account, if any.	Integration Component
ListOfRelatedOrganization	Optional. Details of the related organization.	Integration Component
ListOfRelatedIndustry	Optional. Details of related industries to the account.	Integration Component

Response Message Description: getOrganization

For a description of this response message, see the following table.

Table Response Message Description: getOrganization

Node	Description	Type
SwiOrganizationIO	An instance of the integration object, SwiOrganizationIO.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

OrganizationService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table OrganizationService Service Object

Siebel Repository Name	Boundary Object Type	Class
OrganizationService	Workflow: UCM Organization Customer Profile Integration SOAP Process. The process properties for this workflow are as follows: RealtimePubSub. The default value is True. Turn On CDM Cleanse. The default value is False. Turn on CDM Exact Match. The default value is False. Turn on CDM Match. The default value is False. Turn on Survivorship. The default value is False.	Not applicable

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table OrganizationService Data Object

Siebel Repository Name	External Name
SwiOrganizationIO	Account

Methods

For a description of the methods for this Web service, see the following table.

Table OrganizationService Methods

Operation	Method
createOrganization	RunProcess
updateOrganization	RunProcess
deleteOrganization	RunProcess
getOrganization	RunProcess

PersonService

Use this Web service to create, update, retrieve and delete Person records.

PersonService Operations

For a list of the operations associated with this Web service, see the following table.

Table PersonService Operations

Name	Description
createPerson	Creates a person record.
updatePerson	Updates an existing person record.
deletePerson	Deletes a person record.
getPerson	Retrieves person records based on a user query.

Request Message Description: createPerson

For a description of this request message, see the following table.

Table Request Message Description: createPerson

Node	Description	Type
SwiPersonIO	Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child.	Integration Object
The following nodes apply to SwiPersonIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
CellularPhone	Contact’s mobile phone number.	String
BirthDate	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
HomePhone	Contact’s home phone number.	String
Income	Contact’s income.	String
IncomeCurrencyCode	Income currency code.	String
IntegrationId	Integration ID.	String
LastName	Contact’s last name.	String
MF	Male or female.	String
MM	Mr. or Ms.	String
ManagerIntegrationId	Manager’s integration ID.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mothers’ maiden name	String
PartyUId	Party unique ID.	String
PersonUId	Person user ID.	String
PreferredCommunications	Contact’s preferred communication method.	String
PreferredLanguageCode	Contact preferred language code.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status.	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfContact_Account	Optional. Account associated with the contact.	Integration Component
ListOfUcmContactPrivacy	Optional. Contact’s privacy details.	Integration Component
ListOfContact_CommunicationAddress	Optional. Contact’s communication address.	Integration Component
ListOfContact_AlternatePhone	Optional. Contact’s alternate phone details.	Integration Component
ListOfContact_Position	Optional. Contact’s positions.	Integration Component
ListOfContact_Households	Optional. Contact’s household.	Integration Component
ListOfContact_INSPersonalAddress	Optional. Contact’s personal address details.	Integration Component
ListOfContact_Organization	Optional. Contact’s organization details.	Integration Component
ListOfFINCORPAccount	Optional. Details of the associated FINCORP account.	Integration Component
ListOfUCMHEConstituentName	Optional. Details of the constituent’s names.	Integration Component
ListOfUCMHEConstituentIdentification	Optional. Details of the constituent’s identification.	Integration Component
ListOfUCMHEConstituentAddress	Optional. Details of the constituent’s addresses.	Integration Component
ListOfUCMHEConstituentAffiliation	Optional. Details of the constituent’s affiliations.	Integration Component

Response Message Description: createPerson

For a description of this response message, see the following table.

Table Response Message Description: createPerson

Node	Description	Type
SwiPersonIO	An instance of the integration object, SwiPersonIO. Contact is the parent header.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: updatePerson

For a description of this request message, see the following table.

Table Request Message Description: updatePerson

Node	Description	Type
SwiPersonIO	Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child.	Integration Object
The following nodes apply to SwiOrganizationIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
CellularPhone	Contact’s mobile phone number.	String
BirthDate	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
HomePhone	Contact’s home phone number.	String
Income	Contact’s income.	String
IncomeCurrencyCode	Income currency code.	String
IntegrationId	Integration ID.	String
LastName	Contact’s last name.	String
MF	Male or female.	String
MM	Mr. or Ms.	String
ManagerIntegrationId	Manager’s integration ID.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mothers’ maiden name	String
PartyUId	Party unique ID.	String
PersonUId	Person user ID.	String
PreferredCommunications	Contact’s preferred communication method.	String
PreferredLanguageCode	Contact preferred language code.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status.	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfContact_Account	Optional. Account associated with the contact.	Integration component
ListOfUcmContactPrivacy	Optional. Contact’s privacy details.	Integration component
ListOfContact_CommunicationAddress	Optional. Contact’s communication address.	Integration component
ListOfContact_AlternatePhone	Optional. Contact’s alternate phone details.	Integration component
ListOfContact_Position	Optional. Contact’s positions.	Integration component
ListOfContact_Households	Optional. Contact’s household.	Integration component
ListOfContact_INSPersonalAddress	Optional. Contact’s personal address details.	Integration component
ListOfContact_Organization	Optional. Contact’s organization details.	Integration component
ListOfFINCORPAccount	Optional. Details of the associated FINCORP account.	Integration component
ListOfUCMHEConstituentName	Optional. Details of the constituent’s names.	Integration component
ListOfUCMHEConstituentIdentification	Optional. Details of the constituent’s identification.	Integration component
ListOfUCMHEConstituentAddress	Optional. Details of the constituent’s addresses.	Integration component
ListOfUCMHEConstituentAffiliation	Optional. Details of the constituent’s affiliations.	Integration component

Response Message Description: updatePerson

For a description of this response message, see the following table.

Table Response Message Description: updatePerson

Node	Description	Type
SwiPersonIO	An instance of the integration object, SwiPersonIO. Contact is the parent header.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: deletePerson

For a description of this request message, see the following table.

Table Request Message Description: deletePerson

Node	Description	Type
SwiPersonIO	Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child.	Integration Object
The following nodes apply to SwiOrganizationIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
CellularPhone	Contact’s mobile phone number.	String
BirthDate	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
HomePhone	Contact’s home phone number.	String
Income	Contact’s income.	String
IncomeCurrencyCode	Income currency code.	String
IntegrationId	Integration ID.	String
LastName	Contact’s last name.	String
MF	Male or female.	String
MM	Mr. or Ms.	String
ManagerIntegrationId	Manager’s integration ID.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mothers’ maiden name	String
PartyUId	Party unique ID.	String
PersonUId	Person user ID.	String
PreferredCommunications	Contact’s preferred communication method.	String
PreferredLanguageCode	Contact preferred language code.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status.	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfContact_Account	Optional. Account associated with the contact.	Integration Component
ListOfUcmContactPrivacy	Optional. Contact’s privacy details.	Integration Component
ListOfContact_CommunicationAddress	Optional. Contact’s communication address.	Integration Component
ListOfContact_AlternatePhone	Optional. Contact’s alternate phone details.	Integration Component
ListOfContact_Position	Optional. Contact’s positions.	Integration Component
ListOfContact_Households	Optional. Contact’s household.	Integration Component
ListOfContact_INSPersonalAddress	Optional. Contact’s personal address details.	Integration Component
ListOfContact_Organization	Optional. Contact’s organization details.	Integration Component
ListOfFINCORPAccount	Optional. Details of the associated FINCORP account.	Integration Component
ListOfUCMHEConstituentName	Optional. Details of the constituent’s names.	Integration Component
ListOfUCMHEConstituentIdentification	Optional. Details of the constituent’s identification.	Integration Component
ListOfUCMHEConstituentAddress	Optional. Details of the constituent’s addresses.	Integration Component
ListOfUCMHEConstituentAffiliation	Optional. Details of the constituent’s affiliations.	Integration Component

For a description of this response message, see the following table.

Table Response Message Description: deletePerson

Node	Description	Type
SwiPersonIO	Required. The same request instance of the integration object, SwiPersonIO.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any	String

For a description of this request message, see the following table.

Table Request Message Description: getPerson

Node	Description	Type
SwiPersonIO	Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child.	Integration Object
The following nodes apply to SwiOrganizationIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
CellularPhone	Contact’s mobile phone number.	String
BirthDate	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
HomePhone	Contact’s home phone number.	String
Income	Contact’s income.	String
IncomeCurrencyCode	Income currency code.	String
IntegrationId	Integration ID.	String
LastName	Contact’s last name.	String
MF	Male or female.	String
MM	Mr. or Ms.	String
ManagerIntegrationId	Manager’s integration ID.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mothers’ maiden name	String
PartyUId	Party unique ID.	String
PersonUId	Person user ID.	String
PreferredCommunications	Contact’s preferred communication method.	String
PreferredLanguageCode	Contact preferred language code.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status.	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfContact_Account	Optional. Account associated with the contact.	Integration Component
ListOfUcmContactPrivacy	Optional. Contact’s privacy details.	Integration Component
ListOfContact_CommunicationAddress	Optional. Contact’s communication address.	Integration Component
ListOfContact_AlternatePhone	Optional. Contact’s alternate phone details.	Integration Component
ListOfContact_Position	Optional. Contact’s positions.	Integration Component
ListOfContact_Households	Optional. Contact’s household.	Integration Component
ListOfContact_INSPersonalAddress	Optional. Contact’s personal address details.	Integration Component
ListOfContact_Organization	Optional. Contact’s organization details.	Integration Component
ListOfFINCORPAccount	Optional. Details of the associated FINCORP account.	Integration Component
ListOfUCMHEConstituentName	Optional. Details of the constituent’s names.	Integration Component
ListOfUCMHEConstituentIdentification	Optional. Details of the constituent’s identification.	Integration Component
ListOfUCMHEConstituentAddress	Optional. Details of the constituent’s addresses.	Integration Component
ListOfUCMHEConstituentAffiliation	Optional. Details of the constituent’s affiliations.	Integration Component

For a description of this response message, see the following table.

Table Response Message Description: getPerson

Node	Description	Type
SwiPersonIO	An instance of the integration object, SwiPersonIO. Contact is the parent header.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

PersonService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table PersonService Service Object

Siebel Repository Name	Boundary Object Type	Class
PersonService	Workflow: UCM Person Customer Profile Integration SOAP Process. The process properties for this workflow are as follows: RealtimePubSub. The default value is True. Turn On CDM Cleanse. The default value is False. Turn on CDM Exact Match. The default value is False. Turn on CDM Match. The default value is False. Turn on Survivorship. The default value is False.	Not applicable

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table PersonService Data Object

Siebel Repository Name	External Name
SwiPersonIO	Contact

Methods

For a description of the methods for this Web service, see the following table.

Table PersonService Methods

Operation	Method
createPerson	RunProcess
updatePerson	RunProcess
deletePerson	RunProcess
getPerson	RunProcess

GroupService

Use this Web service to perform all operations related to Households (Groups). UCM Household messages are used in insert, query, update and delete operations to maintain Household information.

GroupService Operations

For a list of the operations associated with this Web service, see the following table.

Table GroupService Operations

Name	Description
createGroup	Creates a new group record.
updateGroup	Updates and existing group record.
deleteGroup	Deletes a group record.
getGroup	Retrieves group records, based on a user query.

Request Message Description: createGroup

For a description of this request message, see the following table.

Table Request Message Description: createGroup

Node	Description	Type
SwiGroupIO	Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child	Integration Object
The following nodes apply to SwiGroupIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
HouseholdName	Name of the household.	String
HouseholdNumber	Household number.	String
IntegrationId	Integration ID.	String
Name	Household name.	String
PartyUId	Party unique ID.	String
PhoneNumber	Phone number.	String
PrivacyCode	Privacy code	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID	String
HouseholdLink	Household link	String
LengthOfResidence	Length of residence	String
HomeOwnerRenter	Rental home owner	String
ListOfHousehold_HouseholdAddress	Optional. Household address.	Integration Component
ListOfHousehold_Position	Optional. Positions of the household	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP account	Integration Component
ListOfContact	Optional. Contact details of the household	Integration Component
ListOfHousehold_Organization	Optional. Organization details related to the household.	Integration Component

Response Message Description: createGroup

For a description of this response message, see the following table.

Table Response Message Description: createGroup

Node	Description	Type
SwiGroupIO	An instance of the integration object, SwiGroupIO, with the list of records operated. Household is the parent header.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: updateGroup

For a description of this request message, see the following table.

Table Request Message Description: updateGroup

Node	Description	Type
SwiGroupIO	Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child	Integration Object
The following nodes apply to SwiGroupIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
HouseholdName	Name of the household.	String
HouseholdNumber	Household number.	String
IntegrationId	Integration ID.	String
Name	Household name.	String
PartyUId	Party unique ID.	String
PhoneNumber	Phone number.	String
PrivacyCode	Privacy code	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID	String
HouseholdLink	Household link	String
LengthOfResidence	Length of residence	String
HomeOwnerRenter	Rental home owner	String
ListOfHousehold_HouseholdAddress	Optional. Household address.	Integration Component
ListOfHousehold_Position	Optional. Positions of the household.	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP account	Integration Component
ListOfContact	Optional. Contact details of the household.	Integration Component
ListOfHousehold_Organization	Optional. Organization details related to the household.	Integration Component

Response Message Description: updateGroup

For a description of this response message, see the following table.

Table Response Message Description: updateGroup

Node	Description	Type
SwiGroupIO	An instance of the integration object, SwiGroupIO, with the list of records operated. Household is the parent header.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: deleteGroup

For a description of this request message, see the following table.

Table Request Message Description: deleteGroup

Node	Description	Type
SwiGroupIO	Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child	Integration Object
The following nodes apply to SwiGroupIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
HouseholdName	Name of the household.	String
HouseholdNumber	Household number.	String
IntegrationId	Integration ID.	String
Name	Household name.	String
PartyUId	Party unique ID.	String
PhoneNumber	Phone number.	String
PrivacyCode	Privacy code	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
HouseholdLink	Household link	String
LengthOfResidence	Length of residence	String
HomeOwnerRenter	Rental home owner	String
ListOfHousehold_HouseholdAddress	Optional. Household address.	Integration Component
ListOfHousehold_Position	Optional. Positions of the household.	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP account	Integration Component
ListOfContact	Optional. Contact details of the household.	Integration Component
ListOfHousehold_Organization	Optional. Organization details related to the household.	Integration Component

For a description of this response message, see the following table.

Table ResponseMessage Description: deleteGroup

Node	Description	Type
SwiGroupIO	Required. The same request instance of the integration object, SwiGroupIO.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any	String

For a description of this request message, see the following table.

Table Request Message Description: getGroup

Node	Description	Type
SwiGroupIO	Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child	Integration Object
The following nodes apply to SwiGroupIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
HouseholdName	Name of the household.	String
HouseholdNumber	Household number.	String
IntegrationId	Integration ID.	String
Name	Household name.	String
PartyUId	Party unique ID.	String
PhoneNumber	Phone number.	String
PrivacyCode	Privacy code	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID	String
HouseholdLink	Household link	String
LengthOfResidence	Length of residence	String
HomeOwnerRenter	Rental home owner	String
ListOfHousehold_HouseholdAddress	Optional. Household address	Integration Component
ListOfHousehold_Position	Optional. Positions of the household.	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP account.	Integration Component
ListOfContact	Optional. Contact details of the household.	Integration Component
ListOfHousehold_Organization	Optional. Organization details related to the household.	Integration Component

For a description of this response message, see the following table.

Table Response Message Description: getGroup

Node	Description	Type
SwiGroupIO	An instance of the integration object, SwiGroupIO with the list of records operated. Household is the parent header.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

GroupService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table GroupService Service Object

Siebel Repository Name	Boundary Object Type	Class
GroupService	Workflow: UCM Group Customer Profile Integration SOAP Process. The process properties for this workflow are as follows: RealtimePubSub. The default value is True. Turn On CDM Cleanse. The default value is False. Turn on CDM Exact Match. The default value is False. Turn on CDM Match. The default value is False. Turn on Survivorship. The default value is False.	Not applicable

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table GroupService Data Object

Siebel Repository Name	External Name
SwiGroupIO	Household

Methods

For a description of the methods for this Web service, see the following table.

Table GroupService Data Object

Operation	Method
createGroup	RunProcess
updateGroup	RunProcess
deleteGroup	RunProcess
getGroup	RunProcess

Financial Account Service

Use this Web service to create new financial service account records and to perform update, delete and retrieve operations.

Financial Account Service Operations

For a list of the operations associated with this Web service, see the following table.

Table Financial Account Service Operations

Name	Description
createFinancialAsset	Creates a new financial account record.
updateFinancialAsset	Updates an existing financial account record.
deleteFinancialAsset	Deletes a financial account record.
getFinancialAsset	Retrieves financial account records, based on a user query.

Request Message Description: createFinancialAsset

For a description of this request message, see the following table.

Table Request Message Description: createFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	Required. An instance of the integration object, SwiFinancialAssetIO. FINCORP. Account is the parent header and the nodes which follow in this table are considered child records.	Integration Object
The following nodes apply to SwiFinancialAssetIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
AccountName	Account name.	String
AccountNumber	Number of the account.	String
IntegrationId	Integration ID.	String
Name	FINCORP account name.	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID	String
ListOfCutAddress	Optional. Business address.	Integration Component
ListOfFINCORPAccountContact	Optional. Contacts of the FINCORP account.	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP account.	Integration Component
ListOfFinsCfFinancialAssetAddress	Optional. Address details of the FINCORP account.	Integration Component
ListOfFINCORPAccountContact	Optional. Contact details of the FINCORP account.	Integration Component
ListOfContact	Contact details.	Integration Component

Response Message Description: createFinancialAsset

For a description of this response message, see the following table.

Table Response Message Description: createFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	An instance of the integration object, SwiFinancialAssetIO. Financial corporation. Account is the parent header.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: updateFinancialAsset

For a description of this request message, see the following table.

Table Request Message Description: updateFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	Required. An instance of the integration object, SwiFinancialAssetIO. FINCORP account is the parent header and the following are child nodes.	Integration Object
The following nodes apply to SwiFinancialAssetIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
AccountName	Account name.	String
AccountNumber	Account number.	String
IntegrationId	Integration ID.	String
Name	FINCORP account name.	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID.	String
ListOfCutAddress	Optional. Business address.	Integration Component
ListOfFINCORPAccountContact	Optional. Contacts of the FINCORP account.	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP account.	Integration Component
ListOfFinsCfFinancialAssetAddress	Optional. Address details of the FINCORP account.	Integration Component
ListOfFINCORPAccountContact	Optional. Contact details of the FINCORP account.	Integration Component
ListOfContact	Contact details.	Integration Component

Response Message Description: updateFinancialAsset

For a description of this response message, see the following table.

Table Response Message Description: updateFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	An instance of the integration object, SwiFinancialAssetIO. FINCORP Account is the parent header	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

Request Message Description: deleteFinancialAsset

For a description of this request message, see the following table.

Table Request Message Description: deleteFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	Required. An instance of the integration object, SwiFinancialAssetIO. FINCORP. Account is the parent header and the following are child nodes.	Integration Object
The following nodes apply to SwiFinancialAssetIO
Id	Row ID of the Record in the requesting system cross-reference ID.	String
AccountName	Account Name	String
AccountNumber	Number of the Account	String
IntegrationId	Integration ID	String
Name	FINCORP Account Name	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID	String
ListOfCutAddress	Optional. Business address	Integration Component
ListOfFINCORPAccountContact	Optional. Contacts of the FINCORP Account.	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP Account	Integration Component
ListOfFinsCfFinancialAssetAddress	Optional. Address details of the FINCORP Account	Integration Component
ListOfFINCORPAccountContact	Optional. Contact details of the FINCORP Account	Integration Component
ListOfContact	Contact details.	Integration Component

For a description of this response message, see the following table.

Table Response Message Description: deleteFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	Required. The same request instance of the integration object, SwiFinancialAssetIO.	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any	String

For a description of this request message, see the following table .

Table Request Message Description: getFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	Required. An instance of the integration object, SwiFinancialAssetIO. FINCORP Account is the parent header and the following are child nodes.	Integration Object
The following nodes apply to SwiFinancialAssetIO
Id	Row ID of the record in the requesting system cross-reference ID.	String
AccountName	Account Name	String
AccountNumber	Number of the Account	String
IntegrationId	Integration ID	String
Name	FINCORP Account Name	String
AIAUCMIntegrationId	Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID	String
ListOfCutAddress	Optional. Business address	Integration Component
ListOfFINCORPAccountContact	Optional. Contacts of the FINCORP Account.	Integration Component
ListOfUCMFINCORPAccountPrivacy	Optional. Privacy details of the FINCORP Account	Integration Component
ListOfFinsCfFinancialAssetAddress	Optional. Address details of the FINCORP Account	Integration Component
ListOfFINCORPAccountContact	Optional. Contact details of the FINCORP Account	Integration Component
ListOfContact	Contact details.	Integration Component

For a description of this response message, see the following table.

Table Response Message Description: getFinancialAsset

Node	Description	Type
SwiFinancialAssetIO	An instance of the integration object, SwiFinancialAssetIO. FINCORP. Account is the parent header	Integration Object
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Error Symbol	Error symbol, if any.	String

FinancialAssetService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table FinancialAssetService Service Object

Siebel Repository Name	Boundary Object Type	Class
FinancialAssetService	Workflow: UCM Financial Asset Customer Profile Integration SOAP Process. The process properties for this workflow are as follows: RealtimePubSub. The default value is True. Turn On CDM Cleanse. The default value is False. Turn on CDM Exact Match. The default value is False. Turn on CDM Match. The default value is False. Turn on Survivorship. The default value is False.	Not applicable

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table FinancialAssetService Data Object

Siebel Repository Name	External Name
SwiFinancialAssetIO	FINCORP Account

Methods

For a description of the methods for this Web service, see the following table.

Table FinancialAssetService Data Object

Operation	Method
createFinancialAsset	RunProcess
updateFinancialAsset	RunProcess
deleteFinancialAsset	RunProcess
getFinancialAsset	RunProcess

Organization Match Service

Use this Web service to find similar accounts and organizations in designated databases, such as Oracle Customer Hub (UCM) database, corresponding to the one being sent in a request message. The similarity is based on advanced algorithms, as opposed to a plain search where a user would input A* and receive all Account records that begin with A. Additionally the algorithm depends on the matching engine (such as ISS, SSA and so on) used at the back-end with the configured match strategies, rules, and configurations.

OrganizationMatchService Operations

For a list of the operations associated with this Web service, see the following table.

Table OrganizationMatchService Operations

Name	Description
OrganizationMatch	Locates similar accounts, based on predefined rules and algorithms.

Request Message Description: OrganizationMatch

For a description of this request message, see the following table.

Table Request Message Description: OrganizationMatch

Node	Description	Type
SwiOrganizationMatchInputIO	An instance of the integration object, SwiOrganizationMatchInputIO	Integration Object

Response Message Description: OrganizationMatch

For a description of this response message, see the following table.

Table Response Message Description: OrganizationMatch

Node	Description	Type
SwiOrganizationMatchOutputIO	An instance of the integration object, SwiOrganizationMatchOutputIO	Integration Object

OrganizationMatchService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table OrganizationMatchService Service Object

Siebel Repository Name	Boundary Object Type	Class
DeDuplication	Business Service	CSSDeDupService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table OrganizationMatchService Data Object

Siebel Repository Name	External Name
SwiOrganizationMatchInputIO	SwiOrganizationMatchInputIO
SwiOrganizationMatchOutputIO	SwiOrganizationMatchOutputIO

Note: When adding additional fields to the ICs in SwiOrganizationMatchInputIO and SwiOrganizationMatchOutputIO, the IC Field Name should not have any spaces in between. The External Name should match with the BC Field Name, which may have spaces in between.

Methods

For a description of the methods for this Web service, see the following table.

Table OrganizationMatchService Methods

Operation	Method
OrganizationMatch	Organization Match Web service

PersonMatchService

Use this Web service to find similar contacts in designated databases, such as Oracle Customer Hub (UCM) database, corresponding to the one being sent in a request message. The similarity is based on an advanced algorithms (as opposed to a plain search where a user would input A* and receive all Account records beginning with A) and depends on the matching engine (such as ISS, SSA and so on) used at the back-end with the match strategies, rules, and configurations in place.

PersonMatchService Operations

For the operation associated with this Web service, see the following.

Table PersonMatchService Operation

Name	Description
PersonMatch	Finds similar contacts, based on predefined rules and algorithms.

Request Message Description: PersonMatch

For a description of this request message, see the following table.

Table PersonMatch Request Message Description:

Node	Description	Type
SwiPersonMatchInputIO	An instance of the SwiPersonMatchInputIO Integration Object.	Integration Object

Response Message Description: PersonMatch

For a description of this response message, see the following table.

Table PersonMatch Response Message Description:

Node	Description	Type
SwiPersonMatchOutputIO	An instance of the SwiPersonMatchOutputIO Integration Object.	Integration Object

PersonMatchService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table PersonMatchService Service Object

Siebel Repository Name	Boundary Object Type	Class
DeDuplication	Business Service	CSSDeDupService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table PersonMatchService Data Object

Siebel Repository Name	External Name
SwiPersonMatchInputIO	SwiPersonMatchInputIO
SwiPersonMatchOutputIO	SwiPersonMatchOutputIO

Note: When adding additional fields to the ICs in SwiPersonMatchInputIO and SwiPersonMatchOutputIO, the IC Field Name should not have any spaces in between. The External Name should match with the BC Field Name, which may have spaces in between.

Methods

For a description of the methods for this Web service, see the following table.

Table PersonMatchService Methods

Operation	Method
PersonMatch	Person Match Web service

OrganizationCrossReferenceService

Use this Web service to create explicit links between organization records in Oracle Customer Hub (UCM) and those in participating applications.

OrganizationCrossReferenceService Operations

For a list of the operations associated with this Web service, see the following table.

Table OrganizationCrossReferenceService Operations

Name	Description
createOrganizationCrossReference	Creates a cross-reference ID to a Organization record.
updateOrganizationCrossReference	Updates a cross-reference ID to a Organization record.
deleteOrganizationCrossReference	Deletes a cross-reference ID to a Organization record.
getOrganizationCrossReference	Retrieves a cross-reference ID to a Organization record.

Request Message Description: createOrganizationCrossReference

For a description of this request message, see the following table.

Table Request Message Description: createOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublish	An instance of the integration object, SwiOrganizationPublish. The main Integration components are Account and CIF Account Reference.	Integration Object

Response Message Description: createOrganizationCrossReference

For a description of this response message, see the following table.

Table Response Message Description: createOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublish	An instance of the integration object, SwiOrganizationPublish. The main Integration components are Account and CIF Account Reference.	Integration Object

Request Message Description: updateOrganizationCrossReference

For a description of this request message, see the following table.

Table Request Message Description: updateOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublish	An instance of the integration object, SwiOrganizationPublish. The main integration components are Account and CIF Account Reference.	Integration Object

Response Message Description: updateOrganizationCrossReference

For a description of this response message, see the following table.

Table Response Message Description: updateOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublishIO	An instance of the integration object, SwiOrganizationPublish. The main components are Account and CIF Account Reference.	Integration Object

Request Message Description: deleteOrganizationCrossReference

For a description of this request message, see the following table.

Table Request Message Description: deleteOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublishIO	An instance of the integration object, SwiOrganizationPublish. The main Integration components are Account and CIF Account Reference.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: deleteOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublishIO	An instance of the integration object, SwiOrganizationPublish. The main Integration components are Account and CIF Account Reference.	Integration Object

For a description of this request message, see the following table.

Table Request Message Description: getOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublishIO	An instance of the integration object, SwiOrganizationPublish. The main component is Account.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: getOrganizationCrossReference

Node	Description	Type
SwiOrganizationPublishIO	An instance of the integration object, SwiOrganizationPublish. The main components are are Account and CIF Account Reference.	Integration Object

OrganizationCrossReferenceService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table OrganizationCrossReferenceService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Cross Reference Service	Business Service	CSSUCMXRefService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table OrganizationCrossReferenceService Data Object

Siebel Repository Name	External Name
SwiOrganizationPublishIO	Account

Methods

For a description of the methods for this Web service, see the following table.

Table OrganizationCrossReferenceService Methods

Operation	Method
createOrganizationCrossReference	CreateOrganizationCrossReference
updateOrganizationCrossReference	UpdateOrganizationCrossReference
deleteOrganizationCrossReference	DeleteOrganizationCrossReference
getOrganizationCrossReference	GetOrganizationCrossReference

PersonCrossReferenceService

Use this Web service to create explicit links between person records in Oracle Customer Hub (UCM) and those in participating applications.

PersonCrossReferenceService Operations

For a list of the operations associated with this Web service, see the following table.

Table PersonCrossReferenceService Operations

Name	Description
createPersonCrossReference	Creates a cross-reference ID to a Person record.
updatePersonCrossReference	Updates a cross-reference ID to a Person record.
deletePersonCrossReference	Deletes a cross-reference ID to a Person record.
getPersonCrossReference	Retrieves a cross-reference ID to a Person record.

Request Message Description: createPersonCrossReference

For a description of this request message, see the following table.

Table Request Message Description: createPersonCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main components are Contact and CIF Contact Reference.	Integration Object

Response Message Description: createPersonCrossReference

For a description of this response message, see the following table.

Table Response Message Description: createPersonCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main components are Contact and CIF Contact Reference.	Integration Object

Request Message Description: updatePersonCrossReference

For a description of this request message, see the following table.

Table Request Message Description: updatePersonCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main components are Contact and CIF Contact Reference.	Integration Object

Response Message Description: updatePersonCrossReference

For a description of this response message, see the following table.

Table Response Message Description: updatePersonCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main components are Contact and CIF Contact Reference.	Integration Object

Request Message Description: deletePersonCrossReference

For a description of this request message, see the following table.

Table Request Message Description: deletePersonCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main components are Contact and CIF Contact Reference.	Integration Object

Response Message Description: deletePersonCrossReference

For a description of this response message, see the following table.

Table Response Message Description: deletePersonCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main components are Contact and CIF Contact Reference.	Integration Object

Request Message Description: getPersonCrossReference

For a description of this request message, see the following table.

Table Request Message Description: getOrganizationCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main component is Contact.	Integration Object

Response Message Description: getPersonCrossReference

For a description of this response message, see the following table.

Table Response Message Description: getPersonCrossReference

Node	Description	Type
SwiPersonPublishIO	An instance of the integration object, SwiPersonPublishIO. The main components are Contact and CIF Contact Reference.	Integration Object

PersonCrossReferenceService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table PersonCrossReferenceService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Cross Reference Service	Business Service	CSSUCMXRefService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table PersonCrossReferenceService Data Object

Siebel Repository Name	External Name
SwiPersonPublishIO	Contact

Methods

For a description of the methods for this Web service, see the following table.

Table PersonCrossReferenceService Methods

Operation	Method
createPersonCrossReference	CreatePersonCrossReference
updatePersonCrossReference	UpdatePersonCrossReference
deletePersonCrossReference	DeletePersonCrossReference
getPersonCrossReference	GetPersonCrossReference

GroupCrossReferenceService

Use this Web service to create explicit links between Group records in Oracle Customer Hub (UCM) and those in participating applications.

GroupCrossReferenceService Operations

For a list of the operations associated with this Web service, see the following table.

Table GroupCrossReferenceService Operations

Name	Description
createGroupReference	Creates a cross-reference ID to a Group record.
updateGroupReference	Updates a cross-reference ID to a Group record.
deleteGroupReference	Deletes a cross-reference ID to a Group record.
getGroupReference	Retrieves a cross-reference ID to a Group record.

Request Message Description: createGroupCrossReference

For a description of this request message, see the following table.

Table Request Message Description: createGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object SwiGroupPublishIO.	Integration Object

Response Message Description: createGroupCrossReference

For a description of this response message, see the following table.

Table Response Message Description: createGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object, SwiGroupPublishIO.	Integration Object

Request Message Description: updateGroupCrossReference

For a description of this request message, see the following table.

Table Request Message Description: updateGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object, SwiGroupPublishIO.	Integration Object

Integration ObjectResponse Message Description: updateGroupCrossReference

For a description of this response message, see the following table.

Table Response Message Description: updateGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object, SwiGroupPublishIO.	Integration Object

Request Message Description: deleteGroupCrossReference

For a description of this request message, see the following table.

Table Request Message Description: deleteGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object, SwiGroupPublishIO.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: deleteGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object, SwiGroupPublishIO.	Integration Object

For a description of this request message, see the following table.

Table Request Message Description: getGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object, SwiGroupPublishIO.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: getGroupCrossReference

Node	Description	Type
SwiGroupPublishIO	An instance of the integration object, SwiGroupPublishIO.	Integration Object

GroupCrossReferenceService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table GroupCrossReferenceService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Cross Reference Service	Business Service	CSSUCMXRefService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table GroupCrossReferenceService Data Object

Siebel Repository Name	External Name
SwiGroupPublishIO	Household

Methods

For a description of the methods for this Web service, see the following table.

Table GroupCrossReferenceService Methods

Operation	Method
createGroupCrossReference	CreateGroupCrossReference
updateGroupCrossReference	UpdateGroupCrossReference
deleteGroupCrossReference	DeleteGroupCrossReference
getGroupCrossReference	GetGroupCrossReference

FinancialAssetCrossReferenceService

Use this Web service to create explicit links between financial account records within Oracle Customer Hub (UCM) and those in participating applications.

FinancialAssetCrossReferenceService Operations

For a list of the operations associated with this Web service, see the following table.

Table FinancialAssetCrossReferenceService Operations

Name	Description
createFinancialAssetReference	Creates a cross-reference ID to a financial asset record.
updateFinancialAssetReference	Updates a cross-reference ID to a financial asset record.
deleteFinancialAssetReference	Deletes a cross-reference ID to a financial asset record.
getFinancialAssetReference	Retrieves a cross-reference ID to a financial asset record.

Request Message Description: createFinancialAssetCrossReference

For a description of this request message, see the following table.

Table Request Message Description: createFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

Response Message Description: createFinancialAssetCrossReference

For a description of this response message, see the following table.

Table Response Message Description: createFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

Request Message Description: updateFinancialAssetCrossReference

For a description of this request message, see the following table.

Table Request Message Description: updateFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

Response Message Description: updateFinancialAssetCrossReference

For a description of this response message, see the following table.

Table Response Message Description: updateFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

Request Message Description: deleteFinancialAssetCrossReference

For a description of this request message, see the following table.

Table Request Message Description: deleteFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: deleteFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

For a description of this request message, see the following table.

Table Request Message Description: getFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: getFinancialAssetCrossReference

Node	Description	Type
SwiFinancialAssetPublishIO	An instance of the integration object, SwiFinancialAssetPublishIO.	Integration Object

FinancialAssetCrossReferenceService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table FinancialAssetCrossReferenceService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Cross Reference Service	Business Service	CSSUCMXRefService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table FinancialAssetCrossReferenceService Data Object

Siebel Repository Name	External Name
SwiFinancialAssetPublishIO	FINCORP Account

Methods for FinancialAssetCrossReferenceService

For a description of the methods for this Web service, see the following table.

Table FinancialAssetCrossReferenceService Methods

Operation	Method
createFinancialAssetCrossReference	CreateFinancialAssetCrossReference
updateFinancialAssetCrossReference	UpdateFinancialAssetCrossReference
deleteFinancialAssetCrossReference	DeleteFinancialAssetCrossReference
getFinancialAssetCrossReference	GetFinancialAssetCrossReference

Overview of Siebel Outbound Web Services

Siebel Outbound services are Web services that are configured to call Oracle Application Integration Architecture services through proxy business services. The proxy business services are created in Oracle Customer Hub (UCM) by using WSDL from Oracle Application Integration Architecture.

A Siebel Outbound Web service is used to send and receive data to and from Siebel Business Applications through synchronous or asynchronous service calls for different process flows.

Publish Subscribe Service

The Oracle Customer Hub (UCM) Publish Subscribe Web service provides the ability to publish messages to a middleware system, which in turn broadcasts the message to subscribed systems. Oracle Customer Hub (UCM) Publish Subscribe business service operates in two different modes:

• Stand-alone mode. In this mode, Publish Subscribe publishes the messages directly to the subscribed systems, using the transport information provided during the system registration using point-to-point integration strategy.

• Middleware mode. In this mode, Oracle Customer Hub (UCM) is connected to subscribed systems via middleware. Oracle Customer Hub (UCM) publishes only one message to middleware with cross-reference information of subscribed systems. Cross-reference information is then used by middleware to broadcast messages to the respective subscribed systems. In middleware mode, if you are configuring UCM to consume an external web service from the middleware systems, the systems registered as middleware must have the proxy business service and business service method supplied in the CIF System Objects Subscribe List applet; otherwise they should have the transport information supplied.

In the System Registration view for CIF Systems List applet, specify appropriate values for the columns, Is Middleware and Message Type, for each system registered in Oracle Customer Hub (UCM). Users can set Message Type to Simple Object Access Protocol (SOAP) or CRMML. The recommended value is SOAP.

If you configure the UCM Publish Subscribe workflow with All View mode set to restricted visibility, records are not published.

Note: It is recommended, when performing queries with the UCM Publish Subscribe Process, that you use the All View mode. Using the All View mode allows you publish a record whether it is in your default organization or not. For information on configuring the All View mode, see Siebel System Requirements and Supported Platforms on Oracle Technology Network.

Configuring Publish and Subscribe

The Publish Subscribe Web service provides a means of publishing messages to a middleware system, which acts as a funnel to the subscribing applications.

Note: This configuration task is not required when integrating Oracle Application Integration Architecture with Oracle Customer Hub (UCM). A middleware installation must be completed and set up to handle outbound publish actions. If you are setting up an integration of Oracle Application Integration Architecture with Oracle Customer Hub (UCM), make sure Oracle Application Integration Architecture is set up and functioning. If Oracle Customer Hub (UCM) is integrated with any other middleware provider, make sure that the middleware installation is completed before doing the following task.

To create a proxy business service

1. In Siebel Tools, lock the project Web Service Integration, and lock the Project name.

2. From the File menu, select New Object.

3. In the New Object wizard, click the EAI tab, and click the Web Service icon.

4. Find the PublishSubscribe WSDL file in your installation directory.

   The run-time data file and log file entries are automatically created.

   Caution: Do not select the Process Fault Schema check box because it will produce unintended results.

5. Click Next.

6. Select the Deploy Integration Objects and Proxy Business Services check box.

7. Click Finish.

8. Search the log files for the entry, Outbound proxy business service definitions to be generated. At the end of the definition, you see the name of the proxy business service you created.

   For example:

   Outbound proxy business service definitions to be generated: 
   
   SyncOrganizationUCMJMSProducerService_1 for portTypeName:http://xmlns.oracle.com/
   
   ABCS/UCM/Core/SyncOrganizationUCMJMSProducer/
   
   V1:SyncOrganizationUCMJMSProducerService
   

   In this example, SyncOrganizationUCMJMSProducerService is the name of the proxy service that was created.

9. When the proxy business service is created, click the Business Services object in the Object Explorer.

Modifying the Newly Created Proxy Business Service

Use the following task to modify the newly created proxy business service.

Note: This configuration task is not required when integrating Oracle Application Integration Architecture with Oracle Customer Hub (UCM).

To modify the newly created business service

1. In Siebel Tools Business Services screen, query for the newly created proxy business service.

2. In the Object Explorer, navigate to Business Service Method Arguments.

3. Search for arguments of type Integration Object.

4. Note the Integration Object names, then using the Object Explorer, find and delete the objects.

   The default integration objects will not be used. Instead, the newly imported integration objects will be used.

5. Replace the existing Integration Object names in the Business Service Method Arguments of the proxy service with the new Integration Object names displayed in the following table.

   Base Object Type of the Proxy Service	New Integration Object Name
   Organization	SwiOrganizationPublishIO
   Person	SwiPersonPublishIO
   Household	SwiGroupPublishIO
   FINCORP Account	SwiFinancialAssetPublishIO

6. Compile the affected objects, then restart the Siebel Server.

Registering the Web Services

Use this task to register the newly created Web services.

To register the newly created Web services

1. From the Siebel Mobile Web client, navigate to the Administration - Web Services screen.

2. In the Deployed Integration Objects view verify that all the Integration Objects you deployed in Siebel Tools are showing the correct time of deployment.

   This will allow you to make sure the Integration Objects displayed are those you imported.

   Note: If you have an integration of Oracle Application Integration Architecture with Oracle Customer Hub (UCM), go to Step 3. If you do not have an integration, go to Step 5.

3. From the Outbound Web Services view, query for the Oracle Application Integration Architecture Web services:

   • SyncOrganizationUCMJMSProducer

   • SyncPersonUCMJMSProducer

4. Change the address of the ports corresponding to these Web services to point to the appropriate Oracle Application Integration Architecture end point.

5. If you are not integrated with Oracle Application Integration Architecture, navigate to the Outbound Web Services view, and query for the Web service that was created in Creating the Proxy Business Service.

6. Change the address of the ports corresponding to the Web services to point to the appropriate middleware end point.

Enabling or Disabling Oracle Customer Hub (UCM)Services

After configuring the services, you must enable them. The following tasks allow you to enable or disable the Web services.

Configuring Publish/Subscribe System Preferences

You must set the Publish/Subscribe settings to allow you to use the RealTime Publish/Subscribe service. Use the following task to configure Publish/Subscribe system preferences.

To configure Publish/Subscribe system preferences

1. Navigate to the Administration - Application screen, then the System Preferences view.

2. In the System Preferences screen, query for Enable Realtime PubSub.

3. If no preferencs are found, create new records for each of the parameters displayed in the following table.

   Parameter	Value
   Enable Realtime PubSub 1	Account
   Enable Realtime PubSub 2	Contact
   Enable Realtime PubSub 3	Household
   Enable Realtime PubSub 4	FINCORP Account

About Merge Publish Service

If a data steward performs a merge operation, the surviving record is updated and the victime record is deleted in the best version table. The surviving record and victim record that are affected by the merge operation in Oracle Customer Hub (UCM) are published to the applications by using the publish subscribe business service.

Verifying Merge Publish Settings

There is no additional configuration needed for these settings, though you must verify the configurations. Use the following task to verify Merge Publish settings.

To verify the Merge Publish settings

1. In the Siebel Tools Object Explorer, choose Business Components.

2. In the Business Components screen, query for UCM DeDuplication Results.

3. Verify that the query has returned the following values:

   • UCM DeDuplication Results (Account)

   • UCM DeDuplication Results (Contact)

4. Select UCM DeDuplication Results (Account) and in the Object Explorer, navigate to Business Component User Prop.

5. Verify that the following values are present.

   Business Component	User Property Name	User Property Value
   UCM DeDuplication Results (Account)	MERGE_PUBLISH_IO	SwiOrganizationPublishIO
   	PUBLISH_METHOD_TYPE	PublishMethod
   	VICTIM_OPERATION_TYPE	Delete
   	SURVIVOR_OPERATION_TYPE	Upsert

6. Select UCM DeDuplication Results (Contact) and in the Object Explorer, navigate to Business Component User Prop.

7. Verify that the following values are present.

   Business Component	User Property Name	User Property Value
   UCM DeDuplication Results (Contact)	MERGE_PUBLISH_IO	SwiPersonPublishIO
   	PUBLISH_METHOD_TYPE	PublishMethod
   	VICTIM_OPERATION_TYPE	Delete
   	SURVIVOR_OPERATION_TYPE	Upsert

Overview of Oracle Customer Hub (UCM) Data Enrichment Web Services

Oracle Customer Hub (UCM) enables integration with third-party data enrichment providers, such as Acxiom. Oracle Customer Hub (UCM) uses Oracle Application Integration Architecture to provide a prebuilt set of enrichment APIs to enrich consumer records in Oracle Customer Hub (UCM). This service also enriches household and address information for consumer records. The service infrastructure can be extended by small configuration changes to support other third-party customer data enrichment vendors.

Process of Configuring Data Enrichment

To configure for data enrichment, perform the following tasks:

• Creating the Proxy Business Service

• Modifying the Newly Created Proxy Business Service

• Modifying Data Enrichment Business Service User Properties

• Registering the Data Enrichment Web Services

• Configuring the Run-Time Event

Creating the Proxy Business Service

This task is a step in Process of Configuring Data Enrichment.

You perform this task only if you are creating proxy business services using WSDL files provided by a third-party data enrichment Web service.

Note: This configuration task is not required when integrating Oracle Application Integration Architecture with Oracle Customer Hub (UCM). A middleware installation must be completed and set up to handle outbound, data enrichment calls. If you are setting up an integration of Oracle Application Integration Architecture with Oracle Customer Hub (UCM), make sure Oracle Application Integration Architecture is set up and functioning. If Oracle Customer Hub (UCM) is integrated with other middleware, make sure the middleware installation has been completed before proceeding with the following task.

Use the following task to create the proxy business service.

To create the proxy business service

1. From the Siebel Tools File menu, select New Object.

2. In the New Object wizard, click the EAI tab, and click the Web Service Icon.

3. Lock the project Web Service Integration, and lock the Project name.

4. Browse to the location of the WSDL file provided by the third-party data enrichment Web service.

   The run-time data file and log file entries are automatically created.

   Caution: Do not check the Process Fault Schema check box, it will produce unintended results.

5. Click Next.

6. Select the Deploy Integration Objects and Proxy Business Services check box.

7. Click Finish.

8. Search the log files for the entry, Outbound proxy business service definitions to be generated. At the end of the definition, you see the name of the proxy business service that you created.

   For example:

   Outbound proxy business service definitions to be generated: ProcessPersonUCMReqABCSImpl

   In this example, ProcessPersonUCMReqABCSImpl, is the name of the proxy service that was created.

9. When the proxy business service is created, click the Business Services object in the Object Explorer.

Modifying the Newly Created Proxy Business Service

This task is a step in Process of Configuring Data Enrichment.

Note: Perform this step only if you are creating proxy business services, using WSDL files provided by a third-party data enrichment Web service.

Use the following task to modify the newly created business service.

To modify the newly created business service

1. In Siebel Tools Business Services screen, query for the newly created proxy business service.

2. In the Object Explorer, navigate to Business Service Method Arguments.

3. Search for arguments of the type, Integration Object.

4. Note the integration object names, then using the Object Explorer, find and delete the objects.

   The default integration objects will not be used. Instead, the newly imported integration objects will be used.

5. Replace the existing integration object name in the Business Service Method Arguments of the proxy service with the new Integration Object name displayed in the following table.

   Existing Integration Object Name	New Integration Object Name
   Person	SwiPersonIO

Modifying Data Enrichment Business Service User Properties

This task is a step in Process of Configuring Data Enrichment.

Note: This configuration task is not required when integrating Oracle Application Integration Architecture with Oracle Customer Hub (UCM).

Use the following task to modify the Data Enrichment business service.

To modify the Data Enrichment business service

1. In Siebel Tools Business Services screen, query for the Data Enrichment business service.

2. In the Object Explorer, navigate to Business Service User Properties.

3. Make the following changes to the user property definitions.

   Field	New Value
   Proxy Business Service Method	ProcessPerson
   Proxy Business Service Name	ProcessPersonUCMReqABCSImpl. This is the name of the Proxy Business Service created previously this process.
   RequestTypeContact	ProcessPersonReqMsg:ListOfSwiPersonIO This is the name of the input integration object as mentioned in the method arguments of the proxy business service.
   ResponseTypeContact	ProcessPersonRespMsg:ListOfSwiPersonIO This is the name of the output integration object as mentioned in the method arguments of the proxy business service.
   UCMIONameContact	SwiPersonIO

Registering the Data Enrichment Web Services

This task is a step in Process of Configuring Data Enrichment. Use the following task to register data enrichment Web services.

To register data enrichment Web services

1. If you have an integration of Oracle Application Integration Architecture with Axciom, go to Step 2. If you do not have an integration, go to Step 4.

2. From the Outbound Web Services view, query for the following Oracle Application Integration Architecture Web service: ProcessPersonUCMReqABCSImpl.

3. Change the address of the ports corresponding to this Web service to point to the appropriate Oracle Application Integration Architecture end point.

4. If you do not have Axciom Integration, from the Outbound Web Services view, query for the Web service that you created in the following task, Creating the Proxy Business Service.

5. Change the address of the ports corresponding to the Web services to point to the appropriate middleware end point.

Configuring the Run-Time Event

This task is a step in Process of Configuring Data Enrichment. Use the following task to configure the run-time event.

To configure the run-time event

1. In the Siebel Mobile Web client, navigate to the Administration - Runtime Events screen, then the Action Sets view.

2. In the Action Sets screen, click New.

3. Enter the following values in the following table.

   Field	Value
   Name	Choose a name.
   Action Type	BusService.
   Active	Y.
   Sequence	1.
   Business Service Name	DataEnrichment.
   Business Service Method	Data Enrichment
   Conditional Expression	SystemPreference("Enable Data Enrichment") LIKE 'TRUE' AND ( GetProfileAttr("Disable Data Enrichment") IS NULL OR GetProfileAttr("Disable Data Enrichment") LIKE 'FALSE' )

4. From the Action Sets menu, choose Save Record.

5. Navigate to the Events view, and click New.

6. Create a new event by entering the following values:

   Field	Value
   Sequence	Use the lowest sequence number. Note: Each Object and Event can have several associated events, so provide a unique number for each.
   Object Type	BusComp
   Object Name	Contact
   Event	PreWriteRecord
   Action Set Name	The name you provided in Step 3.

7. From the Events menu, select Save Record.

8. Navigate to Administration-Application, then System Preferences.

9. Query for, Enable Data Enrichment, and make sure the System Preference Value is set to True.

Third-Party Data Enrichment Fields

See the following table for a list of the third-party data enrichment fields.

Table Third-Party Data Enrichment Fields

Business Components	Fields	Description
Contact	Consumer Link	Unique key used for Contact in third-party enrichment vendors.
	First Name	First Name of Person.
	Middle Name	Middle Name of Person.
	Last Name	Last Name of Person.
	Name Suffix	Name Suffix of Person.
	JOB TITLE	Job Title of Person.
	GENDER	Gender of Person.
Personal Address	Address Link	Unique key used for the addresses in third-party enrichment vendors.
	Delivery Point Barcode	Postal delivery point barcode.
	Carrier Route Code	A numeric and alpha code that enables mailers to sort mailing in carrier casing sequence order. The eLOT code sorts carrier route coded address records based on the carrier’s line of travel. Address lists must be sorted using the eLOT code to receive any carrier route level discounts, except for walk sequence discounts.
Personal Address (continued)	Postal Address Flags	Internal footnote flags set by the AddressAbility. (AA)/DPV process. Footnotes are displayed as character codes in the form of Yes or No. These flags appear in the field positions listed as follows: 01. AA match at ZIP Code level. 02. AA match at Carrier Route Code level. 03. AA match at ZIP plus 4 level; ZIP plus 4 applied. 04. AA match at ZIP plus 4 level; ZIP plus 4 not applied (Undeliverable). 05. LOT default match. 06. DPV record match. 07-08. Not used. 09. No match; no potentials. 10. No match; primary number missing. 11. No match; out of range. 12. No match; multimatch. 13. No match, due to match in early-warning system. 14. Internal use only. 15. LACSLink match; DPV no match.
Personal Address (continued)	Postal Address Flags (continued)	16. Not used. 17. AA match; DPV no match; ZIP plus 4 dropped. 18-24. Not used. 25. ZIP Code match, verified at street number level. 26. ZIP Code match, verified at street level only. 27. ZIP Code match verified at town level. 28. ZIP plus 4 match made for the address only. 29. ZIP plus 4 match made for the address and secondary (firm) name. 30. Spellcheck match made. 31. ZIP plus 4 default match; missing primary number. 32. ZIP plus 4 default match; missing secondary number. 33. Rural Route default match. 34. Rural Route exact match. 35. High Rise default match. 36. High Rise exact match. 37. Unique ZIP Code match. 38. ZIP Code move match. 39. Not used. 40. DPV commercial mail receiving agency (CMRA) match. 41. Invalid ZIP Code and city identified. 42. ZIP Code and city conflict. 43. ZIP code is invalid. The city is valid. 44. ZIP Code changed or corrected. 45. City changed or corrected. 46. State code changed or corrected.
Personal Address (cont.)	Postal Address Flags (cont.)	47. City and state combination is invalid for ZIP Code. 48. Not used. 49. Primary number changed or corrected. 50. Predirectional changed or corrected. 51. Street changed or corrected. 52. Suffix changed or corrected. 53. Postdirectional changed or corrected. 54. Unit designator changed or corrected. 55. Secondary number changed or corrected. 56. Not used. 57. State blank or invalid. 58. SCF (Sectional Center Facility) blank or invalid. 59. Invalid state or SCF combination. 60. ZIP Code blank or invalid. 61. Invalid city/ZIP Code combination. 62. SuiteLink attempted; matched. Suitelink allows the USPS to append a missing suite number to a company’s address. 63. SuiteLink attempted; no match. 64. Not used.
	DSF Delivery Type	None.
	DSF Seasonal Indicator	None.
	Large Prison Flag	The Zip Code file of all prisons. So if the record matches the prison suppression file the client might want to suppress records that would enter into the prison because of the high probability of fraud.
Personal Address (cont.)	Acxiom Opt Out Inaccurate Record Flag	When this flag is checked propriatary data sources are invoked. When individuals indicate a desire to receieve offers a value of Highly Sensitive is assigned. It can also indicate that the individual has threatened litigation if additional offers are received.
	NCOA Link New Move Effective Date	NCOALink Move Effective Date (YYYYMM).
		NCOALink Move Effective Date (YYYYMM).
UCM Contact Privacy	Overall Suppression Flag	This field can be used as a single look-up rather than having to look up all fields. It might apply to this business component.
	DMA Mail Flag	Direct Marketing Association's email source file for the privacy option preference in email communications.
	DMA Phone Flag	Direct Marketing Association's email source file to the privacy option preference in phone communications
	SAG Phone Flag	Refers to all State Attorneys General (SAG). Includes all Do Not Call files from each state combined.
	DMA Email Flag	Direct Marketing Association's email file. Its email suppression file. Clients must pass prospecting records to this file prior to running email campaigns.
	Acxiom Opt Out Highly Sensitive Flag	The Acxiom Opt-Out Highly Sensitive File is an Acxiom Suppression file that contains names and addresses that are considered highly sensitive. This data includes minors, people who have had their identity stolen, and irate consumers.
	Acxiom Opt Out Deceased Flag	Internal Acxiom Consumer-at-Business Opt-out File. The client chooses not to send email to people who are deceased.
	Deceased Data Flag	Different data source of the deceased file. Clients want to stop sending marketing information to individuals who are deceased.
UCM Contact Privacy (cont.)	Acxiom Opt Out Cons At Bus Flag	The client might want to suppress consumer records at an address. For example, customers provide their marketing address as their home address. However, they requested the product to be shipped to their business address. This field allows customers to suppress the consumer at a business address. For example, you can remove duplicate offers or send information to a preferred address.
	Derogatory Data Flag	The record contains negative comments from the customer. Therefore, the client will be cautious in setting spending limits, extending offers, and so on.
	Bankruptcy Data Flag	The customer is involved in bankruptcy proceedings. Therefore, the client will be cautious in setting spending limits, extending offers, and so on.
	Tax Lien Judgment Flag	Tax Lien and Judgment File. Indicates that the customer has a tax lien on his or her property. Therefore, the client will not want to extend additional offers or credit to the customer.
	FTC Do Not Call Flag	Different data sources for the Do Not Call suppression. Prospect phone numbers must be matched against this file prior to performing telemarketing exercises.
	Wireless Flag	Direct Marketing Association's wireless phone preference file. Legislation forbids telemarketing to cell phones. This flag must be set prior to telemarketing activities.
Household	Household Link	Unique key used for a household in third-party enrichment vendors.
	Home Owner/Renter	Indicates if a household is owner occupied or renter occupied.
	Length Of Residence	Indicates the total time a household has lived at the current address. Specified in ranges.
	1st Individual Age	Indicates the age of the first individual listed in the household.
	Adults in Household	Indicates the number of adults in the household. An adult is anyone 18 years old or older living in a household.
Household (cont.)	1st Individual Education	Indicates the education of the first individual in listed in the household.
	Personicx LifeStage Groups	Personicx is a household-level segmentation method that places each U.S. household into one of 70 segments. The segments are based on specific consumer and demographic characteristics.

Oracle Data Governance Manager Web Services

Table SWIContact Services Operations

Name	Description
SWIContactServicesInsertOrUpdate	Calls Insert or Update method used for inserting a new contact along with the child details into the Siebel database. If the contact is already present in the Siebel database, the Contact will be updated with the details from the request message.
SWIContactServicesQueryByExample	Calls the Query by Example method to Query Contact details along with the child details from the Siebel database.
SWIContactServicesSynchronize	Calls the Synchronize method to synchronize the contact in the request message with the contact details in Siebel. If the child details that are part of the request message are not present in the Siebel database, they will be Inserted and if any additional child are present in the database and not part of request message, those will be deleted from the database.

Table Request Message Description: SWIContactServicesInsertOrUpdate

Node	Description	Type
Alias	Alias of the contact record.	String
CellularPhone	Mobile phone number of the contact.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact’s account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
RowId	Row Id of Siebel Contact record	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Contact record’s status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	Id value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for Organization	String
PersonalAddress	Contact’s home address.	String
Id	Siebel row Id of the Contact record.	String
AddressName	Contact’s address name.	String
City	Contact’s city of residence.	String
Country	Contact’s country of residence.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province, if applicable.	String
State	Contact’s state of residence.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	Id value used for mapping the request and response message.	String

Table Response Message Description: SWIContactServicesInsertOrUpdate

Node	Description	Type
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
RowId	Row Id of Siebel Contact record	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Contact status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	Id value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for organization record.	String
PersonalAddress	Contact’s home address.	String
Id	Row Id of the Contact record In Siebel.	String
AddressName	Address name	String
City	Contact’s city.	String
Country	Contact’s country.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province (if applicable).	String
State	Contact’s state.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	Id value used for mapping the request and response message.	String

Table Request Message Description: SWIContactServicesQueryByExample

Node	Description	Type
RowId	Row Id of Siebel Contact record	String
ListOfAccount	List of Account records.	String
ListofPersonalAddress	List of personal address records of contact.	String
PersonalAddress	Contact’s personal address.	String

Table Response Message Description: SWIContactServicesQueryByExample

Node	Description	Type
Id	Row Id.	String
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mother’s maiden name.	String
PrimaryOrganizationId	Primary organization for contact.	String
RowId	Row Id in Siebel data table.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status of contact record.	String
WorkPhone	Contact’s work telephone number.	String
ListofAccount	Container for Account.	Integration Component
ListofComInvoiceProfile	Container for invoice profile.	Integration Component
ListofOrganization	Container for Organization.	Integration Component
ListofPersonalAddress	Container for personal address records.	Integration Component
PersonalAddress	Contact’s personal address.	String
ListofUCMContactPrivacy	Privacy details for Contact record.	Integration Component

Table Request Message Description: SWIContactServicesSynchronize

Node	Description	Type
Id	Row Id.	String
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact’s account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mother’s maiden name.	String
PrimaryOrganizationId	Primary organization for contact.	String
RowId	Row Id in Siebel data table.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status of contact record.	String
WorkPhone	Contact’s work telephone number.	String
AIAIntegrationId	Id value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for Organization.	Integration Component
ListofPersonalAddress	Container for personal address records.	Integration Component

Table Response Message Description: SWIContactServicesSynchronize

Node	Description	Type
Id	Row Id.	String
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact’s account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mother’s maiden name.	String
PrimaryOrganizationId	Primary organization for contact.	String
RowId	Row Id in Siebel data table.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status of contact record.	String
WorkPhone	Contact’s work telephone number.	String
AIAIntegrationId	Id value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for Organization.	Integration Component
ListofPersonalAddress	Container for personal address records.	Integration Component

Table SWIContactService Service Object

Siebel Repository Name	Boundary Object Type	Class
SWI Contact Service	Business Service	CSSEAIDataSyncService

Table SWIContactService Data Object

Siebel Repository Name	External Name
SWIContactIO	SWI Contact

Table SWICustomerPartyService Operations

Name	Description
SWICustomerPartyInsertOrUpdate	Calls the Insert or Update method used for inserting a new account along with the child details into the Siebel database. If the account is already present in the Siebel database the account will be updated with any new details contained in the request message.
SWICustomerPartyQueryByExample	Calls the Query by Example method to query the Siebel database for account details along with any child details.
SWICustomerPartySynchronize	Calls Synchronize method to synchronize the account record contained in the request message with the account details in Siebel database. If the child details that are part of request message are not present in the Siebel database, the details will inserted and if any additional child are present in the Siebel database, are not part of request message those details will be deleted from the database.

Table Request Message Description: SWICustomerPartyInsertOrUpdate

Node	Description	Type
ListofSwicustomerpartyIO	An instance of the Integration Object ListofSwicustomerpartyIO.	Integration Object
The following nodes apply to SwicustomerpartyIO
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
MainFaxNumber	Main fax number of account.	String
MainPhoneNumber	Main phone number of account.	String
Name	Account name.	String
HomePage	Account’s home page address.	String
AIAIntegrationId	Id value used for mapping the request message and response message account details.	String
Location	Account’s location.	String
RowId	Row Id of Siebel Account record.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details	Integration Component
ListofInternalDivision	Internal division details.	Integraton Component
City	City where account is located.	String
Country	Country where acccount is located.	String
County	County where acccount is located.	String
PostalCode	Postal code of account.	String
Province	Province (if applicable) where account is located.	String
AIAIntegrationId	Contact’s social security number.	String
Status	Contact status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	Id value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for organization record.	String
PersonalAddress	Contact’s home address.	String
Id	Row Id of the Contact record in Siebel data table.	String
AddressName	Address name	String
City	Contact’s city.	String
Country	Contact’s country.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province (if applicable).	String
State	Contact’s state.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	Id value used for mapping the request and response message.	String

Table Response Message Description: SWICustomerPartyInsertOrUpdate

Node	Description	Type
ListofSwicustomerpartyIO	An instance of the Integration Object ListofSwicustomerpartyIO.	Integration Object
The following nodes apply to SwicustomerpartyIO
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
HomePage	Account’s home page address.	String
Location	Account’s location.	String
MainFaxNumber	Account’s main fax number.	String
MainPhoneNumber	Account’s main phone number.	String
Name	Account name.	String
AIAIntegrationId	Id value used for mapping the request message and response message account details.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details	Integration Component
ListOfInternalDivision	Internal division details.	Integration Component

Table Request Message Description: SWICustomerPartyQueryByExample

Node	Description	Type
ListofSwicustomerpartyIO	An instance of the Integration Object ListofSwicustomerpartyIO.	Integration Object
The following nodes apply to SwicustomerpartyIO
RowId	Row Id of account in Siebel data table.	String
ListofCutAddress	Optional. Business address.	Integration Component

Table Response Message Description: SWIContactServicesQueryByExample

Node	Description	Type
ListofSwicustomerpartyIO	An instance of the Integration Object ListofSwicustomerpartyIO.	Integration Object
The following nodes apply to SwicustomerpartyIO
Account	Account name.	String
AccountStatus	Status of account record.	String
AccountTypeCode	Dun and Bradstreet data universal numbering system number.	String
CurrencyCode	Account’s currency code.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
HomePage	Homepage of account	String
IntegrationId	Integration Id.	String
Location	Account location.	String
MainFaxNumber	Main fax number of account.	String
MainPhoneNumber	Main phone number of account.	String
Name	Account name.	String
ParentAccountId	Account Id of parent account.	String
PrimaryAddressId	Primary address of account.	String
PrimaryBillToAddressId	Primary billing address of account.	String
PrimaryContactId	Primary Contact Id for the account.	String
PrimaryOrganizationId	Primary Organization Id for the account.	String
PrimaryShipToAddress	Primary shipping address for the account.	String
RowId	Row Id in Siebel data table.	String
Type	Account type.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details	Integration Component
ListofInternalDivision	Internal division details.	Integraton Component

Table Request Message Description: SWICustomerPartySynchronize

Node	Description	Type
ListofSwicustomerpartyIO	An instance of the Integration Object ListofSwicustomerpartyIO.	Integration Object
The following nodes apply to SwicustomerpartyIO
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
MainFaxNumber	Main fax number of account.	String
MainPhoneNumber	Main phone number of account.	String
Name	Account name.	String
HomePage	Account’s home page address.	String
AIAIntegrationId	Id value used for mapping the request message and response message account details.	String
Location	Account’s location.	String
RowId	Row Id of Siebel Account record.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details	Integration Component
ListofInternalDivision	Internal division details.	Integraton Component
City	City where account is located.	String
Country	Country where acccount is located.	String
County	County where acccount is located.	String
PostalCode	Postal code of account.	String
Province	Province (if applicable) where account is located.	String
AIAIntegrationId	Contact’s social security number.	String
Status	Contact status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	Id value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for organization record.	String
PersonalAddress	Contact’s home address.	String
Id	Row Id of the Contact record in Siebel data table.	String
AddressName	Address name	String
City	Contact’s city.	String
Country	Contact’s country.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province (if applicable).	String
State	Contact’s state.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	Id value used for mapping the request and response message.	String

Table Response Message Description: SWICustomerPartySynchronize

Node	Description	Type
ListofSwicustomerpartyIO	An instance of the Integration Object ListofSwicustomerpartyIO.	Integration Object
The following nodes apply to SwicustomerpartyIO
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
HomePage	Account’s home page address.	String
Location	Account’s location.	String
MainFaxNumber	Account’s main fax number.	String
MainPhoneNumber	Account’s main phone number.	String
Name	Account name.	String
AIAIntegrationId	Id value used for mapping the request message and response message account details.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details	Integration Component
ListOfInternalDivision	Internal division details.	Integraton Component

Table Service Object

Siebel Repository Name	Boundary Object Type	Class
SWI Customer Party Service	Business Service	CSSEAIDataSyncService

Table Data Object

Siebel Repository Name	External Name
SWICustomerPartyIO	Account

Table SWIMergeService Operations

Name

Description

SWIMergeServicesMerge

Calls Merge method of the Business Service SWI Merge Service which is used for merging one or more accounts to another account record. This Web service merges child records of the losing objects to the wining object and deletes the losing object records. Takes the Business Object name, Business Component name, one wining record's Id value and one or more losing record's Id values as the arguments in .xml format.

Table Request Message Description: SWIMergeServicesMerge

Node	Description	Type
ListOfSwimergeobjectIO	An instance of the Integration Object ListofSwimergeobjectIO.	Integration Object
The following nodes apply to ListOfSwimergeobjectIO
BusinessComponentName	Name of business component.	String
BusinessObjectName	Name of business object.	String
MergeId	Id number assigned to merged item.	String
ListofSwiLosingObject	Container element for the Losing Object details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object.	Integration Component
ListOfSwiWinningObject	Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object.	Integration Component

Table Response Message Description: SWIMergeServicesMerge

Node	Description	Type
ListOfSwimergeobjectIO	An instance of the Integration Object ListofSwimergeobjectIO.	Integration Object
The following nodes apply to ListOfSwimergeobjectIO
BusinessComponentName	Name of business component.	String
BusinessObjectName	Name of business object.	String
MergeId	Id number assigned to merged item.	String
ListofSwiLosingObject	Container element for the Losing Object details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object.	Integration Component
ListOfSwiWinningObject	Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object.	Integration Component

Table SWIMergeService Service Object

Siebel Repository Name	Boundary Object Type	Class
SWIMergeService	Business Service	CSSMergeService

Table sWIMergeService Data Object

Siebel Repository Name	External Name
SWIMergeObjectIO	SWI Merge Object

Table SWIProductImport Operations

Name	Description
SWIProductImportUpsert	Calls 'Insert or Update' method of the Business Service 'SWI Product Import' used for inserting a new product details in to Siebel. If the product is already present in Siebel the product will be updated with the details from the request message.

Table Request Message Description: SWIProductImportUpsert

Node	Description	Type
ActiveFlag	Indicates whether record is active.	String
BillableFlag	Indicates whether record is billable.	String
BusinessUnitId	Id of business unit associated with product record.	String
Description	Description.	String
EffectiveEndDate	Effective end date of record.	String
EffectiveStartDate	Effective start date of record.	String
ExternalInventorySystemRef	Reference number from external inventory system.	String
IntegrationId	Integration Id.	String
InventoryFlag	Flag to indicate if product is tracked in inventory.	String
LeadTime	Lead time for product delivery.	String
ProductCost	Cost of product.	String
ProductName	Name of product.	String
ProductSerializedFlag	Serialized flag. Indicates if instances of this product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number.	String
ProductVersion	Version of product.	String
ReleaseFlag	Flag which indicates whether a product will be released at the time of a synchronization.	String
SalesProductFlag	Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity.	String
ServiceTerms	Service terms associated with product.	String
ShipFlag	Flag to indicate whether a product has to be shipped.	String
Status	Status of product. Active or Inactive.	String
StructureType	Depending on the product type, users may be allowed to create a simple bill of materials without using Siebel Product Configurator.	String
UnitofMeasure	Unit of measure.	String
ListofProductInvloc	Location of product in inventory.	String

Table Response Message Description: SWIProductImportUpsert

Node	Description	Type
Id	Product Id.	String
ActiveFlag	Indicates whether record is active.	String
AutoExplodeFlag	Indicates whether or not the product should be automatically ungrouped and enforce ungrouped quantity equal to 1.	String
BillableFlag	Indicates whether record is billable.	String
BusinessUnitId	Id of business unit associated with product record.	String
CheckEligibilityFlag	Indicates whether or not to apply eligibility and compatibility rules for this product.	String
Description	Description of product.	String
EffectiveEndTime	Effective end date of record.	String
EffectiveStartTime	Effective start date of record.	String
ExternalInventorySystemRef	Reference number from external inventory system.	String
InclusiveEligibilityFlag	Indicates whether or not to process a particular product for inclusive eligibility rules. Inclusive eligibility rules are defined in the eligibility matrix with matrix rule type code set as Inclusive.	String
IntegrationId	Integration Id.	String
InventoryFlag	Flag which indicates if a product is tracked in inventory.	String
LeadTime	Lead time for product delivery.	String
OrderableFlag	Flag which indicates whether a product is orderable.	String
PriceType	Price type, such as One-time, Recurring, Usage and so on.	String
PrimaryOrganizationId	Id of primary organization associated with product record.	String
ProductCost	Cost of product.	String
ProductId	Id of product.	String
ProductName	Name of product.	String
ProductSerializedFlag	Serialized flag. Indicates if instances of this product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number.	String
ProductType	Product type.	String
ProductVersion	Product version.	String
ReleaseFlag	Flag which indicates whether a product will be released at the time of a synchronization.	String
SalesProductFlag	Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity.	String
ServiceInstanceFlag	Flag to indicate whether a product requires a metering point.	String
ServiceProductFlag	Sales and Service flag. Sales service products are services that are priced based on the tangible product for which they are purchased (an extended warranty, for example). These products appear on the picklist that pops up when the user clicks the Service button for a tangible product on a quote. When you choose a sales service product from the list, a new quote item for the product is added to the quote and priced according to the value of the tangible product to which it applies.	String
ShipFlag	Flag to indicate whether a product needs to be shipped.	String
Status	Status of product order.	String
StructureType	Depending on the product type, users may be allowed to create a simple bill of materials without using Siebel Product Configurator.	String
TrackAsAssetFlag	Flag to indicate that a product should be tracked as an asset.	String
Type	Product type.	String
UnitofMeasure	Unit of measure.	String
VendorId	Id of product vendor.	String
ListofProductInvLoc	Location of product in inventory.	String

Table SWIProductImport Service Object

Siebel Repository Name	Boundary Object Type	Class
SWI Product Import	Business Service	CSSCMUProdWebSvc

Table SWIProductImport Data Object

Siebel Repository Name	External Name
SWIProductIntegrationIO	SWI Product Integration

Services

The following Web services are used to perform operations for Oracle Data Governance Manager. These Web services include:

• SystemsRegistration Service

• MasterService

• ConsolidateService

• ShareService

• CleanseCompletenessService

• GovernService

SystemsRegistration Service

Use this Web service to query details of all systems registered with Oracle Customer Hub (UCM).

SystemsRegistrationService Operations

For a list of the operations associated with this Web service, see the following table.

Table SystemsRegistrationService Operations

Name	Description
getSystemsRegistrationInfo	Queries the details of all systems registered with Oracle Customer Hub (UCM).

Request Message Description: getSystemsRegistrationInfo

There is no request message for this operation.

Response Message Description: getSystemsRegistrationInfo

For a description of this response message, see the following table.

Table Response Message Description: getSystemsRegistrationInfo

Node	Description	Type
SwiSystemInfoIO	An instance of the integration object, SwiSystemInfoIO.	Integration Object
errorMessage	Specific error message.	String

SystemsRegistrationService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table SystemsRegistrationService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Data Governance Manager	Business Service	CSSUCMDataGovernanceManagerService

Methods

For a description of the methods for this Web service, see the following table.

Table SystemsRegistrationService Methods

Operation	Method
getSystemsRegistrationInfo	getSystemsRegistrationInfo

ConsolidateListImportService

The List Import function serves as a standalone Web service. It is invoked from Oracle Data Governance Manager. It creates an import job and activates it. The ConsolidateListImportService can be used with any supported application within your system to load data into Oracle Customer Hub (UCM) by calling the Web service and using the required inputs.

ConsolidateListImportService Operations

For a list of the operations associated with this Web service, see the following table.

Table ConsolidateListImportService Operations

Name	Description
obtainTemplateList	Returns details from all Import Mappings that are currently present in the List Import function. These mappings are then used to import records from text or XML files into Oracle Customer Hub (UCM).
submitNewImport	Takes information about a List Import job, such as import mapping, file stream, data type, and so on. It then creates and submits the import job.

Request Message Description: obtainTemplateList

There is no request message for this Web service.

Response Message Description: obtainTemplateList

For a description of this response message, see the following table.

Table Response Message Description: obtainTemplateList

Node	Description	Type
SwiImportMapsIO	An instance of the integration object, SwiImportMaps.	Integration Object
errorMessage	Specific error message.	String

Request Message Description: submitNewImport

For a description of this request message, see the following table.

Table Request Message Description: submitNewImport

Node	Description	Type
ImportJobsParams (UCMImportJob)	Specifies the parameters for the UCM import job.	String.

Response Message Description: obtainTemplateList

There is no response message for this Web service.

ConsolidateListImportService Service Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table ConsolidateListImportService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCMListImportService	Business Service	CSSUCMListImportService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table ConsolidateListImportService Data Object

Siebel Repository Name	External Name
UCMImportJobIO	UCM Import Job

Methods

For a description of the methods for this Web service, see the following table.

Table ConsolidateListImportService Methods

Operation	Method
obtainTemplateList	obtainTemplateList
submitNewImport	submitNewImport

MasterService

This Web service is used with the Master module to query and return mastered records from a given period.

MasterService Operations

For a list of the operations associated with this Web service, see the following table.

Table Master Entities Report Service Operations

Name	Description
getMasterEntitiesCount	Returns the number of mastered Account or Contact records in a given period. The input is given in the form of an integration object where the object and search specification are specified.
getMasterOrganizationDetails	Returns details of the mastered Account records from a given period.
getMasterPersonDetails	Returns details of the mastered Contact records from a given period.

Request Message Description: getMasterEntitiesCount

For a description of this request message, see the following table.

Table Request Message Description: getMasterEntitiesCount

Node	Description	Type
startDateTime	Start date and time for a given job.	String
endDateTime	End date and time for a given job.	String
SwiRecordCountIO	An instance of the integration object, SwiRecordCount.	Integration Object

Response Message Description: getMasterEntitiesCount

For a description of this response message, see the following table.

Table Response Message Description: getMasterEntitiesCount

Node	Description	Type
SwiRecordCountIOResults	An instance of the integration object, SwiRecordCountResults.	Integration Object
errorMessage	Specific error message.	String

Request Message Description: getMasterOrganizationDetails

For a description of this request message, see the following table.

Table Request Message Description: getMasterOrganizationDetails

Node	Description	Type
startDateTime	Start date and time for a given job.	String
endDateTime	End date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
SearchSpec	Search specification for the Account or Contact business component.	String
NewQuery	Starts a new query.	String

Response Message Description: getMasterOrganizationDetails

For a description of this response message, see the following table.

Table Response Message Description: getMasterOrganizationDetails

Node	Description	Type
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String
SwiOrgIO	An instance of the integration object, SwiOrgIO.	Integration Object

Request Message Description: getMasterPersonDetails

For a description of this request message, see the following table.

Table Request Message Description: getMasterPersonDetails

Node	Description	Type
startDateTime	Start date and time for a given job.	String
endDateTime	End date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
NewQuery	Starts a new query.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
SearchSpec	Search specification for the Account or Contact business component.	String

Response Message Description: getMasterPersonDetails

For a description of this response message, see the following table.

Table Response Message Description: getMasterPersonDetails

Node	Description	Type
errorMessage	Specific error message.	String
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String

MasterService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table MasterService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Data Governance Manager	BusinessService	CSSSwiUCMDGMgrService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table MasterService Data Object

Siebel Repository Name	External Name
SwiOrgIO	Account
SwiPerIO	Contact

Methods

For a description of the methods for this Web service, see the following table.

Table MasterService Methods

Operation	Method
getMasterEntitiesCount	getMasterEntitiesCount
getMasterOrganizationDetails	getMasterOrganizationDetails
getMasterPersonDetails	getMasterPersonDetails

ConsolidateService

This Web service is used with the Consolidate module to query and return batch-report information from account and contact batch reports run in a given period.

ConsolidateService Operations

For a list of the operations associated with this Web service, see the following table.

Table ConsolidateService Operations

Name	Description
getBatchProcessReport	Returns the Completed, In Progress, and Pending batches from a given period. Return the details (System, BatchID, Description and so on) of a batch in the form of an Integration Object .
getSpecificBatchReport	Returns the count of Completed, Pending and Rejected records in a particular batch (matching with Batch ID).
getCompletedRecordsBatchReport	Returns the number of Inserts or Updates that occurred as part of a completed batch job. The records are mastered as part of the batch job, and a field called Actual Operation stores the information of the operation that took place.
getOrgRejectRecordsDetailReport	Returns the details of all Account records that were rejected as part of a particular batch.
getPerRejectRecordsDetailReport	Returns the details of all Contact records that were rejected as part of a particular batch.
updateOrgBatchRejectedRecords	Allows the user to submit corrected information to the field values of the rejected account records. Then the values in the SDH table are updated. This operation also sets the UCM Type Code to Queued or Batch so that these corrected records can be picked up in the next Batch process iteration.
updatePerBatchRejectedRecords	Allows the user to submit the corrected information to the field values of the rejected contact records. Then the values in the SDH table are updated. This operation also sets the UCM Type Code to Queued or Batch, so that these corrected records can be picked up in the next batch process iteration.

Request Message Description: getBatchProcessReport

For a description of this request message, see the following table.

Table Request Message Description: getBatchProcessReport

Node	Description	Type
startDateTime	Start date and time for a given job.	String
endDateTime	End date and time for a given job.	String

Response Message Description: getBatchProcessReport

For a description of this response message, see the following table.

Table Response Message Description: getBatchProcessReport

Node	Description	Type
SwiBatchInfoIO	An instance of the integration object, SwiBatchInfo.	Integration Object
errorMessage	Specific error message.	String

Request Message Description: getSpecificBatchReport

For a description of this request message, see the following table.

Table Request Message Description: getSpecificBatchReport

Node	Description	Type
BatchID	Required. Batch ID number of the batch report.	String
Object	Account or Contact.	String

Response Message Description: getSpecificBatchReport

For a description of this response message, see the following table.

Table Response Message Description: getSpecificBatchReport

Node	Description	Type
CompletedRecordsCount	Number of records successfully completed in a batch report.	String
PendingRecordsCount	Number of records pending for a batch report.	String
RejectedRecordsCount	Number of records rejected during a batch report.	String
errorMessage	Specific error message.	String

Request Message Description: getCompletedRecordsBatchReport

For a description of this request message, see the following table.

Table Request Message Description: getCompletedRecordsBatchReport

Node	Description	Type
BatchID	Required. Batch ID number of the batch report.	String
Object	Account or Contact.	String

Response Message Description: getCompletedRecordsBatchReport

For a description of this response message, see the following table.

Table Response Message Description: getCompletedRecordsBatchReport

Node	Description	Type
NumofInserts	Number of completed inserts in the batch report.	String
NumofUpserts	Number of completed upserts in the batch report.	String
errorMessage	Specific error message.	String

Request Message Description: getOrgRejectRecordsDetailReport

For a description of this request message, see the following table.

Table Request Message Description: getOrgRejectRecordsDetailReport

Node	Description	Type
BatchID	Required. Batch ID number of the batch report.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpect	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String

Response Message Description: getOrgRejectRecordsDetailReport

For a description of this response message, see the following table.

Table Response Message Description: getOrgRejectRecordsDetailReport

Node	Description	Type
SwiBatchOrgIO	An instance of the integration object, SwiBatchOrg.	Integration Object
errorMessage	Specific error message.	String
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String

Request Message Description: getPerRejectRecordsDetailReport

For a description of this request message, see the following table.

Table Request Message Description: getPerRejectRecordsDetailReport

Node	Description	Type
BatchID	Required. Batch ID number of the batch report.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpect	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String

Response Message Description: getPerRejectRecordsDetailReport

For a description of this response message, see the following table.

Table Response Message Description: getPerRejectRecordsDetailReport

Node	Description	Type
SwiBatchPerIO	An instance of the integration object, SwiBatchPer.	Integration Object
errorMessage	Specific error message	String
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String

Request Message Description: updateOrgBatchRejectedRecords

For a description of this request message, see the following table.

Table Request Message Description: updateOrgBatchRejectedRecords

Node	Description	Type
BatchID	Required. Batch ID number of the batch report.	String
SwiBatchOrgIO	An instance of the integration object, SwiBatchOrg.	Integration Object

Response Message Description: updateOrgBatchRejectedRecords

For a description of this response message, see the following table.

Table Request Message Description: updateOrgBatchRejectedRecords

Node	Description	Type
errorMessage	Specific error message	String

Request Message Description: updatePerBatchRejectedRecords

For a description of this request message, see the following table.

Table Request Message Description: updatePerBatchRejectedRecords

Node	Description	Type
BatchID	Required. Batch ID number of the batch report.	String
SwiBatchPerIO	An instance of the integration object, SwiBatchPer.	Integration Object

Response Message Description: updatePerBatchRejectedRecords

For a description of this response message, see the following table.

Table Request Message Description: updatePerBatchRejectedRecords

Node	Description	Type
errorMessage	Specific error message.	String

ConsolidateService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table Consolidate Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Data Governance Manager	Business Service	CSSSwiUCMDGMgrService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table ConsolidateService Data Object

Siebel Repository Name	External Name
SwiBatchInfoIO	SwiBatchInfoIO
SwiBatchOrgIO	UCM Account Source Data and History
SwiBatchPerIO	UCM Contact Source Data and History

Methods

For a description of the methods for this Web service, see the following table.

Table ConsolidateService Details Methods

Operation	Method
getBatchProcessReport	getBatchProcessReport
getSpecificBatchReport	getSpecificBatchReport
getCompletedRecordsBatchReport	getCompletedRecordsBatchReport
getOrgRejectRecordsDetailReport	getOrgRejectRecordsDetailReport
getPerRejectRecordsDetailReport	getPerRejectRecordsDetailReport
updateOrgBatchRejectedRecords	updateOrgBatchRejectedRecords
updatePerBatchRejectedRecords	updatePerBatchRejectedRecords

ShareService

This Web service is used with the Share module to return modified, merged, and unmerged records for Account and Contact business objects run in a given period.

ShareService Operations

For a list of the operations associated with this Web service, see the following table.

Table ShareService Web Service Operations

Name	Description
getShareInfo	Returns modified, merged and unmerged records (Account or Contact) in the given period. Only real-time operations are counted.

Request Message Description: getShareInfo

For a description of this request message, see ShareService Operations.

Table Request Message Description: getShareInfo

Node	Description	Type
startDateTime	Start date and time for a given job.	String
endDateTime	End date and time for a given job.	String
Object	Account or Contact.	String

Response Message Description: getShareInfo

For a description of this response message, see ShareService Operations.

Table Response Message Description: getShareInfo

Node	Description	Type
MergeRecCount	Total of merged records.	String
UnmergeRecCount	Total of unmerged records.	String.
ModifiedCount	Total number of modified records.	String
errorMessage	Specific error message.	String

ShareService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

ServiceObject (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table Share Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Data Governance Manager	Business Service	CSSSwiUCMDGMgrService

Methods

For a description of the methods for this Web service, see the following table.

Table ShareService Methods

Operation	Method
getShareInfo	getShareInfo

CleanseCompletenessService

This Web service is used to query information on incomplete records of both Oracle Customer Hub (UCM) and source systems. Information is returned as a percentage of the total number of incomplete records.

CleanseCompletenessService Operations

For a list of the operations associated with this Web service, see the following table.

Table CleanseCompletenessService Operations

Name	Description
getHubCompleteComplianceInfo	Queries base table records which, based on the date and the object, are found to be incomplete based on user specified criteria.
getSourceCompleteComplianceInfo	Queries SDH table source records which are found to be incomplete based on user specified criteria. Fields used to make the determination are: date, object and source system.
getSystemsRegistrationInfo	Queries for and returns information from systems registered with Oracle Customer Hub (UCM).
getHubOrgIncompleteDetail	Queries Oracle Customer Hub (UCM) for details of the incomplete records from the account base table. The query is based on user specified criteria.
getHubPerIncompleteDetail	Queries Oracle Customer Hub (UCM) for details of the incomplete records from the contact base table. The query is based on user specified criteria.
getSrcOrgIncompleteDetail	Queries Oracle Customer Hub (UCM) for details of the source incomplete records from the account base table. The query is based on user specified criteria.
getSrcPerIncompleteDetail	Queries Oracle Customer Hub (UCM) for details of the source incomplete records from the contact base table. The query is based on user specified criteria.

Request Message Description: getHubCompleteComplianceInfo

For a description of this request message, see the following table.

Table Request Message Description: getHubCompleteComplianceInfo

Node	Description	Type
startDateTime	Start date and time for a given job.	String
endDateTime	End date and time for a given job.	String
ObjectName	Business object name of the completeness report. It is one of the following: Contact or Account.	String
SwiOrgIO	An instance of the integration object SWIOrg.	Integration Object
SwiPerIO	An instance of the integration object SwiPer.	Integration Object

Response Message Description: getHubCompleteComplianceInfo

For a description of this response message, see the following table.

Table Response Message Description: getHubCompleteComplianceInfo

Node	Description	Type
CompletenessPercentage	Percentage of completed records.	String
NumofInCompleteRecords	Number of completed records.	String
TotalRecords	Total records run.	String
ErrorMessage	Specific error message.	String

Request Message Description: getSourceCompleteComplianceInfo

For a description of this request message, see the following.

Table Request Message Description: getSourceCompleteComplianceInfo

Node	Description	Type
startDateTme	Start date and time for a given job.	String
endDateTime	End date and time for a given job.	String
ObjectName	Business Object name. Either Contact, or Account.	String
SwiOrgSDHIO	An instance of the integration object, SwiOrgSDH.	Integration Object
SwiPerSDHIO	An instance of the integration object, SwiPerSDH.	Integration Object
SourceSystem	A registered source system contributing to changes in Oracle Customer Hub (UCM).	String

Response Message Description: getSourceCompleteComplianceInfo

For a description of this response message, see the following table.

Table Response Message Description:getSourceCompleteComplianceInfo

Node	Description	Type
CompletenessPercentage	Percentage of completed records.	String
NumofInCompleteRecords	Number of completed records.	String
TotalRecords	Total records run.	String
ErrorMessage	Specific error message.	String

Request Message Description: getHubOrgIncompleteDetail

For a description of this request message, see the following table.

Table Request Message Description: getHubOrgIncompleteDetail

Node	Description	Type
endDateTime	End date and time for a given job.	String
startDateTime	Start date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String
SwiOrgIO	An instance of the integration object, SwiOrg.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: getHubOrgIncompleteDetail

Node	Description	Type
SwiOrgIO	An instance of the integration object, SwiOrgIO.	Integration Object
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String
errorMessage	Specific error message.	String

For a description of this request message, see the following table.

Table Request Message Description: getHubPerIncompleteDetail

Node	Description	Type
endDateTime	End date and time for a given job.	String
startDateTime	Start date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String
SwiPerIO	An instance of the integration object, SwiPer.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: getHubPerIncompleteDetail

Node	Description	Type
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String
SwiPerIO	An instance of the integration object SwiPer.	Integration Object

For a description of this request message, see the following table.

Table Request Message Description: getSrcOrgIncompleteDetail

Node	Description	Type
endDateTime	End date and time for a given job.	String
startDateTime	Start date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String
SwiOrgSDHIO	An instance of the integration object SwiOrgSDH.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description:getSrcOrgIncompleteDetail

Node	Description	Type
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of output integration objects	String
SwiOrgSDHIO	An instance of the integration object, SwiOrgSDH.	Integration Object

For a description of this request message, see the following table.

Table Request Message Description: getSrcPerIncompleteDetail

Node	Description	Type
endDateTime	End date and time for a given job.	String
startDateTime	Start date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String
SwiPerSDHIO	An instance of the integration object SwiPerSDH.	Integration Object

For a description of this response message, see the following table.

Table Response Message Description: getSrcPerIncompleteDetail

Node	Description	Type
SwiOrgSDHIO	An instance of the integration object, SwiOrgSDH.	Integration Object
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String
errorMessage	Specific error message.	String

CleanseCompletenessService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table CleanseCompletenessService Object

Siebel Repository Name	Boundary Object Type	Class
UCM Data Governance Manager	Business Service	CSSSwiUCMDGMgrService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Table CleanseCompletenessService Data Object

Siebel Repository Name	External Name
SwiOrgIO	Account
SwiPerIO	Contact
SwiOrgSDHIO	UCM Account Source Data and History
SwiPerSDHIO	UCM Contact Source Data and History

Methods

For a description of the methods for this Web service, see the following table.

Table CleanseCompletenessService Methods

Operation	Method
getHubCompleteComplianceInfo	getHubCompleteComplianceInfo
getSourceCompleteComplianceInfo	getSourceCompleteComplianceInfo
getSystemsRegistrationInfo	getSystemsRegistrationInfo
getHubOrgIncompleteDetail	getHubOrgIncompleteDetail
getHubPerIncompleteDetail	getHubPerIncompleteDetail
getSrcOrgIncompleteDetail	getSrcOrgIncompleteDetail
getSrcPerIncompleteDetail	getSrcPerIncompleteDetail

GovernService

This Web service queries all the Account and Contact suspect records in the base table. It provides a means do the following:

• Approve suspect records to resolve nonsuspect records.

• Submit merge requests for suspect records that must be merged.

GovernService Operations

For a list of the operations associated with this Web service, see the following table.

Table GovernService Operations

Name	Description
getOrganizationSuspectRecords	Queries all account records marked Suspect in the base table.
getPersonSuspectRecords	Queries all contact records marked Suspect in the base table.
removePendingRecord	Removes the pending flag for the account or contact record marked as Suspect in the base table.
submitMergeRequestOrganizationRecord	Submits a merge request for the account records in the base table.
submitMergeRequestPersonRecord	Submits a merge request for the contact records in the base table.

Request Message Description: getOrganizationSuspectRecords

For a description of this request message, see the following table.

Table Request Message Description: getOrganizationSuspectRecords

Node	Description	Type
endDateTime	End date and time for a given job.	String
startDateTime	Start date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String

Response Message Description: getOrganizationSuspectRecords

For a description of this response message, see the following table.

Table Response Message Description: getOrganizationSuspectRecords

Node	Description	Type
SwiOrgDeDupResultsIO	An instance of the integration object, SwiOrgDeDupResults.	Integration Object
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String
ErrorCode	Error code (if any) that must be passed for the job.	String
ErrorMessage	Specific error message.	String

Request Message Description: getPersonSuspectRecords

For a description of this request message, see the following table.

Table Request Message Description: getPersonSuspectRecords

Node	Description	Type
endDateTime	End date and time for a given job.	String
startDateTime	Start date and time for a given job.	String
StartRowNum	The row number of the total number of records from which the records are to be given.	String
PageSize	Indicates the number of records to be returned.	String
SortSpec	The sort criteria applied to the business component.	String
NewQuery	Starts a new query.	String

Response Message Description: getPersonSuspectRecords

For a description of this response message, see the following table.

Table Response Message Description: getPersonSuspectRecords

Node	Description	Type
SwiPerDeDupResultsIO	An instance of the integration object, SwiPerDeDupResults.	Integration Object
LastPage	Boolean indicating whether or not the last record in the query result set has been returned.	String
NumOutputObjects	Number of records being returned in this iteration of the request result set.	String
ErrorCode	Error code (if any) that must be passed for the job.	String
ErrorMessage	Specific error message.	String

Request Message Description: removePendingRecord

For a description of this request message, see the following table.

Table Request Message Description: removePendingRecord

Node	Description	Type
Id	Record ID.	String
ObjectName	Business object name, which is one of the following: contact or account.	String
PendingStatus	The pending status of the record.	String

For a description of this response message, see the following table.

Table Response Message Description: removePendingRecord

Node	Description	Type
Status	Status of the record.	String
ErrorCode	Error code (if any) that must be passed for the job.	String
ErrorMessage	Specific error message.	String

For a description of this request message, see the following table.

Table Request Message Description: submitMergeRequestOrganizationRecord

Node	Description	Type
MatchId	Row ID of the duplicate record which is to be merged with the Master record.	String
MasterId	Row ID of the Master record for which duplicates have been found.	String

For a description of this response message, see the following table.

Table Response Message Description: submitMergeRequestOrganizationRecord

Node	Description	Type
ResponseMessage (UCMMergeRequestRs)	Response message to the UCM Merge request.	String
ErrorCode	Error code (if any) that must be passed for the job.	String
ErrorMessage	Specific error message.	String

For a description of this request message, see the following table.

Table Request Message Description: submitMergeRequestPersonRecord

Node	Description	Type
MatchId	Match ID.	Not applicable
MasterId	Master ID.	Not applicable

For a description of this response message, see the following table.

Table Response Message Description: submitMergeRequestPersonRecord

Node	Description	Type
ResponseMessage (UCMMergeRequestRs)	Response message to the UCM Merge request.	String.
ErrorCode	Error code (if any) that must be passed for the job.	String
ErrorMessage	Specific error message.	String

GovernService Application Interface

This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Table GovernService Service Object

Siebel Repository Name	Boundary Object Type	Class
UCM Data Governance Manager	Business Service	CSSSwiUCMDGMgrService

Methods

For a description of the methods for this Web service, see the following table.

Table GovernService Methods

Operation	Method
getOrganizationSuspectRecords	getOrganizationSuspectRecords
getPersonSuspectRecords	getPersonSuspectRecords
removePendingRecord	removePendingRecord
submitMergeRequestOrganizationRecord	submitMergeRequestOrganizationRecord
submitMergeRequestPersonRecord	submitMergeRequestPersonRecord