Skip navigation links

oracle.iam.reconciliation.api
Interface ReconOperationsService

public interface ReconOperationsService

Method Summary

void	addDirectBulkMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.List dataList) Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.
void	addDirectBulkMultiAttributeData(long reconciliationEventKey, long reconciliationAttributeKey, java.lang.String tableFieldName, java.util.List dataList, java.lang.String dateFormat) Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.
void	addDirectBulkMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.List dataList) Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.
void	addDirectBulkMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.List dataList, java.lang.String psDateFormat) Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.
long	addDirectMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing *is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was used to invoke SQL directly instead of going through data access layer for performance reasons.
long	addDirectMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.Map poData, java.lang.String psDateFormat) Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing * is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was used to invoke SQL directly instead of going through data access layer for performance reasons.
long	addDirectMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing * is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was used to invoke SQL directly instead of going through data access layer for performance reasons.
long	addDirectMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.Map poData, java.lang.String psDateFormat) Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was * used to invoke SQL directly instead of going through data access layer for performance reasons.
long	addMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child table) for a reconciliation event.
long	addMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.Map poData, java.lang.String psDateFormat) Adds data for multi-valued attributes (child table) for a reconciliation event.
long	addMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child table) for a reconciliation event.
long	addMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.Map poData, java.lang.String psDateFormat) Adds data for multi-valued attributes (child table) for a reconciliation event.
void	callingEndOfJobAPI() This API is called by the EndofJob Plug-in , which in turn is called by the Scheduler when a job completes.
void	closeReconciliationEvent(long rceKey) Closes the reconciliation event for the given reconciliation key by updating the status to 'Event Closed'
long	createDeleteReconciliationEvent(java.lang.String psObjName, java.util.Map poAttributeList) Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)
long	createDeleteReconciliationEvent(java.lang.String psObjName, java.util.Map poAttributeList, java.lang.String psDateFormat) Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)
long	createReconciliationEvent(java.lang.String psObjectName, java.util.Map poData, boolean pbFinishEvent) Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)
long	createReconciliationEvent(java.lang.String psObjectName, java.util.Map poData, boolean pbFinishEvent, java.lang.String psDateFormat) Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)
long	createReconciliationEvent(java.lang.String objName, java.util.Map inputData, EventAttributes eventAttribs) Creates a reconciliation event for the specified object.
ReconciliationResult	createReconciliationEvents(InputData[] input, BatchAttributes batchAttribs) Creates a bulk reconciliation events for the data passed in Input Data.
void	deleteBulkMultiAttributeData(java.lang.String objName, java.util.Map parentRecord, java.lang.String childTableName, java.util.List childRecords) Deleted data for multi-valued attributes (child table) for a reconciliation event.
void	deleteBulkMultiAttributeData(java.lang.String objName, java.util.Map parentRecord, java.lang.String childTableName, java.util.List childRecords, java.lang.String dateFormat) Deleted data for multi-valued attributes (child table) for a reconciliation event.
long[]	deleteDetectedAccounts(Thor.API.tcResultSet poDetectedAccounts) This API takes the tcResultSet returned by the getMissingAccounts method and for each USER or ACCOUNT identified in the resultset, creates a reconciliation event of type "Delete".
void	finishReconciliationEvent(long plReconciliationEventKey) Marks the status of a reconciliation event as 'Data Received' which was left in status 'Event Received' to allow additional data (child table data) to be added
java.lang.String	getDefaultDateFormat() Gets the default date format from the PTY table.
Thor.API.tcResultSet	getMissingAccounts(java.lang.String objectName, java.util.Set accountsFound) This API retrieves all USER or ACCOUNT keys from OIM and compares them with the keys present in the set returned by the provideDeletionDetectionData method.If no match is found then information is returned in tcResultSet.
boolean	ignoreEvent(java.lang.String psObjName, java.util.Map poData) Validates whether the reconciliation event needs to be raised or not for the specified object.
boolean	ignoreEvent(java.lang.String psObjName, java.util.Map poData, java.lang.String psDateFormat) Validates whether the reconciliation event needs to be raised or not for the specified object.
boolean	ignoreEventAttributeData(java.lang.String psObjName, java.util.Map poData, java.lang.String psFieldName, java.util.Map[] paoAttributeDataList) Validates whether the reconciliation event needs to be raised or not for the multi-valued attributes .
boolean	ignoreEventAttributeData(java.lang.String psObjName, java.util.Map poData, java.lang.String psFieldName, java.util.Map[] paoAttributeDataList, java.lang.String psDateFormat) Validates whether the reconciliation event needs to be raised or not for the multi-valued attributes .
void	linkEventToResourceInstanceForUser(long plReconciliationEventKey, long objectInstanceForUserKey) Links the specified reconciliation event to given account.
void	linkEventToUser(long plReconciliationEventKey, long userKey) Links the specified reconciliation event to given user.
void	processReconciliationEvent(long rceKey) This API will process the current reconciliation event, applying the matching rules and the action rules, and linking it to the appropriate User, Org or Process Instance.
java.util.Set	provideDeletionDetectionData(java.lang.String objectName, java.util.Map[] paoAccountDataList) This API will raise the delete events for the all the USER or ACCOUNT which are deleted from the target and present in the OIM.
void	providingAllMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, boolean pbFlag) Specifies whether the multi valued data being provided for a particular attribute (psFieldName) is the entire list of data, or only that which has been added/updated
void	providingAllMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, boolean pbFlag) Specifies whether the multi valued data being provided for a particular attribute (psFieldName) is the entire list of data, or only that which has been added/updated

Method Detail

createReconciliationEvent

long createReconciliationEvent(java.lang.String objName,
                               java.util.Map inputData,
                               EventAttributes eventAttribs)

Creates a reconciliation event for the specified object.

Parameters:

objName - Name of the resource Object or profile Name.

inputData - The data which needs to be populated in the target table (i.e the actual OIM table used to store the reconciliation event data). The poData contains the combination of reconciliation field name and its corresponding value

eventAttribs - EventAttributes like changetype, dateformat etc.

Returns:

Reconciliation Event Key

Since:

11g

createReconciliationEvents

ReconciliationResult createReconciliationEvents(InputData[] input,
                                                BatchAttributes batchAttribs)

Creates a bulk reconciliation events for the data passed in Input Data.

Parameters:

inputData - The target data which needs to be populated in the OIM. The map attribute in inputdata contains the combination of reconciliation field name and its corresponding value

batchAttribs - BatchAttributes like resource name, dateformat etc.

Returns:

ReconciliationResult Contains a list which has Event Key of long type or an Exception object

Since:

11g

createReconciliationEvent

long createReconciliationEvent(java.lang.String psObjectName,
                               java.util.Map poData,
                               boolean pbFinishEvent)
                               throws tcAPIException

Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)

Creates a reconciliation event for the specified object.

Parameters:

psObjName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used as the default profile name.

poData - The data which needs to be populated in the target table (i.e the actual OIM table used to store the reconciliation event data). The poData contains the combination of reconciliation field name and its corresponding value

pbFinishEvent - Boolean indicating whether child data is going to be provided or not.It is set to false if child data is going to be added later to the event.If the pbFinishEvent is true that means event status is set to 'Data Received' otherwise it would be set to'Event Received'

Returns:

Reconciliation Event Key

Throws:

tcAPIException

createReconciliationEvent

long createReconciliationEvent(java.lang.String psObjectName,
                               java.util.Map poData,
                               boolean pbFinishEvent,
                               java.lang.String psDateFormat)
                               throws tcAPIException

Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)

Creates a reconciliation event for the specified object.

Parameters:

psObjName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used *as the default profile name.

poData - The data which needs to be populated in the target table (i.e the actual OIM table used to store the reconciliation event data). The poData contains the combination of reconciliation field name and its corresponding value

pbFinishEvent - Boolean indicating whether child data is going to be provided or not.It is set to false if child data is going to be added later to the event.If the pbFinishEvent is true that means event status is set to 'Data Received' otherwise it would be set to 'Event Received'.

psDateFormat - Date Format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

Reconciliation Event Key

Throws:

tcAPIException

addMultiAttributeData

long addMultiAttributeData(long plReconciliationEventKey,
                           java.lang.String psFieldName,
                           java.util.Map poData,
                           java.lang.String psDateFormat)
                           throws tcAPIException,
                                  tcEventNotFoundException,
                                  tcEventDataReceivedException,
                                  tcAttributeNotFoundException

Adds data for multi-valued attributes (child table) for a reconciliation event.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

psDateFormat - Date format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

addMultiAttributeData

long addMultiAttributeData(long plReconciliationEventKey,
                           java.lang.String psFieldName,
                           java.util.Map poData)
                           throws tcAPIException,
                                  tcEventNotFoundException,
                                  tcEventDataReceivedException,
                                  tcAttributeNotFoundException

Adds data for multi-valued attributes (child table) for a reconciliation event.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

addMultiAttributeData

long addMultiAttributeData(long plReconciliationEventKey,
                           long plReconciliationAttributeKey,
                           java.lang.String psFieldName,
                           java.util.Map poData,
                           java.lang.String psDateFormat)
                           throws tcAPIException,
                                  tcEventNotFoundException,
                                  tcAttributeNotFoundException,
                                  tcEventDataReceivedException

Adds data for multi-valued attributes (child table) for a reconciliation event.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

plReconciliationAttributeKey - This is the parent table key required while populating the data in child table.

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

psDateFormat - Date format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

addMultiAttributeData

long addMultiAttributeData(long plReconciliationEventKey,
                           long plReconciliationAttributeKey,
                           java.lang.String psFieldName,
                           java.util.Map poData)
                           throws tcAPIException,
                                  tcEventNotFoundException,
                                  tcAttributeNotFoundException,
                                  tcEventDataReceivedException,
                                  tcInvalidAttributeException

Adds data for multi-valued attributes (child table) for a reconciliation event.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

plReconciliationAttributeKey - This is the parent table key required while populating the data in child table.

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

tcInvalidAttributeException

addDirectMultiAttributeData

long addDirectMultiAttributeData(long plReconciliationEventKey,
                                 java.lang.String psFieldName,
                                 java.util.Map poData,
                                 java.lang.String psDateFormat)
                                 throws tcAPIException,
                                        tcEventNotFoundException,
                                        tcEventDataReceivedException,
                                        tcAttributeNotFoundException

Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was * used to invoke SQL directly instead of going through data access layer for performance reasons.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

psDateFormat - Date format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

addDirectMultiAttributeData

long addDirectMultiAttributeData(long plReconciliationEventKey,
                                 java.lang.String psFieldName,
                                 java.util.Map poData)
                                 throws tcAPIException,
                                        tcEventNotFoundException,
                                        tcEventDataReceivedException,
                                        tcAttributeNotFoundException

Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing * is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was used to invoke SQL directly instead of going through data access layer for performance reasons.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

addDirectMultiAttributeData

long addDirectMultiAttributeData(long plReconciliationEventKey,
                                 long plReconciliationAttributeKey,
                                 java.lang.String psFieldName,
                                 java.util.Map poData,
                                 java.lang.String psDateFormat)
                                 throws tcAPIException,
                                        tcEventNotFoundException,
                                        tcAttributeNotFoundException,
                                        tcEventDataReceivedException

Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing * is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was used to invoke SQL directly instead of going through data access layer for performance reasons.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

plReconciliationAttributeKey - This is the parent table key required while populating the data in child table.

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

psDateFormat - Date format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

addDirectMultiAttributeData

long addDirectMultiAttributeData(long plReconciliationEventKey,
                                 long plReconciliationAttributeKey,
                                 java.lang.String psFieldName,
                                 java.util.Map poData)
                                 throws tcAPIException,
                                        tcEventNotFoundException,
                                        tcAttributeNotFoundException,
                                        tcEventDataReceivedException,
                                        tcInvalidAttributeException

Adds data for multi-valued attributes (child table) for a reconciliation event.This API is supported for backward compatibility.Functionally, the processing *is same as that of addMultiAttributeData, it just provides a wrapper over addMultiAttributeData and delegate call to this method.In 9.1 this was used to invoke SQL directly instead of going through data access layer for performance reasons.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

plReconciliationAttributeKey - This is the parent table key required while populating the data in child table.

poData - A Map containing the field-value pairs for the data record pertaining to multi valued attributes

Returns:

The key of the parent table which has been retrieved based on the plReconciliationKey

Throws:

tcAPIException - ,tcEventNotFoundException, tcEventDataReceivedException,tcAttributeNotFoundException , tcInvalidAttributeException

tcEventNotFoundException

tcAttributeNotFoundException

tcEventDataReceivedException

tcInvalidAttributeException

addDirectBulkMultiAttributeData

void addDirectBulkMultiAttributeData(long plReconciliationEventKey,
                                     java.lang.String psFieldName,
                                     java.util.List dataList,
                                     java.lang.String psDateFormat)
                                     throws tcAPIException,
                                            tcEventNotFoundException,
                                            tcEventDataReceivedException

Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

dataList - A List containing objects of type Map each of which contains field-value pairs for the data record pertaining to multi * valued attributes

psDateFormat - Date format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

addDirectBulkMultiAttributeData

void addDirectBulkMultiAttributeData(long plReconciliationEventKey,
                                     long plReconciliationAttributeKey,
                                     java.lang.String psFieldName,
                                     java.util.List dataList)
                                     throws tcAPIException,
                                            tcEventNotFoundException,
                                            tcAttributeNotFoundException,
                                            tcEventDataReceivedException,
                                            tcInvalidAttributeException

Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

plReconciliationAttributeKey - This is the parent table key required while populating the data in child table.

psFieldName - The name of the multi-attribute reconciliation field

dataList - A List containing objects of type Map each of which contains field-value pairs for the data record pertaining to multi * valued attributes

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

tcInvalidAttributeException

addDirectBulkMultiAttributeData

void addDirectBulkMultiAttributeData(long plReconciliationEventKey,
                                     java.lang.String psFieldName,
                                     java.util.List dataList)
                                     throws tcAPIException,
                                            tcEventNotFoundException,
                                            tcEventDataReceivedException

Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

psFieldName - The name of the multi-attribute reconciliation field

dataList - A List containing objects of type Map each of which contains field-value pairs for the data record pertaining to multi *valued attributes

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

addDirectBulkMultiAttributeData

void addDirectBulkMultiAttributeData(long reconciliationEventKey,
                                     long reconciliationAttributeKey,
                                     java.lang.String tableFieldName,
                                     java.util.List dataList,
                                     java.lang.String dateFormat)
                                     throws tcAPIException,
                                            tcEventNotFoundException,
                                            tcAttributeNotFoundException,
                                            tcEventDataReceivedException,
                                            tcInvalidAttributeException

Adds data for multi-valued attributes (child table) for a reconciliation event.The data provided pertains to multiple child records instead of a single child record.

Parameters:

reconciliationEventKey - The key for the reconciliation event, as returned after creation of reconciliation event

reconciliationAttributeKey - This is the parent table key required while populating the data in child table.

tableFieldName - The name of the multi-attribute reconciliation field

dataList - A List containing objects of type Map each of which contains field-value pairs for the data record pertaining to multi * valued attributes

dateFormat - Date format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcAttributeNotFoundException

tcInvalidAttributeException

finishReconciliationEvent

void finishReconciliationEvent(long plReconciliationEventKey)
                               throws tcAPIException,
                                      tcEventNotFoundException,
                                      tcEventDataReceivedException

Marks the status of a reconciliation event as 'Data Received' which was left in status 'Event Received' to allow additional data (child table data) to be added

Parameters:

plReconciliationEventKey - The key for the reconciliation event created by createReconciliationEvent.

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

processReconciliationEvent

void processReconciliationEvent(long rceKey)
                                throws tcAPIException

This API will process the current reconciliation event, applying the matching rules and the action rules, and linking it to the appropriate User, Org or Process Instance.

Parameters:

rceKey - The key for the reconciliation event, as returned by the createReconciliationEvent

Throws:

tcAPIException

closeReconciliationEvent

void closeReconciliationEvent(long rceKey)
                              throws tcAPIException

Closes the reconciliation event for the given reconciliation key by updating the status to 'Event Closed'

Parameters:

rceKey - The key for the reconciliation event created by createReconciliationEvent.

Throws:

tcAPIException

getDefaultDateFormat

java.lang.String getDefaultDateFormat()
                                      throws tcAPIException

Gets the default date format from the PTY table.

Returns:

The string representing the format in which the date values will be expected

Throws:

tcAPIException

provideDeletionDetectionData

java.util.Set provideDeletionDetectionData(java.lang.String objectName,
                                           java.util.Map[] paoAccountDataList)
                                           throws tcAPIException,
                                                  tcIDNotFoundException,
                                                  tcMultipleMatchesFoundException

This API will raise the delete events for the all the USER or ACCOUNT which are deleted from the target and present in the OIM.

Parameters:

objectName - Name of the resource Object

paoAccountDataList - An Array of Map elements. Each of these Map elements represents data about one account or user that was found on the target system, and therefore has not been deleted

Returns:

Set which contains all the users or accounts which are found in OIM as well as target.

Throws:

tcAPIException

tcIDNotFoundException

tcMultipleMatchesFoundException

getMissingAccounts

Thor.API.tcResultSet getMissingAccounts(java.lang.String objectName,
                                        java.util.Set accountsFound)
                                        throws tcAPIException,
                                               tcIDNotFoundException,
                                               tcDataNotProvidedException

This API retrieves all USER or ACCOUNT keys from OIM and compares them with the keys present in the set returned by the provideDeletionDetectionData method.If no match is found then information is returned in tcResultSet.

Parameters:

objectName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used * as the default profile name.

accountsFound - It is a Set which contains keys of matched data info returned by the provideDeletionDetectionData method

Returns:

tcResultSet which contains all the users or accounts which are found in OIM but missing from the target.

Throws:

tcAPIException

tcIDNotFoundException

tcDataNotProvidedException

deleteDetectedAccounts

long[] deleteDetectedAccounts(Thor.API.tcResultSet poDetectedAccounts)
                              throws tcAPIException,
                                     tcAPIException

This API takes the tcResultSet returned by the getMissingAccounts method and for each USER or ACCOUNT identified in the resultset, creates a reconciliation event of type "Delete".

Parameters:

poDetectedAccounts - It is a Set returned by the getMissingAccounts for which delete reconciliation event is to be generated

Returns:

An array of reconciliation event keys

Throws:

tcAPIException

createDeleteReconciliationEvent

long createDeleteReconciliationEvent(java.lang.String psObjName,
                                     java.util.Map poAttributeList)
                                     throws tcAPIException,
                                            tcObjectNotFoundException

Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)

Creates a reconciliation events of type "Delete" for the specified object.

Parameters:

psObjName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used * as the default profile name.

poAttributeList - The data which needs to be populated in the target table (i.e the actual OIM table used to store the reconciliation event data). The poData contains the combination of reconciliation field name and its respective value

Returns:

Reconciliation Event Key

Throws:

tcAPIException

tcObjectNotFoundException

createDeleteReconciliationEvent

long createDeleteReconciliationEvent(java.lang.String psObjName,
                                     java.util.Map poAttributeList,
                                     java.lang.String psDateFormat)
                                     throws tcAPIException,
                                            tcObjectNotFoundException

Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)

Creates a reconciliation events of type "Delete" for the specified object.

Parameters:

psObjName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used * as the default profile name.

poAttributeList - The data which needs to be populated in the target table (i.e the actual OIM table used to store the reconciliation event data). The poData contains the combination of reconciliation field name and its respective value

psDateFormat - Date Format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

Reconciliation Event Key

Throws:

tcAPIException

tcObjectNotFoundException

providingAllMultiAttributeData

void providingAllMultiAttributeData(long plReconciliationEventKey,
                                    java.lang.String psFieldName,
                                    boolean pbFlag)
                                    throws tcAPIException

Specifies whether the multi valued data being provided for a particular attribute (psFieldName) is the entire list of data, or only that which has been added/updated

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned by the createReconciliationEvent

psFieldName - The name of the multi-attribute reconciliation field for which data has to be ignored. eg. Member Of

pbFlag - Indicates whether the values being provided is the whole list (true) or only the additional/updated list(false)

Throws:

tcAPIException

providingAllMultiAttributeData

void providingAllMultiAttributeData(long plReconciliationEventKey,
                                    long plReconciliationAttributeKey,
                                    java.lang.String psFieldName,
                                    boolean pbFlag)
                                    throws tcAPIException

Specifies whether the multi valued data being provided for a particular attribute (psFieldName) is the entire list of data, or only that which has been added/updated

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned by the createReconciliationEvent

plReconciliationAttributeKey - This is the parent table key required while populating the data in child table.

psFieldName - The name of the multi-attribute reconciliation field for which data has to be ignored. eg. Member Of

pbFlag - Indicates whether the values being provided is the whole list (true) or only the additional/updated list(false)

Throws:

tcAPIException

ignoreEvent

boolean ignoreEvent(java.lang.String psObjName,
                    java.util.Map poData)
                    throws tcAPIException,
                           tcObjectNotFoundException

Validates whether the reconciliation event needs to be raised or not for the specified object.

Parameters:

psObjName - Name of the resource Object

poData - The data which has to be compared with the OIM records. The poData contains the combination of reconciliation field name and its respective value

Returns:

True if the event is to be ignored otherwise false

Throws:

tcAPIException

tcObjectNotFoundException

ignoreEvent

boolean ignoreEvent(java.lang.String psObjName,
                    java.util.Map poData,
                    java.lang.String psDateFormat)
                    throws tcObjectNotFoundException,
                           tcAPIException

Validates whether the reconciliation event needs to be raised or not for the specified object.

Parameters:

psObjName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used as the default profile name.

poData - The data which has to be compared with the OIM records. The poData contains the combination of reconciliation field name and its respective value

psDateFormat - Date Format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

True if the event is to be ignored otherwise false

Throws:

tcAPIException

tcObjectNotFoundException

ignoreEventAttributeData

boolean ignoreEventAttributeData(java.lang.String psObjName,
                                 java.util.Map poData,
                                 java.lang.String psFieldName,
                                 java.util.Map[] paoAttributeDataList,
                                 java.lang.String psDateFormat)
                                 throws tcAPIException,
                                        tcObjectNotFoundException

Validates whether the reconciliation event needs to be raised or not for the multi-valued attributes .

Parameters:

psObjName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used as the default profile name.

poData - The data which has to be compared with the OIM records. The poData contains the combination of reconciliation field name and its respective value

psFieldName - The name of the multi-attribute reconciliation field for which data has to be ignored. eg. Member Of

paoAttributeDataList - Contains data for the multi-valued attributes which are to be matched with OIM records

psDateFormat - Date Format to be used when processing the date.For example: "yyyy-mm-dd hh:mm:ss".

Returns:

True if the event is to be ignored otherwise false

Throws:

tcAPIException

tcObjectNotFoundException

ignoreEventAttributeData

boolean ignoreEventAttributeData(java.lang.String psObjName,
                                 java.util.Map poData,
                                 java.lang.String psFieldName,
                                 java.util.Map[] paoAttributeDataList)
                                 throws tcAPIException,
                                        tcObjectNotFoundException

Validates whether the reconciliation event needs to be raised or not for the multi-valued attributes .

Parameters:

psObjName - Name of the resource Object or profile Name.For user and account reconciliation setup the resource object name is used * as the default profile name.

poData - The data which has to be compared with the OIM records. The poData contains the combination of reconciliation field name and its respective value

psFieldName - The name of the multi-attribute reconciliation field for which data has to be ignored. eg. Member Of

paoAttributeDataList - Contains data for the multi-valued attributes which are to be matched with OIM records

Returns:

True if the event is to be ignored otherwise false

Throws:

tcAPIException

tcObjectNotFoundException

linkEventToResourceInstanceForUser

void linkEventToResourceInstanceForUser(long plReconciliationEventKey,
                                        long objectInstanceForUserKey)
                                        throws tcAPIException,
                                               tcEventNotFoundException

Links the specified reconciliation event to given account. The event must not be already linked, closed, nor have required data missing.This will in turn call the action engine establishAccountLink API.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned by the createReconciliationEvent

objectInstanceForUserKey - Object Instance Key

Throws:

tcAPIException

tcEventNotFoundException

linkEventToUser

void linkEventToUser(long plReconciliationEventKey,
                     long userKey)
                     throws tcAPIException,
                            tcEventNotFoundException,
                            tcUserNotFoundException,
                            tcAPIException

Links the specified reconciliation event to given user. The event must not be already linked, closed, nor have required data missing.This will in turn call * the action engine establishUserLink API.

Parameters:

plReconciliationEventKey - The key for the reconciliation event, as returned by the createReconciliationEvent

userKey - Object User Key

Throws:

tcAPIException

tcEventNotFoundException

tcUserNotFoundException

callingEndOfJobAPI

void callingEndOfJobAPI()
                        throws tcAPIException

This API is called by the EndofJob Plug-in , which in turn is called by the Scheduler when a job completes.

Throws:

tcAPIException

deleteBulkMultiAttributeData

void deleteBulkMultiAttributeData(java.lang.String objName,
                                  java.util.Map parentRecord,
                                  java.lang.String childTableName,
                                  java.util.List childRecords)
                                  throws tcAPIException,
                                         tcEventNotFoundException,
                                         tcEventDataReceivedException,
                                         tcObjectNotFoundException

Deleted data for multi-valued attributes (child table) for a reconciliation event. The data provided pertains to one child record.

Parameters:

objName - The Name for the object for which the reconciliation is taking place

parentRecord - A map containing the field-value pairs for the data received from the target.

childTableName - The name of the multi-attribute reconciliation field that the data is for

childRecords - A List containing the Hashtable objects. Every Hashtable will have field-value pairs for the data record pertaining to that attribute received from the target.

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcObjectNotFoundException

deleteBulkMultiAttributeData

void deleteBulkMultiAttributeData(java.lang.String objName,
                                  java.util.Map parentRecord,
                                  java.lang.String childTableName,
                                  java.util.List childRecords,
                                  java.lang.String dateFormat)
                                  throws tcAPIException,
                                         tcEventNotFoundException,
                                         tcEventDataReceivedException,
                                         tcObjectNotFoundException

Deleted data for multi-valued attributes (child table) for a reconciliation event. The data provided pertains to one child record. This method itself creates a RECON key and submit the RECON key to the JMS message.

Parameters:

objName - The Name for the object for which the reconciliation is taking place

parentRecord - A map containing the field-value pairs for the data received from the target.

childTableName - The name of the multi-attribute reconciliation field that the data is for

childRecords - A List containing the Hashtable objects. Every Hashtable will have field-value pairs for the data record pertaining to that attribute received from the target.

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

tcObjectNotFoundException

Skip navigation links