IBM 4J Security Exit Messages

vUNIX user name

vA copy of the Sterling Connect:Direct copy control block

vA copy of the Sterling Connect:Direct parsed sysopts structure (the copy control

block contains the actual raw version from the process)

FILE_OPEN_OUTPUT_REPLY_MSG

The user exit program sends a reply message to the Sterling Connect:Direct

FILE_OPEN_OUTPUT_MSG. The FILE_OPEN_OUTPUT_REPLY_MSG contains:

vStatus value of zero for successful or non zero for failure

vStatus text message (if status value is failure, status text message is included in

the error message)

vPipe pid (for pipe I/O, the UNIX process ID of the shell process that is

performing the shell command for pipe I/O)

vActual file name opened (to be used in statistics log messages)

If the status value is zero for successful, the user exit program must immediately

call send_exit_file() or send_exit_file_c() to send the file descriptor of the opened

file to Sterling Connect:Direct.

FILE_OPEN_INPUT_MSG

During the copy statement Process, Sterling Connect:Direct sends a

FILE_OPEN_INPUT_MSG to the user exit program to open the source file. The

FILE_OPEN_INPUT_MSG contains:

vThe open function oflag parameter (for example, O_RDONLY)

vThe open function mode parameter, which controls file permissions

vUNIX user ID that will own the file

vUNIX group ID that will own the file

vUNIX user name

vA copy of the Sterling Connect:Direct copy control block

vA copy of the Sterling Connect:Direct parsed sysopts structure (the copy control

block contains the actual raw version from the Process)

FILE_OPEN_INPUT_REPLY_MSG

This message type is used when the user exit program sends a reply message to

the Sterling Connect:Direct FILE_OPEN_INPUT_MSG. The

FILE_OPEN_INPUT_REPLY_MSG contains:

vStatus value of zero for success or non zero for failure

vStatus text message (if status value is failure, status text message is included in

the error message)

vPipe pid (for pipe I/O, the UNIX process ID of the shell process that is

performing the shell command for pipe I/O)

vActual file name opened (used in statistics log messages)

Security Exit Messages

The security exit contains four types of messages:

vGENERATE_MSG

vGENERATE_REPLY_MSG

80 Sterling Connect:Direct for UNIX: User Guide

Contents

Main Page Page Page Contents Chapter 1. Controlling and Monitoring Processes..............1 Chapter 2. Process Queuing .....37 Chapter 3. Sterling Connect:Direct Utilities ..............43 Chapter 4. Writing Custom Programs 59 Page Chapter 1. Controlling and Monitoring Processes Overview of the Command Line Interface Starting the CLI Stopping the CLI CLI Commands 2 CLI Job Control CLI History Commands Overview of Sterling Connect:Direct Commands 4 Abbreviations for Common Sterling Connect:Direct Commands Restricting the Scripts and UNIX Commands Users Can Execute Sterling Connect:Direct Command Syntax Generic Parameter Value List Parameter Value Submitting a Process Page 8 Page 10 Page Example - Submit a Process That Runs Every Week The following command submits the Process named payroll: 12 Example - Submit a Process with a Start Time Specified The following command submits the Process named copyfil: Changing Process Parameters The optional parameters for the change process command are the following: 14 Deleting a Process from the TCQ The delete process command removes a nonexecuting Process from the TCQ. 16 The following command deletes all nonexecuting Processes submitted by user ID cduser on node dallas: Removing a Process from the Execution Queue The flush process command has the following optional parameters: The following command flushes all executing Processes named Rome from the Execution queue: The following command flushes all executing Processes on node alma submitted by user ID jones: Stopping Sterling Connect:Direct 18 Viewing a Process in the TCQ 20 Page The following command displays the specified Process number: Monitoring Process Status in the TCQ 22 Page 24 The following command displays a short report for the specified Process number: Output from the command is displayed in the following table: The following command displays a detailed report for the specified Process number: Output from the command is displayed in the following table: Determining the Outcome of a Process 26 Page 28 Page 30 Page Generating a Detailed Output Report for a Process 32 Generating a Summary Report for a Process Running System Diagnostics 34 Page 36 Chapter 2. Process Queuing Overview of the Transmission Control Queue Scheduling Sterling Connect:Direct Activity Progression of a Process Through the TCQ 38 The Execution Queue The Wait Queue 40 The Timer Queue The Hold Queue 42 Chapter 3. Sterling Connect:Direct Utilities Introduction to Translation Tables Creating a Translation Table Compiling a Translation Table Using the ndmxlt Utility 44 The parameters for the ndmxlt command are listed in the following table: ExampleCreating a Translation Table About this task ExampleModifying a Model Translation Table About this task Using Translation During File Transfer Operations Translation Table Error Messages Accessing Sterling Connect:Direct Messages 46 Message File Content Message File Record Format Displaying Message Text Precompressing/Decompressing Files Using the Standalone Batch Compression Utility Special Considerations for Using the Standalone Batch Compression Utility 48 Using the Standalone Batch Compression Utility Following are the parameters for the cdsacomp utility: 50 ExamplePrecompress a Text File ExamplePrecompress a Text File With Codepage Conversion ExamplePrecompress a Binary File ExampleDecompress a Text File Examplescsdacomp Command Help Requesting a summary of cdsacomp command parameters and help options: 52 ExampleDecompress a File on the Remote Node During the Copy Step ExampleSend Precompressed File to z/OS and Storing It as Precompressed Validate Configuration Files Configuration Reports Generating a Configuration Report on the Base Installation 54 Generating a Configuration Report on Sterling Connect:Direct Secure Plus for UNIX The following example shows an excerpt from a sample report: Generating a Configuration Report on Sterling Connect:Direct for SWIFTNet for UNIX 56 Page Page Chapter 4. Writing Custom Programs Introduction to Writing Custom Programs Compiling Custom Programs 60 Writing Custom C Programs Creating a Connection to Sterling Connect:Direct Using ndmapi_connect() or ndmapi_connect_c() 62 Terminating a Connection Using ndmapi_disconnect() or ndmapi_disconnect_c() Receiving Responses Using ndmapi_recvresp() or ndmapi_recvresp_c() 64 Following are the parameters for ndmapi_recvresp() or ndmapi_recvresp_c(): Page 66 The ndmapi_recvresp() or ndmapi_recvresp_c() function has the folliowing return codes: Following is a sample ndmapi_recvresp() function: Sending a Command to Sterling Connect:Direct Using ndmapi_sendcmd() or ndmapi_sendcmd_c() 68 Following are the parameters for ndmapi_sendcmd() or ndmapi_sendcmd_c(): Writing Custom C++ Programs 70 The ConnectDirectSession class methods are described in the following table: Page Following is the ConnectDirectSession class header: 72 Page Page Chapter 5. Writing User Exits User Exit Programs User Exit Functions Initializing Communications with exit_child_init() or exit_child_init_c() 76 The exit_child_init() or exit_child_init_c() function has the following parameter: Waiting for a Message Using recv_exit_msg() or recv_exit_msg_c() Passing a File Descriptor Using send_exit_file() or send_exit_file_c() Sending a Message to Sterling Connect:Direct Using send_exit_msg() or send_exit_msg_c() 78 Overview of User Exit Messages Statistics Exit Message File Open Exit Messages FILE_OPEN_OUTPUT_MSG FILE_OPEN_OUTPUT_REPLY_MSG Security Exit Messages GENERATE_MSG GENERATE_REPLY_MSG VALIDATE_MSG VALIDATE_REPLY_MSG User Exit Stop Message 82 Copy Control Block Exit Log Files Notices 84 Trademarks 86 Index Special characters A C D E I L 88 M N V W