Services Integration Framework Guide

10.4

Back Next

PreviewBVT

The PreviewBVT API enables you to preview what a base object record would look like if you merge a specified set of records or apply pending updates to the records.

Required Parameters

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

Parameter	Description
SiperianObjectUid	Name and type of base object or package that you need to use for previewing BVT.
RecordKeyList	Keys of records for which you need to preview the BVT. If you include multiple records in the record key list, the BVT of only the first record can be previewed.
FilterClause	An SQL WHERE clause that can be applied to an XREF table. If you specify one record key for the RecordKeyList parameter, FilterClause is used to preview the effect of applying pending updates.

Optional Parameters

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

Parameter	Description
EffectiveDate	The date for which values of the base object must be retrieved. EffectiveDate must be used only for timeline-enabled base objects.
HistoryDate	The date for which you retrieve base object data that is effective at the specified point in time. If HistoryDate is equal to or earlier than HIST_CREATE_DATE, no records are returned. For Oracle environments, milliseconds for HistoryDate are truncated. If HistoryDate is later than HIST_CREATE_DATE by less than a second, no records are returned. If you have Daylight Saving Time (DST) enabled for the operating system and HistoryDate is later than HIST_CREATE_DATE by less than one hour during DST, no records are returned. HistoryDate must be used only for timeline-enabled base objects.
PromotePairedXrefs	Ensures that the record preview matches what a base object record would look like after the record is promoted. If the approval tasks might have active and pending cross-reference records from the same source system, set the property to true . Default is false .

Use Case

The following is a typical scenario for using the PreviewBVT request:

Preview the BVT for base objects for which the trust level may change over time
— Trust level for base object columns change over time and only the latest value reflects in the base objects. You can use the PreviewBVT request to preview the BVT value for a base object record at a specific point in time (past, present, or future).

Determine the value of a record for a specific effective date
— If a record has cross-references with more than one period of effectiveness, then the PreviewBVT API can be used to calculate the BVT value of the record for a specific effective date.

Usage Example

The following example shows the merge preview of three records with ROWID_OBJECTs 1, 2, and 3 into a record with ROWID_OBJECT = 1, using the package P_PARTY.

PreviewBvtRequest request = new PreviewBvtRequest ();
request.setSiperianObjectUid(SiperianObjectType.PACKAGE.makeUid("C_PARTY"));
ArrayList recordKeys = new ArrayList();
recordKeys.add(RecordKey.rowid("1"));
recordKeys.add(RecordKey.rowid("2"));
recordKeys.add(RecordKey.rowid("3"));
request.setRecordKeyList (recordKeys);
PreviewBvtResponse response = (PreviewBvtResponse) sipClient.process(request);

Rename Saved Search

Table of Contents

Services Integration Framework Guide

Services Integration Framework Guide

PreviewBVT

PreviewBVT

Required Parameters

Optional Parameters

Use Case

Usage Example