Services Integration Framework Guide

10.3 HotFix 3
- 10.5
- 10.4 HotFix 3
- 10.4 HotFix 2
- 10.4 HotFix 1
- 10.4
- 10.3 HotFix 2
- 10.3 HotFix 1
- 10.3

Back Next

GetXrefForEffectiveDate

The GetXrefForEffectiveDate API retrieves multiple XREF records for the specified effective date. The response to a GetXrefForEffectiveDate request contains the aggregate period start date, and the aggregate period end date. Aggregate period is the intersection of all the periods that encompass the specified effective date.

Required Parameters

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

Parameter	Description
SiperianObjectUid	Name and type of base object or package for which you must get the XREF for a specified effective date.
RecordKey	Key to uniquely identify the record for which you must get the XREF for a specified effective date.
SystemNames	Names of systems for which XREF and XREF history must be retrieved.
EffectiveDate	The date for which you must retrieve values of the base object. EffectiveDate must be used only for timeline-enabled base objects.

Optional Parameters

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

Parameter	Description
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.
OtherPeriods	Periods that do not encompass the specified effective date. If set to true , XREF records are retrieved for all periods that do not encompass the specified effective date. The default is false and the GetXrefForEffectiveDate API retrieves XREF records for periods that encompass the specified effective date.
RecordStates	System state of the XREF record. The record can be in ACTIVE, PENDING, or DELETED state.
DataFilter	Used by IDD to apply security filter.

Use Case

The following is a typical scenario in which the GetXrefForEffectiveDate request is used:

Determining the address of residence of a client for a specific date
— If your clients change their address of residence frequently, and you need to know what their address was on a specific effective date, you can use the GetXrefForEffectiveDate API in combination with the PreviewBVT API to get the address that was effective on the specific date. The cross-reference records used by the PreviewBVT API to calculate the address for the specified effective date are used by the GetXrefForEffectiveDate API to retrieve the address that was effective on the specified effective date.

Usage Example

The following example shows how to retrieve XREFs for a record with ROWID_OBJECT = 28, for an effective date 10/10/2011.

GetXrefForEffectiveDateRequest req=new GetXrefForEffectiveDateRequest();
req.setUsername("admin");
Password passwd=new Password();
passwd.setPassword("admin");
passwd.setEncrypted(false);
req.setOrsId("orcl.informatica.com-cmx_ors");
RecordKey rec=new RecordKey();
rec.setRowid("28");
req.setRecordKey(rec);
req.setSiperianObjectUid("BASE_OBJECT.C_BO");
Date date=new Date(2011, 10, 10);
req.setEffectiveDate(date);
GetXrefForEffectiveDateResponse response = (GetXrefForEffectiveDateResponse)client.process(req);