IBM 4J manual Overview of User Exit Messages, Statistics Exit Message, File Open Exit Messages

Page 85

Overview of User Exit Messages

Sterling Connect:Direct sends and receives messages, using the send_exit_msg() and the recv_exit_msg() functions for a C++ program or the send_exit_msg_c() and the recv_exit_msg_c() functions for a C program. For the exact definition of the data sent in each message, see the files located in d_dir/ndm/include/ user_exit.h and d_dir/ndm/include/user_exit2.h.

Note: The copy control block is defined in user_exit2.h.

Statistics Exit Message

The statistics exit has only one type of message, the STATISTICS_LOG_MSG.

Sterling Connect:Direct sends a STATISTICS_LOG_MSG to the user exit program. Every time Sterling Connect:Direct writes a statistic record, this message provides an exact copy of the character string. The STATISTICS_LOG_MSG contains the Sterling Connect:Direct statistics record.

File Open Exit Messages

The file open exit has four types of messages:

vFILE_OPEN_OUTPUT_MSG

vFILE_OPEN_OUTPUT_REPLY_MSG

vFILE_OPEN_INPUT_MSG

vFILE_OPEN_INPUT_REPLY_MSG

The file open exit has the following limitations:

vThe oflag parameter passed to the user exit is already calculated based on the file disposition, as explicitly specified on the copy statement or using the default value. If the user exit changes the oflag to truncate and the original disposition is mod meaning the copy will append to the end of file if the file already exists, then the user exit causes the Process to behave differently from how the Process language is documented.

vDo not change the file type specified by the Process. For example, if the Process specifies a regular file, the user exit cannot open and return a file descriptor for a pipe. No facility is available to modify contents of the copy control block and return it to Sterling Connect:Direct.

vIf the oflag specifies opening a file with write access and the user exit changes access to read-only, Sterling Connect:Direct will fail when it attempts to write to a read-only file.

vThe upload and download parameters that restrict directory access are ignored for this user exit.

FILE_OPEN_OUTPUT_MSG

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

FILE_OPEN_OUTPUT_MSG to the user exit program to open the destination file. The FILE_OPEN_OUTPUT_MSG contains:

vThe open function oflag parameter (for example, O_CREATO_RDWRO_TRUNC)

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

Chapter 5. Writing User Exits 79

Page 84 Page 86
Image 85
Page 84 Page 86
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 CommandsPname = A?PROD5 Submitting a ProcessParameter 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 Element Comment Wait QueueStatus 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 amountCodepage Source codepage, destinationNnnnn 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 NdmnoerrorNdmapirecvresp or Receiving Responses Using ndmapirecvresp or ndmapirecvrespcNdmapirecvrespc 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 sendexitmsgcStatistics Exit Message Overview of User Exit MessagesFile Open Exit Messages Fileopenoutputreplymsg Security Exit MessagesValidatemsg Validatereplymsg GeneratemsgCopy 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
Top Page Image Contents