Services Integration Framework Guide

10.3

Back Next

PromotePendingXrefs

PromotePendingXref promotes or flags for promotion the XREF records specified in the request.

State Management

Promote means to change the state of a record from PENDING to ACTIVE. When the flagForPromote option is set, then this API request will queue the specified xref records for promotion using the next run of the PROMOTE batch process. Otherwise, the request will immediately promote the specified xref records from PENDING to ACTIVE. Here’s the behavior of this request based on various XREF states:

ACTIVE and DELETED records will return an error.

PENDING records will be made ACTIVE.

Required Parameters

The following table lists and describes the parameters that are required by the PromotePendingXref API:

Parameter	Description
SiperianObjectUid	Name and type of the package or base object to be promoted.
XrefKey	Key to uniquely identify the record to be promoted.
SystemName	Name of system for which XREF must be promoted.
SourceKey	Source key of the cross-reference record that must be promoted.

Optional Parameters

The following table lists and describes the optional parameters that are used by the PromotePendingXref API:

Parameter	Description
ColumnNames	Names of columns that must be promoted to the ACTIVE state. Data is lost after promotion, in case of columns that are not specified. This parameter is only available for online promotion and is ignored when the FlagForPromote parameter is set to true.
FlagForPromote	Flags records for promote when set to true. The records are promoted when the batch process is executed in the MDM Hub.
PeriodStartDate	This parameter is used to specify the period start date for timeline-enabled base objects.
PeriodEndDate	This parameter is used to specify the period end date for timeline-enabled base objects.

Usage Example

The following example immediately promotes the "FIRST_NAME" and "LAST_NAME" fields for the XREF record with sourceKey=1234 and system=CRM in the package CUSTOMER_UPDATE. If the XREF record is ACTIVE or DELETED, an error will be returned. If the XREF record is PENDING, it will be made ACTIVE.

PromotePendingXrefsRequest request = new PromotePendingXrefsRequest();
ArrayList columnNames = new ArrayList();
columnNames.add("FIRST_NAME");
columnNames.add("LAST_NAME");
request.setColumnNames(columnNames); // Optional
XrefKey xrefKey = new XrefKey();
xrefKey.setSourceKey("1234");
xrefKey.setSystemName("CRM");
ArrayList xrefKeys = new ArrayList();
xrefKeys.add(xrefKey);
request.setXrefKeys(xrefKeys); // Required
request.setSiperianObjectUID("PACKAGE.CUSTOMER_UPDATE"); //Required

PromotePendingXrefsResponse response = (PromotePendingXrefsResponse) sipClient.process(request);

The following example flags the XREF record with sourceKey=1234 and system=CRM in the package CUSTOMER_UPDATE for promotion the next time the Promote batch process is run.

PromotePendingXrefsRequest request = new PromotePendingXrefsRequest();
XrefKey xrefKey = new XrefKey();
xrefKey.setSourceKey("1234");
xrefKey.setSystemName("CRM");
ArrayList xrefKeys = new ArrayList();
xrefKeys.add(xrefKey);
request.setFlagForPromote(true); // Optional
request.setXrefKeys(xrefKeys); // Required
request.setSiperianObjectUID("PACKAGE.CUSTOMER_UPDATE"); //Required

PromotePendingXrefsResponse response = (PromotePendingXrefsResponse) sipClient.process(request);