IBM 4J manual User Exit Stop Message, Copy Control Block, Exit Log Files

Page 88

VALIDATE_REPLY_MSG

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

VALIDATE_MSG. The VALIDATE_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)

vID used for security context

vSecurity token to use in conjunction with ID for security context

User Exit Stop Message

Sterling Connect:Direct sends the stop message, STOP_MSG, when all useful work for the user exit is complete and to notify the user exit to terminate. A user exit should terminate only when a stop message is received or if one of the above listed user exit functions returns an error code.

Copy Control Block

The copy control block structure contains the fields, which control how Sterling Connect:Direct Processes the copy statement Process file.

Exit Log Files

If user exit programs are specified in the initparm.cfg, Sterling Connect:Direct creates exit logs. Exit log files are provided specifically for the user exit programs and are used for debug and trace type messages. The user exit program is started with the log file already opened on STDOUT and STDERR. The exit log files are:

vstat_exit.log

vfile_exit.log

vsecurity_exit.log

Note: You can access the log files through the normal printf() and fprintf (stderr,...) functions.

The log files are located in the installed (d_dir) working directory:

.../d_dir/work/cd_node

82Sterling Connect:Direct for UNIX: User Guide

Image 88

Contents User Guide Page User Guide Copyright IBM Corporation 1999 Contents Iv Sterling ConnectDirect for Unix User Guide Overview of the Command Line Interface CLI CommandsStarting the CLI Stopping the CLISample Command Option Description Value EntryCLI Job Control CdpnumCLI History Commands Overview of Sterling ConnectDirect CommandsCommand Command Abbreviation DescriptionAbbreviations for Common Sterling ConnectDirect Commands Parameter AbbreviationPname = A?PROD5 Submitting a ProcessParameter Description Values Parameter Description Values Username@hostname or user@localhost Id , pswdName host name nnn.nnn.nnn.nnn or Name nnnnnId ,pswd ,newpswd Snodeid fieldSpecify retain=initial Following command submits the Process named payroll Following command submits the Process named copyfilFollowing command submits the Process named copy.cdp Changing Process ParametersParameter Description Value Name generic listRemote node specification generic list Node specification, userid generic listDeleting a Process from the TCQ Number list Removing a Process from the Execution Queue Flush process command has the following optional parameters Stopping Sterling ConnectDirectViewing a Process in the TCQ Parameter DescriptionPname Locate the Process to view EX HC HE HI HO HR HS PE Following command displays the specified Process number Monitoring Process Status in the TCQAll EX HC HE HI HO HR HS PE Output from the command is displayed in the following table Determining the Outcome of a Process Dest=/path/file nameCaev Capr CAEV, Capr Record id listParameter Description Value Parameter Description Value Parameter Description Value Srcf=/path/file name Date day , hhmmss ampmGenerating a Detailed Output Report for a Process Running System Diagnostics Generating a Summary Report for a ProcessSelect Statistics Recid LOG Timepname Pnumber Stepname Ccod Fdbk MsgidCOMM.TRC Smgr Trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc Command Definition Overview of the Transmission Control QueueScheduling Sterling ConnectDirect Activity Scheduling Parameter Queue CommentsProgression of a Process Through the TCQ Execution Queue Element Comment Wait QueueStatus Comment Timer Queue Hold QueueHeld for Call indicates that the Process was Introduction to Translation Tables Creating a Translation TableCompiling a Translation Table Using the ndmxlt Utility Example-Creating a Translation TableUsing Translation During File Transfer Operations Example-Modifying a Model Translation TableTranslation Table Error Messages Accessing Sterling ConnectDirect MessagesMessage File Content Diagnostic Number DescriptionFollowing is a sample ndmmsg command Message File Record FormatDisplaying Message Text Following are the parameters for the message file recordSterling ConnectDirect for Unix User Guide Using the Standalone Batch Compression Utility Following are the parameters for the cdsacomp utilityLevel-Compression level Memory-The amountCodepage Source codepage, destinationNnnnn Example-Precompress a Text File Example-Precompress a Text File With Codepage ConversionExample-Precompress a Binary File Example-Decompress a Text FileExamples-csdacomp Command Help Validate Configuration Files Configuration ReportsCfgcheck command has the following arguments Argument DescriptionGenerating a Configuration Report on the Base Installation Type the following command at a Unix promptSterling ConnectDirect Utilities Following example shows an excerpt from a sample report Sterling ConnectDirect Utilities Sterling ConnectDirect for Unix User Guide Program using the C++ API calls Introduction to Writing Custom ProgramsCompiling Custom Programs Compiler version to use for each platformPlatform Compile Command You want to create such as apicheckWriting Custom C Programs ++ Function DescriptionNdmerrenth Ndmnoerror NdmerrorNdmapirecvresp or Receiving Responses Using ndmapirecvresp or ndmapirecvrespcNdmapirecvrespc Parameter Description Value PNOD-PNODE Following is a sample ndmapirecvresp function SNOD-SNODEReturn Code Description TruncatedNdmapirecvresp or ndmapirecvrespc to retrieve Writing Custom C++ Programs Ndmapisendcmdc function call has the following return codesFollowing is a sample ndmapisendcmd function Selectstatistics or Selectprocess , the CLISterling ConnectDirect for Unix User Guide Method Description Parameter Return Values CdfailureFollowing is the ConnectDirectSession class header Cdsuccess = 0, Cdfailure =Writing Custom Programs Sterling ConnectDirect for Unix User Guide User Exit Programs User Exit FunctionsProgram Description Chown root exitskeletonGoodrc Errorrc Return CodeWaiting for a Message Using recvexitmsg or recvexitmsgc ExitprogramFollowing are the parameters for sendexitmsg or sendexitmsgc HeaderStatistics Exit Message Overview of User Exit MessagesFile Open Exit Messages Security Exit Messages FileopenoutputreplymsgGeneratemsg Validatemsg ValidatereplymsgCopy Control Block User Exit Stop MessageExit 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