Data Director Implementation Guide

10.5 HotFix 4

Back Next

User Exits

User exits provide a means to add custom business logic to standard IDD operations.

User exits are implemented in Java. For details on the interfaces used to implement user exits, refer to the Javadoc for

siperian-bdd.jar

that are included in the Informatica MDM Hub Resource Kit. Also included in the Resource Kit is a set of example user exits, including an ant project that can be used as a template for building a user exit JAR file.

For each subject area, user exits can be implemented to add custom functionality for the following operations:

Save

Send for Approval

Task Operations

Merge

Mark Not A Match

Custom Operations

HM Save Relationship

HM Custom Operations

Open.

The following table describes the user exit entry points available for each operation. Save, Send for Approval, and Task Operations are variations on the process of saving changes to the subject area data view and provide the same set of entry points.

Operation	Entry Point	Description
Save, Send for Approval, Task Operations	beforeValidation	This entry point is no longer supported. Use the beforeEverything entry point instead.
	afterValidation	This entry point is no longer supported. Use the beforeEverything entry point instead.
	beforeEverything	Called before any processing is done. Use this to perform custom validation or augmentation of the data in the subject area. IDD saves changes that the user exit makes to the data in the subject area. Can report Errors, Warnings and Confirmations. Executes outside of the save transaction.
	beforeSave	Called after the search for duplicates, just before performing the composite save. Use this to execute custom business logic that augments the data in the subject area. IDD saves changes that the user exit makes to data in the subject area. Can report Errors. Executes as part of the composite save transaction. SIF requests to the ORS are part of this transaction.
	afterSave	Called after the subject area changes are saved. Use this to perform maintenance of data that is not part of the subject area. Can report Errors that roll back the transaction. Executes as part of the composite save transaction. SIF requests to the ORS are part of this transaction.
	afterEverything	Called after the save transaction is committed. Use this to provide user notifications or perform maintenance of data that is not part of the subject area when the changes cannot be executed as part of the transaction. Can report Warnings. Executes outside of the save transaction.
Merge	beforeEverything	Called before any processing is done. Use this to perform custom validation or augmentation of the data in the subject area. Can report Errors, Warnings and Confirmations. Executes outside of the save transaction.
	beforeMerge	Called just before the merge is performed. Use this to execute custom business logic to provide error or confirmation messages. Can report Errors. Executes as part of the merge transaction. SIF requests to the ORS are part of this transaction.
	afterMerge	Called after the merge operation has completed. Use this to perform maintenance for data that is not part of the subject area. Can report Errors that roll back the merge. Executes as part of the merge transaction. SIF requests to the ORS are part of this transaction.
	afterEverything	Called after the merge transaction is committed. Use this to provide user notifications or perform maintenance of data that is not part of the subject area when the changes cannot be executed as part of the transaction. Can report Warnings. Executes outside of the transaction.
Mark Not A Match	beforeEverything	Called before any processing is done. Use this to perform custom validation or augmentation of the data in the subject area. Can report Errors, Warnings and Confirmations. Executes outside of the save transaction.
	beforeMarkNotAMatch	Called just before the not a match is performed. Use this to execute custom business logic to provide error or confirmation messages. Can report Errors. Executes as part of the not a match transaction. SIF requests to the ORS are part of this transaction.
	afterMarkNotAMatch	Called after the not a match operation is completed. Use this to perform maintenance for data that is not part of the subject area. Can report Errors that will roll back the merge. Executes as part of the not a match transaction. SIF requests to the ORS will be part of this transaction.
	afterEverything	Called after the not a match transaction has been committed. Use this to provide user notifications or perform maintenance of data that is not part of the subject area when the changes cannot be executed as part of the transaction. Can report Warnings. Executes outside of the transaction.
User Operation	processOperation	Called when the IDD user invokes the custom operation user exit from the More Actions menu in the data view. Use this to execute custom business logic. The user exit can return Error or Warning messages. The data view is refreshed if this completes without error so that any changes to the subject area made by the user exit are reflected in IDD.
HM Save Relationship	beforeEverything	Called before any processing is done. Use this to perform custom validation or augmentation of the relationship. Can report Errors, Warnings and Confirmations. Executes outside of the save transaction.
	afterValidation	Called after validation and cleanse function execution are performed. Use this to perform custom validation or augmentation of the relationship. Can report Errors, Warnings and Confirmations. Executes outside of the save transaction.
	beforeSave	Called just prior to performing the save. Use this to execute custom business logic that augments the data associated with the relationship. Can report Errors. Executes as part of the save transaction. SIF requests to the ORS are part of this transaction.
	afterSave	Called after the relationship changes are saved. Use this to perform maintenance of data associated with the relationship. Can report Errors which roll back the save. Executes as part of the save transaction. SIF requests to the ORS are part of this transaction.
	afterEverything	Called after the save transaction is committed. Use this to provide user notifications or perform maintenance of data associated with the relationship when the changes cannot be executed as part of the transaction. Can report Warnings. Executes outside of the save transaction.
HM User Operation	processOperation	Called when the IDD user invokes the custom operation user exit from the More Actions menu in the data view. Use this to execute custom business logic. The user exit can return Error or Warning messages. The user exit indicates which parts of the graph need to be refreshed as a result of the user exit operation.
Open	beforeOpen	Called before an open operation is performed. Use this to mark columns as read-only in edit mode and to overwrite column values. Can report errors, warnings, confirmations, and custom messages. Executes outside the open transaction
Open	afterOpen	Called after the open operation is completed. Use this to send various notifications to the data in the subject area. Also, you can use this for custom checking of the data that is loaded to the database. Can report errors, warnings, confirmations, and custom messages. Executes as part of the open transaction. SIF requests to the ORS are part of this transaction.

Each user exit is supplied with the following data (these are described in detail in the Javadoc):

the subject area data that is being operated on

a SiperianClient object that can be used to perform SIF operations against the ORS database, plus the ORS id and user credentials to use in SIF requests

operation-specific data

Manual IDD Configuration

User Exits and the Entity 360 Framework

User Exit Operations

Building User Exits

Configuring a User Exit

Configuring a User Exit to Set Start Date and End Date for a Period

User Exit Messages

Troubleshooting

Download Guide

Watch

Comments