Skip navigation links

Thor.API.Operations
Interface tcReconciliationOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcReconciliationOperationsIntf

extends tcUtilityOperationsIntf

Method Summary

void	addDirectBulkMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.List dataList) Adds data for multi-valued attributes (child tables) for a reconciliation event.
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 tables) for a reconciliation event.
void	addDirectBulkMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.List dataList) Adds data for multi-valued attributes (child tables) for a reconciliation event.
void	addDirectBulkMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.List dataList, java.lang.String psDateFormat) Adds data for multi-valued attributes (child tables) for a reconciliation event.
long	addDirectMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child tables) for a reconciliation event.
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 tables) for a reconciliation event.
long	addDirectMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child tables) for a reconciliation event.
long	addDirectMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.Map poData, java.lang.String psDateFormat) Adds data for multi-valued attributes (child tables) for a reconciliation event.
long	addMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child tables) 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 tables) for a reconciliation event.
long	addMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, java.util.Map poData) Adds data for multi-valued attributes (child tables) 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 tables) for a reconciliation event.
void	closeReconciliationEvent(long rceKey) Close the current reconciliation event.
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.sql.Date futureDate) 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 psObjectName, java.util.Map poData, boolean pbFinishEvent, java.lang.String psDateFormat, java.sql.Date futureDate) Deprecated. As of 11g use ReconOperationsService.createReconciliationEvent(String, Map, EventAttributes)
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 method takes the resultset returned by the getMissingAccounts method, and for each account identified in the resultset, creates a reconciliation event of type "Delete".
void	finishReconciliationEvent(long plReconciliationEventKey) Closes off a Reconciliation Event that was left open when created to allow additional data (child table data) to be provided.
java.lang.String	getDefaultDateFormat() Returns the format in which dates are expected in the reconciliation data.
Thor.API.tcResultSet	getMissingAccounts(java.lang.String objectName, java.util.Set accountsFound) This method takes the ID generated by the initialization method, and returns information about all the accounts that were found by Xellerate, but were not matched up with any of the account lists provided in the Detection Data Providing calls.
Thor.API.tcResultSet	getMissingAccounts(java.lang.String objectName, java.util.Set accountsFound, java.util.Map itRes) This method takes the ID generated by the initialization method, and returns information about all the accounts that were found by Xellerate, but were not matched up with any of the account lists provided in the Detection Data Providing calls.
boolean	ignoreEvent(java.lang.String psObjName, java.util.Map poData) Allows the user to validate beforehand whether the reconciliation event needs to be raised or not, using the name of the Resource Object for which the reconciliation event has occurred and the data.
boolean	ignoreEvent(java.lang.String psObjName, java.util.Map poData, java.lang.String psDateFormat) Allows the user to validate beforehand whether the reconciliation event needs to be raised or not, using the name of the Resource Object for which the reconciliation event has occurred and the data.
boolean	ignoreEventAttributeData(java.lang.String psObjName, java.util.Map poData, java.lang.String psFieldName, java.util.Map[] paoAttributeDataList) If the account has multi-valued attributes that also need to be checked as part of the reconciliation event, then this method provides the ability to check including them for the account as well.
boolean	ignoreEventAttributeData(java.lang.String psObjName, java.util.Map poData, java.lang.String psFieldName, java.util.Map[] paoAttributeDataList, java.lang.String psDateFormat) If the account has multi-valued attributes that also need to be checked as part of the reconciliation event, then this method provides the ability to check including them for the account as well.
void	linkEventToResourceInstanceForUser(long plReconciliationEventKey, long objectInstanceForUserKey) Method links the specified reconciliation event to given object instance for user key.
void	linkEventToUser(long plReconciliationEventKey, long userKey) Method links the specified reconciliation event to given user.
void	processReconciliationEvent(long rceKey) Process reconciliation event without going through JMS.
java.util.Set	provideDeletionDetectionData(java.lang.String objectName, java.util.Map[] paoAccountDataList) This method takes the ID generated by the initialization method, (
java.util.Set	provideDeletionDetectionData(java.lang.String objectName, java.util.Map[] paoAccountDataList, java.util.Map itRes) This method takes the ID generated by the initialization method, (startDeletionDetection) and an Array of Map elements.
void	providingAllMultiAttributeData(long plReconciliationEventKey, long plReconciliationAttributeKey, java.lang.String psFieldName, boolean pbFlag) This method provides the reconciliation developer the ability to specify whether the data being provided for a particular atttribute (as specified by its name using the psFieldName attribute) is the entire list of data, or only that which has been added/updated.
void	providingAllMultiAttributeData(long plReconciliationEventKey, java.lang.String psFieldName, boolean pbFlag) This method provides the reconciliation developer the ability to specify whether the data being provided for a particular atttribute (as specified by its name using the psFieldName attribute) is the entire list of data, or only that which has been added/updated.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

createReconciliationEvent

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

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

Creates a reconciliation event for the specified object.

Parameters:

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

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

pbFinishEvent - Boolean indicating whether child data is going to be provided or not. True if all the event data has been provided (no child data). False if there will be child data. If False, then the event must be explicitly closed after all child data is provided by calling

Returns:

The key for the reconciliation event created

Throws:

tcAPIException

tcObjectNotFoundException

See Also:

tcReconciliationOperationsIntf.finishReconciliationEvent(long)

createReconciliationEvent

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

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

Creates a reconciliation event for the specified object.

Parameters:

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

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

pbFinishEvent - Boolean indicating whether child data is going to be provided or not. True if all the event data has been provided (no child data). False if there will be child data. If False, then the event must be explicitly closed after all child data is provided by calling

psDateFormat - A String containing the date format. For example: "yyyy-mm-dd hh:mm:ss".

Returns:

The key for the reconciliation event created

Throws:

tcAPIException

tcObjectNotFoundException

See Also:

tcReconciliationOperationsIntf.finishReconciliationEvent(long)

createReconciliationEvent

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

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

Creates a future-dated reconciliation event for the specified object in future.

Parameters:

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

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

pbFinishEvent - Boolean indicating whether child data is going to be provided or not. True if all the event data has been provided (no child data). False if there will be child data. If False, then the event must be explicitly closed after all child data is provided by calling

futureDate - A date on which the recon event is required to happen. if its "null" then the creation and processing of the recon event is done simultaneously else it is deferred till the "futureDate" becomes less than or equal to the current date of the system.

Returns:

The key for the reconciliation event created

Throws:

tcAPIException

tcObjectNotFoundException

Since:

9.1.0.2

See Also:

tcReconciliationOperationsIntf.finishReconciliationEvent(long)

createReconciliationEvent

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

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

Creates a future-dated reconciliation event for the specified object.

Parameters:

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

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

pbFinishEvent - Boolean indicating whether child data is going to be provided or not. True if all the event data has been provided (no child data). False if there will be child data. If False, then the event must be explicitly closed after all child data is provided by calling

psDateFormat - A String containing the date format. For example: "yyyy-mm-dd hh:mm:ss".

futureDate - A date on which the recon event is required to happen. if its "null" then the creation and processing of the recon event is done simultaneously else it is deferred till the "futureDate" becomes less than or equal to the current date of the system.

Returns:

The key for the reconciliation event created

Throws:

tcAPIException

tcObjectNotFoundException

Since:

9.1.0.2

See Also:

tcReconciliationOperationsIntf.finishReconciliationEvent(long)

addMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it is a top level child record.

Parameters:

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

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

See Also:

event method

addMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it is a top level child record.

Parameters:

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

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

See Also:

event method

addMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it may be a child record of an already defined child record.

Parameters:

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

plReconciliationAttributeKey - The key for a multi-valued attribute that was created earlier for this reconciliation event that is the parent of this attribute.

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcAttributeNotFoundException

tcEventDataReceivedException

tcInvalidAttributeException

See Also:

event method

addMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it may be a child record of an already defined child record.

Parameters:

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

plReconciliationAttributeKey - The key for a multi-valued attribute that was created earlier for this reconciliation event that is the parent of this attribute.

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcAttributeNotFoundException

tcEventDataReceivedException

tcInvalidAttributeException

See Also:

event method

addDirectMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it is a top level child record. This API bypasses the data object layer for improved performance

Parameters:

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

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

See Also:

event method

addDirectMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it may be a child record of an already defined child record. This API bypasses the data object layer for improved performance

Parameters:

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

plReconciliationAttributeKey - The key for a multi-valued attribute that was created earlier for this reconciliation event that is the parent of this attribute.

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcAttributeNotFoundException

tcEventDataReceivedException

tcInvalidAttributeException

See Also:

event method

addDirectMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it may be a child record of an already defined child record. This API bypasses the data object layer for improved performance

Parameters:

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

plReconciliationAttributeKey - The key for a multi-valued attribute that was created earlier for this reconciliation event that is the parent of this attribute.

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcAttributeNotFoundException

tcEventDataReceivedException

tcInvalidAttributeException

See Also:

event method

addDirectMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to one child record, and it is a top level child record. This API bypasses the data object layer for improved performance

Parameters:

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

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

poData - A Map containing the field-value pairs for the data record pertaining to that attribute received from the target.

Returns:

The key of the attribute created

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

See Also:

event method

addDirectBulkMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to multiple child records. This API bypasses the data object layer for improved performance

Parameters:

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

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

dataList - A List containing objects of type Map each of which contains the field-value pairs for one child data record pertaining to that attribute received from the target.

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

See Also:

event method

addDirectBulkMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to multiple child records. This API bypasses the data object layer for improved performance

Parameters:

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

plReconciliationAttributeKey - The key for a multi-valued attribute that was created earlier for this reconciliation event that is the parent of this attribute.

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

dataList - A List containing objects of type Map each of which contains the field-value pairs for one child data record pertaining to that attribute received from the target.

Throws:

tcAPIException

tcEventNotFoundException

tcAttributeNotFoundException

tcEventDataReceivedException

tcInvalidAttributeException

See Also:

event method

addDirectBulkMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to multiple child records, This API bypasses the data object layer for improved performance

Parameters:

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

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

dataList - A List containing objects of type Map each of which contains the field-value pairs for one child data record pertaining to that attribute received from the target.

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

See Also:

event method

addDirectBulkMultiAttributeData

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

Adds data for multi-valued attributes (child tables) for a reconciliation event. The data provided pertains to multiple child records. This API bypasses the data object layer for improved performance

Parameters:

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

plReconciliationAttributeKey - The key for a multi-valued attribute that was created earlier for this reconciliation event that is the parent of this attribute. Provide null if there is no parent

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

dataList - A List containing objects of type Map each of which contains the field-value pairs for one child data record pertaining to that attribute received from the target.

psDateFormat - dateformat to be used when processing the data

Throws:

tcAPIException

tcEventNotFoundException

tcEventNotFoundException

tcEventDataReceivedException

tcInvalidAttributeException

tcAttributeNotFoundException

See Also:

event method

finishReconciliationEvent

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

Closes off a Reconciliation Event that was left open when created to allow additional data (child table data) to be provided.

Parameters:

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

Throws:

tcAPIException

tcEventNotFoundException

tcEventDataReceivedException

See Also:

event method

processReconciliationEvent

void processReconciliationEvent(long rceKey)
                                throws tcAPIException

Process reconciliation event without going through JMS. 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. The entire processing will take place without any offlining.

Parameters:

rceKey - The key for the reconciliation event

Throws:

tcAPIException

closeReconciliationEvent

void closeReconciliationEvent(long rceKey)
                              throws tcAPIException

Close the current reconciliation event. This API will close the current reconciliation event. The status of the event will be 'Event Closed'.

Parameters:

rceKey - The key for the reconciliation event

Throws:

tcAPIException

getDefaultDateFormat

java.lang.String getDefaultDateFormat()
                                      throws tcAPIException

Returns the format in which dates are expected in the reconciliation data.

Returns:

The string representing the format in which the date values will be expected. For example, "yyyy/MM/dd hh:mm:ss z" for "2002/07/10 15:24:56 EST"

Throws:

tcAPIException

provideDeletionDetectionData

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

This method takes the ID generated by the initialization method, (

Parameters:

pnId - ID from the

paoAccountDataList - Array of maps that correspond to each of the accounts from the target system.

Throws:

tcAPIException

tcIDNotFoundException - the ID is not found or is not valid

tcMultipleMatchesFoundException

See Also:

startDeletionDetection) and an Array of Map elements. Each of these Map elements represents data about one account that was found on the target system, and therefore has not been deleted. The Name-Value pairs making up the map represent the attribute names and their values, similar to what is fed into reconciliation., method, startDeletionDetection

getMissingAccounts

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

This method takes the ID generated by the initialization method, and returns information about all the accounts that were found by Xellerate, but were not matched up with any of the account lists provided in the Detection Data Providing calls. It is called once after all the necessary calls to the provideDeletionDetectionData method

Parameters:

pnId - ID from the startDeletionDetection

Returns:

a tcResultSet of the accounts found in Xellerate and not matched by the accounts provided.

Throws:

tcAPIException

tcIDNotFoundException

tcDataNotProvidedException

See Also:

startDeletionDetection, provideDeletionDetectionData

deleteDetectedAccounts

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

This method takes the resultset returned by the getMissingAccounts method, and for each account identified in the resultset, creates a reconciliation event of type "Delete". The returned array is the list of IDs of all reconciliation events created.

Parameters:

poDetectedAccounts - tcResultSet of the identified accounts to create the reconciliation event

Returns:

the IDs of all the reconciliation events created

Throws:

tcAPIException

createDeleteReconciliationEvent

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

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

This method is another way to generate reconciliation events of type "Delete". It supports the scenario where the reconciliation developer is actually able to retrieve directly from the target system what accounts have been deleted. It takes the name of the resource object for which the reconciliation is occurring, and the account information for the deleted account. This does not have to be all the account data, only those attributes required for the account matching rules to work. It creates a reconciliation event of type "Delete" with that data. The returned value is the ID of the reconciliation event created.

Parameters:

psObjName - name of the resource object name

poAttributeList - list of attributes

Returns:

the ID of the reconciliation event created

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)

This method is another way to generate reconciliation events of type "Delete". It supports the scenario where the reconciliation developer is actually able to retrieve directly from the target system what accounts have been deleted. It takes the name of the resource object for which the reconciliation is occurring, and the account information for the deleted account. This does not have to be all the account data, only those attributes required for the account matching rules to work. It creates a reconciliation event of type "Delete" with that data. The returned value is the ID of the reconciliation event created.

Parameters:

psObjName - name of the resource object name

poAttributeList - list of attributes

psDateFormat - Date format to be used for processing dates in this reconciliation event

Returns:

the ID of the reconciliation event created

Throws:

tcAPIException

tcObjectNotFoundException

providingAllMultiAttributeData

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

This method provides the reconciliation developer the ability to specify whether the data being provided for a particular atttribute (as specified by its name using the psFieldName attribute) is the entire list of data, or only that which has been added/updated. When used for child table data, call this method AFTER calling the addMultiAttributeData() or addDirectMultiAttributeData() or the addDirectBulkMultiAttributeData() methods. This order is important.

Parameters:

plReconciliationEventKey - reconciliation event key

psFieldName - reconciliation field name for multi-valued attribute

pbFlag - whether the values being provided is the whole list (true) or only the addition/update lists (false).

Throws:

tcAPIException

providingAllMultiAttributeData

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

This method provides the reconciliation developer the ability to specify whether the data being provided for a particular atttribute (as specified by its name using the psFieldName attribute) is the entire list of data, or only that which has been added/updated. When used for child table data, call this method AFTER calling the addMultiAttributeData() or addDirectMultiAttributeData() or the addDirectBulkMultiAttributeData() methods. This order is important.

Parameters:

plReconciliationEventKey - reconciliation event key

plReconciliationAttributeKey - the reconciliation attribute key

psFieldName - reconciliation field name for multi-valued attribute

pbFlag - whether the values being provided is the whole list (true) or only the addition/update lists (false).

Throws:

tcAPIException

ignoreEvent

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

Allows the user to validate beforehand whether the reconciliation event needs to be raised or not, using the name of the Resource Object for which the reconciliation event has occurred and the data. It first tries to find a definitive account match, and then compares the account data with the record of it in Xellerate. If there is no difference between the data, it returns a true (indicating that the reconciliation event should not be raised). In all other cases, it will return false. API assumes that the value provided for reconciliation fields of type Date are in the same format returned by getDefalutDateFormat API.

Parameters:

psObjName - The resource object name

poData - map providing all the information about the account record. If partial information is passed in the map about the account record, API returns true if that partial information is matched with an account record in Xellerate. If null values are passed in the map, they are ignored and not used for comparison against the account record in Xellerate. Fields names can be passed in the map in case insensitive manner. Attribute values passed for the fields in the Map should be trimmed to remove the leading/trailing spaces.

Returns:

true if the reconciliation event should not be raised; otherwise, it will return false.

Throws:

tcAPIException

tcObjectNotFoundException

ignoreEvent

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

Allows the user to validate beforehand whether the reconciliation event needs to be raised or not, using the name of the Resource Object for which the reconciliation event has occurred and the data. It first tries to find a definitive account match, and then compares the account data with the record of it in Xellerate. If there is no difference between the data, it returns a true (indicating that the reconciliation event should not be raised). In all other cases, it will return false.

Parameters:

psObjName - The resource object name

poData - map providing all the information about the account record. If partial information is passed in the map about the account record, API returns true if that partial information is matched with an account record in Xellerate. If null values are passed in the map, they are ignored and not used for comparison against the account record in Xellerate. Fields names can be passed in the map in case insensitive manner. Attribute values passed for the fields in the Map should be trimmed to remove the leading/trailing spaces.

psDateFormat - Format in which date values are specified for reconciliation fields of type Date

Returns:

true if the reconciliation event should not be raised; otherwise, it will return 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 tcObjectNotFoundException,
                                        tcAPIException

If the account has multi-valued attributes that also need to be checked as part of the reconciliation event, then this method provides the ability to check including them for the account as well. The account record information still needs to be provided in order to get the account matching rules to work. This means that if there are multiple child tables, the method would have to be called multiple times in order to check all the attributes. If it finds the account match, then it compares the child account data with the child account data in Xellerate. If there is no difference between the data, it returns a true (indicating that the reconciliation event should not be raised). In all other cases, it will return false.
It should be called only after calling the ignoreEventData method.

Parameters:

psObjName - The resource object name

poData - map providing all the information about the account record.

psFieldName - field name attribute for the resource object

paoAttributeDataList - Array of maps containing the multi-valued attribute data for that resource object name. If partial information is passed in the maps about the account record, API returns true if that partial information is matched with an account record in Xellerate. If null values are passed in the map, they are ignored and not used for comparison against the account record in Xellerate. Fields names can be passed in the map in case insensitive manner. Attribute values passed for the fields in the Maps should be trimmed to remove the leading/trailing spaces.

psDateFormat - Format in which date values are specified for reconciliation fields of type Date

Returns:

true if the reconciliation event should not be raised; otherwise, it will return false.

Throws:

tcAPIException

tcObjectNotFoundException

See Also:

ignoreEventData

ignoreEventAttributeData

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

If the account has multi-valued attributes that also need to be checked as part of the reconciliation event, then this method provides the ability to check including them for the account as well. The account record information still needs to be provided in order to get the account matching rules to work. This means that if there are multiple child tables, the method would have to be called multiple times in order to check all the attributes. If it finds the account match, then it compares the child account data with the child account data in Xellerate. If there is no difference between the data, it returns a true (indicating that the reconciliation event should not be raised). In all other cases, it will return false.
It should be called only after calling the ignoreEventData method. API assumes that the value provided for reconciliation fields of type Date are in the same format returned by getDefalutDateFormat API.

Parameters:

psObjName - The resource object name

poData - map providing all the information about the account record.

psFieldName - field name attribute for the resource object

paoAttributeDataList - Array of maps containing the multi-valued attribute data for that resource object name. If partial information is passed in the maps about the account record, API returns true if that partial information is matched with an account record in Xellerate. If null values are passed in the map, they are ignored and not used for comparison against the account record in Xellerate. Fields names can be passed in the map in case insensitive manner. Attribute values passed for the fields in the Maps should be trimmed to remove the leading/trailing spaces.

Returns:

true if the reconciliation event should not be raised; otherwise, it will return false.

Throws:

tcAPIException

tcObjectNotFoundException

See Also:

ignoreEventData

linkEventToResourceInstanceForUser

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

Method links the specified reconciliation event to given object instance for user key. The event must not be already linked, closed, nor have required data missing.

Parameters:

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

objectInstanceForUserKey - Object instance key for user

Throws:

tcAPIException

tcEventNotFoundException

Since:

8.5.3.1

See Also:

createReconciliationEvent

linkEventToUser

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

Method links the specified reconciliation event to given user. The event must not be already linked, closed, nor have required data missing.

Parameters:

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

userKey - Object User Key

Throws:

tcAPIException

tcEventNotFoundException

tcUserNotFoundException

Since:

8.5.3.1

See Also:

createReconciliationEvent

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. callingEndOfJobAPI should never be invoked after deleteBulkMultiAttributeData API . deleteBulkMultiAttributeData and createReconciliationEvent should never be invoked together.

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. callingEndOfJobAPI should never be invoked after deleteBulkMultiAttributeData API . deleteBulkMultiAttributeData and createReconciliationEvent should never be invoked together. . 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

provideDeletionDetectionData

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

This method takes the ID generated by the initialization method, (startDeletionDetection) and an Array of Map elements. Each of these Map elements represents data about one account that was found on the target system, and therefore has not been deleted. The Name-Value pairs making up the map represent the attribute names and their values, similar to what is fed into reconciliation.

Parameters:

objectName - The object name to be revoked.

paoAccountDataList - Array of maps that correspond to each of the accounts from the target system.

itRes - The IT resource IDs of the target system to map a specific resource to be revoked. The entries must be formatted like "Field Name = a string format of IT Resource ID" For instance, IT Resource = 62 When the map has multiple entries, the entries will be used to map the resource to be revoked with the AND condition.

Throws:

tcAPIException

tcIDNotFoundException - the ID is not found or is not valid

tcMultipleMatchesFoundException

See Also:

startDeletionDetection

getMissingAccounts

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

This method takes the ID generated by the initialization method, and returns information about all the accounts that were found by Xellerate, but were not matched up with any of the account lists provided in the Detection Data Providing calls. It is called once after all the necessary calls to the provideDeletionDetectionData method

Parameters:

objectName - The object name to be revoked

accountsFound - A set of account id (Long) or User Key

itRes - The IT resource IDs of the target system to map a specific resource to be revoked. The entries must be formatted like "Field Name = a string format of IT Resource ID" For instance, IT Resource = 62 When the map has multiple entries, the entries will be used to map the resource to be revoked with the AND condition.

Returns:

a tcResultSet of the accounts found in Xellerate and not matched by the accounts provided.

Throws:

tcAPIException

tcIDNotFoundException

tcDataNotProvidedException

See Also:

startDeletionDetection, provideDeletionDetectionData

Skip navigation links