Services Integration Framework Guide

10.3

Back Next

SetRecordState

enables a client application to assign one of a predefined set of state indicator values to a specified set of base object records. The state indicator value is stored in the CONSOLIDATION_IND column. The consolidation indicator can be one of the following values:

Indicator Value	State Name	Description
1	CONSOLIDATED	This record has been consolidated (determined to be unique) and represents the best version of the truth.
2	UNMERGED	This record has gone through the match process and is ready to be consolidated.
3	QUEUED_FOR_MATCH	This record is a match candidate in the match batch that is being processed in the currently-executing match process.
4	NEWLY_LOADED	This record is new (load insert) or changed (load update) and needs to undergo the match process.
9	ON_HOLD	The data steward has put this record on hold until further notice. Any record can be put on hold regardless of its consolidation indicator value. The match and consolidate processes ignore on-hold records. For more information, see the Multidomain MDM Data Steward Guide .

Restrictions

Consider the following when using the

SetRecordState

API:

This request cannot be used within a transaction.

The consolidation state can only be set for base object records with a Hub_State_Ind value of 1, meaning the record has an ACTIVE hub status.

Required Parameters

Parameter	Description
RecordKey	Identifies the record that requires a state change. See About RecordKey for more information. If the ROWID_OBJECT is provided, the systemName is not validated.
RecordState	The name of the state to which the record will be set. The state name can be one of the following: CONSOLIDATED UNMERGED QUEUED_FOR_MATCH NEWLY_LOADED ON_HOLD
SiperianObjectUID	The package or base object used to identify the record that requires a state change.

Optional Parameters

The

SetRecordState

request does not have any optional parameters.

Response Fields

The following table describes the response fields:

Parameter	Description
Messsage	Contains the status message of the SetRecordState request.

Use Case

This is the common scenario for using the SetRecordState request:

In a client application, allow a user to explicitly set the state of a record.

SetRecordState Request Usage Example

The following example sets the record state of the record with a ROWID_OBJECT value of 782 to QUEUED_FOR_MATCH using the ADDRESS_UPDATE package:

SetRecordStateRequest request = new SetRecordStateRequest();
request.setSiperianObjectUid("PACKAGE.ADDRESS_UPDATE");
request.setRecordState(RecordState.QUEUED_FOR_MATCH);
RecordKey recordKey = new RecordKey();
recordKey.setRowid("782");
request.addRecordKey(recordKey);
SetRecordStateResponse response = (SetRecordStateResponse) sipClient.process(request);

SetRecordState Response Usage Example

The following example prints the status message from the

SetRecordState

response:

//Construct the request
..
//Process the request
SetRecordStateResponse response = 
(SetRecordStateResponse) sipClient.process(request);

//Print the message from the response object
System.out.println("Message: " + response.getMessage());

Rename Saved Search

Table of Contents

Services Integration Framework Guide

Services Integration Framework Guide

SetRecordState

SetRecordState

Restrictions

Required Parameters

Optional Parameters

Response Fields

Use Case

SetRecordState Request Usage Example

SetRecordState Response Usage Example