User exits

SCLM provides a number of exit points that you can use to customize SCLM processing or to integrate SCLM with other products. SCLM does not provide the user exit routines to be invoked at these exit points. You can specify your own user exit routines in the project definition using the user exit parameters on the FLMCNTRL macro.

There can be performance implications associated with the specification of an exit routine depending on the processing performed by the exit routine. You can write a user exit routine in any language, including REXX. The exit routine can use any of the SCLM services to retrieve additional information that is not returned by the exit.

Writing and compiling a program to be reentrant, then specifying RENT and REUS on the link-edit makes the invocation of the routine more efficient.

Table 1 lists the exits supplied by SCLM, along with the FLMCNTRL parameter used to specify an associated user exit routine. The "Initial" and "Verify" exits are invoked before any real processing (change to data) occurs, and can be used to perform tasks such as verifying a user's authority to perform a given function.

The Promote Copy, Promote Purge, and all "Notify" exits are invoked after processing has completed, and can be used to perform tasks such as putting an entry into a log file, generating a report, or sending notification to a specified set of users.

All of these exit points can be used to integrate SCLM with other products as well as to enable customized processing. For example, a Verify Change Code Exit routine might be used to query an external change management product to ensure that an open problem request exists for a change being made, and that the user making the change is authorized to do so. The SCLM sample bridge to Tivoli® Information Management is an example of this type of exit routine.

Here are the available exits, along with the FLMCNTRL parameters used to specify an associated user exit routine.

Table 1. Exits and Exit Routine Specifications
Exit	Exit Routine Specification	When Invoked
Verify Change Code Exit	CCVFY	At the start of an SCLM Edit session: In SCLM Edit (option 2) before the member list is displayed (note that in this case, no member name is passed to the exit) In SCLM Edit (option 2), on entry to edit of a member if the member name is specified explicitly In the Library utility (3.1), on entry to edit of a member When Change Code or Language is changed in SPROF By the EDIT service.
Save Change Code Exit	CCSAVE	After a member has been saved, but before SCLM accounting information is updated for the member By the Migrate (3.3) utility By the EDIT, MIGRATE, SAVE, and STORE services
Change Code Verification Exit (superseded)	VERCC	At the start of an SCLM Edit session: in SCLM Edit (option 2) before the member list is displayed (note that in this case, no member name is passed to the exit) in SCLM Edit (option 2), on entry to edit of a member if the member name is specified explicitly in the Library utility (3.1), on entry to edit of a member When Change Code is changed in SPROF By the Migrate (3.3) and Import (3.7) utilities By the EDIT, IMPORT, MIGRATE, SAVE, and STORE services Note: If VERCC is present in PROJDEFS, the Change Code cannot be blank when a member is saved. VERCC has been superseded by CCVFY.
Build Initial Exit	BLDINIT	At the beginning of Build before any verification or processing occurs
Build Notify Exit	BLDNTF or BLDEXT1	After Build processing completes
Promote Initial Exit	PRMINIT	At the beginning of Promote before any verification or processing occurs
Promote Verify Exit	PRMVFY or PRMEXT1	At the end of the Verification phase of Promote, but before the Copy and Purge steps are processed
Promote Copy Exit	PRMCOPY or PRMEXT2	At the end of the Copy phase of Promote, but before the Purge step is processed
Promote Purge Exit	PRMPURGE or PRMEXT3	At the end of Promote after the Verification, Copy, and Purge phases have all been completed
Audit/Version Delete Verify Exit	AVDVFY	After the input parameters have been verified for an audit record and version, but before the record is deleted
Audit/Version Delete Notify Exit	AVDNTF	After the audit record has been deleted
Delete Initial Exit	DELINIT	By the Delete from Group utility, before delete processing begins By the DELGROUP service, before delete processing begins
Delete Verify Exit	DELVFY	By the Library utility, after the input parameters have been verified but before the member is deleted By the DELETE service, after the input parameters have been verified but before the member is deleted
Delete Notify Exit	DELNTF	After delete processing has completed for the Delete from Group utility or DELGROUP service After delete processing has completed for the Library Utility Delete option, or the DELETE service