CIFF extract user exit

The CIFF extract provides a user exit that can be used to customize the extract criteria that are specified in the CIFF extract task configuration. It can also be used to set user data in the output extract records. The user exit routine is optional. If it is used, it is activated by specifying its name in the CIFF extract configuration.

CIFF extract user exit routines can have any user-chosen name. They must be created as a Java™ class that implements either of the following Java interfaces.
  • CiffExtractUserExitInterface - This interface does not use the optional index records.
  • CiffExtractUserExitInterfaceWithIndex - This interface uses the optional index records.
After they are compiled, CIFF extract user exit routines must be packaged in a JAR file and copied into the Services Framework library.
The following list shows the methods that you can implement for this user exit. An instance of the CiffExtractUserExitControl class provides setters and getters for the many of the user exit methods to do their function.
userExitInit(conn, entryId, businessDayId)
This method is called before any other user exit method is called. It allows any data specific to the user exit, such as Db2® prepared statements, to be initialized.
customizeHeaderRecord(CiffExtractUserExitControl)
This method is called before the header record for the output file is built. It allows the default values for these header record user fields to be modified:
  • Origin identification
  • Output file creation date
  • Output file creation time
  • Volume tracking identification
  • Image type
createIndexDefinitionRecord(CiffExtractUserExitControl)
This method is called after the header record is built. It allows the index definition record to be created or inserted after the header record.
createItemIndexRecord(CiffExtractUserExitControl)
This method is called before each item is extracted. It allows the item index record to be created or inserted for the item. The format of the item index record is defined when the createIndexDefinitionRecord method is called.
customizeItemExtraction(CiffExtractUserExitControl)
This method is called after the images for an item are extracted. It allows the following to be modified:
  • The extraction criteria.
  • The default values for the data record user areas, if they are being extracted.
  • The default contents of segment zero.
  • The optional contents of segments 13, 14, and 15.

For more information about the user exit routine, review the sample code for the user exit. Or, see More CIFF extract artifacts.