User Exits › User Exit 1

User Exit 1

Purpose

This exit allows the execution of a user‑developed exit routine upon completion of a CA XCOM Data Transport file transfer. The CA XCOM Data Transport history record data is available for interrogation.

Module Name and Entry Point

The default module name and entry point for this exit is XCOMEX01. The default module name can be overridden by specifying the load-module name in the Default Options.

How to Enable

To enable this exit, specify EXIT01=YES | Load-module name in the Default Options.

Calling Module

The module XCOMXFER calls this exit.

Entry Method

This exit is invoked under a subtask within the CA XCOM Data Transport region encapsulated by a Transaction Program.

Required DSECT

SMFDSECT is the required DSECT.

Addressing Mode at Entry

The addressing mode at entry is 31.

Registers at Entry

The following registers are available at entry:

R0

Undefined

R1

Address of SMFDSECT

R2 to R12

Undefined

R13

Address of register save area

R14

Return address

R15

The Entry point address

Registers at Exit

The following registers are available at exit:

R0 to R14

Undefined

R15

Return code

Valid Return Code

The only valid return code is 0 for a normal return.

Sample Program

Here is a sample program using this exit:

CAI.CBXGSAMP(XCOMEX01)

Note: Exit 1 is invoked only when the transfer is scheduled and run using the CA XCOM Data Transport z/OS server. Exit 1 is not invoked when XCOMJOB TYPE=EXECUTE is used.