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

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 Table 256

Table 256. 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 Table 257.

Table 257. 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 Table 258.

Table 258. 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 Table 259.

Table 259. 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 Table 260.

Table 260. 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 Table 261.

Table 261. 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 Table 262.

Table 262. 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 Table 263.

Table 263. 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 Table 264.

Table 264. 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 Table 263.

Table 265. 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 Table 264.

Table 266. 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 Table 263.

Table 267. 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 Table 268.

Table 268. Request Message Description: updateOrgBatchRejectedRecords
Node
Description
Type

errorMessage

Specific error message

String

Request Message Description: updatePerBatchRejectedRecords

For a description of this request message, see Table 269.

Table 269. 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 Table 270.

Table 270. 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 Table 271.

Table 271. ConsolidateService 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 Table 272.

Table 272. 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 Table 273.

Table 273. ConsolidateService Details Methods
Operation
Method

getBatchProcessReport

getBatchProcessReport

getSpecificBatchReport

getSpecificBatchReport

getCompletedRecordsBatchReport

getCompletedRecordsBatchReport

getOrgRejectRecordsDetailReport

getOrgRejectRecordsDetailReport

getPerRejectRecordsDetailReport

getPerRejectRecordsDetailReport

updateOrgBatchRejectedRecords

updateOrgBatchRejectedRecords

updatePerBatchRejectedRecords

updatePerBatchRejectedRecords

Oracle Customer Hub (UCM) Master Data Management Reference Copyright © 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices.