IBM 4J User Exit Programs, User Exit Functions, Program Description, Chown root exitskeleton

Page 81

Chapter 5. Writing User Exits

User Exit Programs

The user exit API functions allow you to write custom programs to use with Sterling Connect:Direct. The user exit programs are used by Sterling Connect:Direct to invoke user-specific logic at strategic points within Sterling Connect:Direct execution. User exit programs must be C or C++ language programs and cannot be shell scripts. The PMGR invokes the Statistics user exit program when you start Sterling Connect:Direct and the exit runs as long as Sterling Connect:Direct runs. The SMGR invokes the File Open and Security user exits for each session and stops them when the particular session terminates.

Note: exit_skeleton.c and exit_skeleton.C contain working examples of all three exits and can be made with the make_exit_c and make_exit_C make files.

The user exit programs are described in the following:

Program	Description

File Open Exit	Sterling Connect:Direct sends a message to
	this user exit program to open the source or
	destination file during processing of the
	copy statement. The File Open Exit opens
	the source file and identifies the file
	descriptor. This exit can perform any sort of
	processing to file names or directory names.
	It can also redirect the open request to other
	files as needed.
	The File Open Exit program (named
	“exit_skeleton” in this example) must be
	owned by root and the setuid bit must be
	set. Use the following commands:
	% chown root exit_skeleton
	% chmod u+s exit_skeleton

Security Exit	The Security Exit enables you to implement
	your own security system or provide access
	to a third-party security system.

Statistics Exit	The Security Exit enables you to implement
	your own security system or provide access
	to a third-party security system.

User Exit Functions

A connection between the user exit and Sterling Connect:Direct is established when the user exit program calls the exit_child_init() or exit_child_init_c() function. The connection is terminated through a specially designated stop message. The types of messages are defined in the include file user_exit.h. The following functions facilitate communications between the user exit and Sterling Connect:Direct:

© Copyright IBM Corp. 1999, 2013

75

Image 81

Contents User Guide Page User Guide Copyright IBM Corporation 1999 Contents Iv Sterling ConnectDirect for Unix User Guide CLI Commands Overview of the Command Line InterfaceStarting the CLI Stopping the CLIOption Description Value Entry Sample CommandCdpnum CLI Job ControlOverview of Sterling ConnectDirect Commands CLI History CommandsCommand Command Abbreviation DescriptionParameter Abbreviation Abbreviations for Common Sterling ConnectDirect CommandsSubmitting a Process Pname = A?PROD5Parameter Description Values Parameter Description Values Id , pswd Username@hostname or user@localhostName nnnnn Name host name nnn.nnn.nnn.nnn orSnodeid field Id ,pswd ,newpswdSpecify retain=initial Following command submits the Process named copyfil Following command submits the Process named payrollChanging Process Parameters Following command submits the Process named copy.cdpParameter Description Value Name generic listNode specification, userid generic list Remote node specification generic listDeleting a Process from the TCQ Number list Removing a Process from the Execution Queue Stopping Sterling ConnectDirect Flush process command has the following optional parametersParameter Description Viewing a Process in the TCQPname Locate the Process to view EX HC HE HI HO HR HS PE Monitoring Process Status in the TCQ Following command displays the specified Process numberAll EX HC HE HI HO HR HS PE Output from the command is displayed in the following table Dest=/path/file name Determining the Outcome of a ProcessRecord id list Caev Capr CAEV, CaprParameter Description Value Parameter Description Value Parameter Description Value Date day , hhmmss ampm Srcf=/path/file nameGenerating a Detailed Output Report for a Process Generating a Summary Report for a Process Running System DiagnosticsSelect Statistics Recid LOG Timepname Pnumber Stepname Ccod Fdbk MsgidCOMM.TRC Smgr Trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc Overview of the Transmission Control Queue Command DefinitionScheduling Sterling ConnectDirect Activity Scheduling Parameter Queue CommentsProgression of a Process Through the TCQ Execution Queue Wait Queue Element CommentStatus Comment Hold Queue Timer QueueHeld for Call indicates that the Process was Creating a Translation Table Introduction to Translation TablesExample-Creating a Translation Table Compiling a Translation Table Using the ndmxlt UtilityExample-Modifying a Model Translation Table Using Translation During File Transfer OperationsAccessing Sterling ConnectDirect Messages Translation Table Error MessagesMessage File Content Diagnostic Number DescriptionMessage File Record Format Following is a sample ndmmsg commandDisplaying Message Text Following are the parameters for the message file recordSterling ConnectDirect for Unix User Guide Following are the parameters for the cdsacomp utility Using the Standalone Batch Compression UtilityLevel-Compression level Memory-The amountSource codepage, destination CodepageNnnnn Example-Precompress a Text File With Codepage Conversion Example-Precompress a Text FileExample-Precompress a Binary File Example-Decompress a Text FileExamples-csdacomp Command Help Configuration Reports Validate Configuration FilesCfgcheck command has the following arguments Argument DescriptionType the following command at a Unix prompt Generating a Configuration Report on the Base InstallationSterling ConnectDirect Utilities Following example shows an excerpt from a sample report Sterling ConnectDirect Utilities Sterling ConnectDirect for Unix User Guide Introduction to Writing Custom Programs Program using the C++ API callsCompiling Custom Programs Compiler version to use for each platformYou want to create such as apicheck Platform Compile Command++ Function Description Writing Custom C ProgramsNdmerrenth Ndmerror NdmnoerrorReceiving Responses Using ndmapirecvresp or ndmapirecvrespc Ndmapirecvresp orNdmapirecvrespc Parameter Description Value PNOD-PNODE SNOD-SNODE Following is a sample ndmapirecvresp functionReturn Code Description TruncatedNdmapirecvresp or ndmapirecvrespc to retrieve Ndmapisendcmdc function call has the following return codes Writing Custom C++ ProgramsFollowing is a sample ndmapisendcmd function Selectstatistics or Selectprocess , the CLISterling ConnectDirect for Unix User Guide Cdfailure Method Description Parameter Return ValuesCdsuccess = 0, Cdfailure = Following is the ConnectDirectSession class headerWriting Custom Programs Sterling ConnectDirect for Unix User Guide User Exit Functions User Exit ProgramsProgram Description Chown root exitskeletonReturn Code Goodrc ErrorrcExitprogram Waiting for a Message Using recvexitmsg or recvexitmsgcHeader Following are the parameters for sendexitmsg or sendexitmsgcOverview of User Exit Messages Statistics Exit MessageFile Open Exit Messages Fileopenoutputreplymsg Security Exit MessagesValidatemsg Validatereplymsg GeneratemsgUser Exit Stop Message Copy Control BlockExit Log Files Copyright IBM Corp IBM Corporation J46A/G4 Bailey Avenue San Jose, CA Trademarks Sterling ConnectDirect for Unix User Guide Index Special characters Generatemsg Generatereplymsg Validatemsg Validatereplymsg Page Sterling ConnectDirect for Unix User Guide Page Product Number 5725-C99