Page 3 - Sterling Connect:Direct for UNIX; User Guide
Sterling Connect:Direct for UNIX User Guide Version 4.1
Page 5 - Contents; Chapter 4. Writing Custom Programs
Contents Chapter 1. Controlling and MonitoringProcesses . . . . . . . . . . . . . . 1 Overview of the Command Line Interface . . . . 1 Starting the CLI . . . . . . . . . . . . 1 Stopping the CLI . . . . . . . . . . . . 1 CLI Commands . . . . . . . . . . . . 1 CLI Job Control . . . . . . . . . . . . ...
Page 6 - iv
Page 7 - Chapter 1. Controlling and Monitoring Processes; Overview of the Command Line Interface; is the path to the; Stopping the CLI; Procedure; Stop the CLI operation by typing; quit; CLI Commands
Chapter 1. Controlling and Monitoring Processes Overview of the Command Line Interface The Command Line Interface (CLI) enables you to submit Sterling Connect:Direct ® Processes and commands from a native command line environment. You can alsouse the Sterling Connect:Direct Browser User Interface to...
Page 9 - CLI Job Control
Option Description Value Sample CommandEntry -e nn Defines the error level abovewhich the CLI automaticallyexits. If the returned error codeis greater than the error levelspecified, the CLI automaticallyexits. Use this command within shellscripts. This parameter preventsunwanted execution ofcommands...
Page 10 - fg; command to move the CLI Process to the foreground.; CLI History Commands; Overview of Sterling Connect:Direct Commands; The CMGR currently limits the size of a Process file to 60K bytes.
enables you to edit the text of saved Processes, issue UNIX commands, and resolveProcess errors without exiting and reentering the CLI. Use the followingcommands to switch the CLI Process: v Press the suspend character ( Control-Z ) to stop or suspend the CLI Process. v Issue the fg command to move ...
Page 11 - Abbreviations for Common Sterling Connect:Direct Commands; Restricting the Scripts and UNIX Commands Users Can Execute; function. Refer to “User
Abbreviations for Common Sterling Connect:Direct Commands The following table lists valid abbreviations for commonly used parameters forSterling Connect:Direct commands: Parameter Abbreviation detail det quit q recids rec release rel pname pnam, pna pnumber pnum sunday sun monday mon tuesday tue wed...
Page 12 - Do not abbreviate Process statements and parameters.; “Generic” Parameter Value; Submitting a Process
v When typing commands, type the entire command name or type the first threecharacters or abbreviate specific parameters. Refer to “Abbreviations forCommon Sterling Connect:Direct Commands” on page 5for a list ofabbreviations. v Do not abbreviate Process statements and parameters. v File names, grou...
Page 18 - Example - Submit a Process That Runs Every Week; startt; Example - Submit a Process with No File Value
Parameter Description Values tracel Specifies the level of trace to perform for aProcess. Tracing by Process can be turned on inthe submit command or as part of the Processdefinition. If you identify the snode or pnodeimmediately after the trace level definition, thetrace level is turned on for all ...
Page 19 - Example - Submit a Process and Turn On Tracing; Changing Process Parameters
Example - Submit a Process and Turn On Tracing The following command submits the Process named copy.cdp: submit file=copy.cdp tracel=4 pnode; Because tracel is specified and the pnode parameter is included, an SMGR and COMM full trace is performed on the Process. Trace information is written to thed...
Page 20 - The optional parameters for the; command are the following:
Parameter Description Value snode Locate the Process to bechanged by the secondarynode name. This parametercan be used to specify aspecific remote node, ageneric value for matchingremote node names (usingpattern matching), or a list ofmultiple remote node names. The secondary node nametypically cont...
Page 21 - Deleting a Process from the TCQ; The; delete; process command removes a nonexecuting Process from the TCQ.
Parameter Description Value hold Moves the Process to the Holdor Wait queue. yes | no | call yes—Places the Process in the Holdqueue in HO status until it is releasedby another change process command. no—Places the Process in the Waitqueue in WC (Waiting for Connection)status; the Process executes a...
Page 22 - You select the Process to; by Process name, Process number, secondary node
You select the Process to delete by Process name, Process number, secondary node name, submitter, or any combination of the search criteria parameters. Specify atleast one of the following search criteria parameters: Parameter Description Value pname Identify the Process to deleteby Process name. Th...
Page 23 - Removing a Process from the Execution Queue; flush process; command removes Processes from the Execution queue. You
The following command deletes all nonexecuting Processes submitted by user IDcduser on node dallas: delete process submitter=(dallas, cduser); Removing a Process from the Execution Queue The flush process command removes Processes from the Execution queue. You select the Process to remove by Process...
Page 24 - The flush process command has the following optional parameters:; Stopping Sterling Connect:Direct; stop
Parameter Description Value submitter Locate the Processes toremove by the nodespecification (the SterlingConnect:Direct nodename) and user ID of theProcess owner. ( node specification, userid ) | generic | ( list ) node specification, userid—Specifies the nodespecification (the Sterling Connect:Dir...
Page 25 - Viewing a Process in the TCQ; view process; command is used to view Processes in the TCQ when the local
You can specify the force, immediate, quiesce, or step parameters with the stopcommand. Note: The force parameter is required when running Sterling Connect:Direct with the LU6.2 feature on any supported platform other than AIX. Following are the parameters for the stop command: Parameter Description...
Page 28 - The following command displays the specified Process number:; Monitoring Process Status in the TCQ; select process
Parameter Description Value submitter Locate the Processes to viewby the node specification (theSterling Connect:Direct nodename) and user ID of theProcess owner. The length ofthis parameter is unlimited. ( node specification, userid ) | generic | ( list ) node specification, userid—Specifies the no...
Page 31 - Output from the command is displayed in the following table:
Parameter Description Value submitter Locate the Processes toselect by the nodespecification (the SterlingConnect:Direct node name)and user ID of the Processowner. The length of thisparameter is unlimited. ( node specification, userid ) | generic | ( list ) node specification, userid—Specifies the n...
Page 32 - Determining the Outcome of a Process; select statistics; command is used to examine Process statistics from the
Determining the Outcome of a Process The select statistics command is used to examine Process statistics from the Sterling Connect:Direct statistics file. The type of information in the statistics reportincludes copy status and execution events. The search criteria provide flexibility in selecting i...
Page 38 - Generating a Detailed Output Report for a Process; You can use the; command to generate a detailed report for a; ndmmsg
Parameter Description Value stopt Specifies that SterlingConnect:Direct searchesfor statistics records up toand including thedesignated date, day, andtime positionalparameters. If you do notspecify date or day, acomma must precedetime. [ date | day ] [, hh:mm:ss [am|pm]] date—Specifies the day (dd),...
Page 39 - Generating a Summary Report for a Process; Running System Diagnostics
Generating a Summary Report for a Process You can use the select statistics command to generate a summary report for a Process. The following command generates summary statistics for Process number9: sel stat pnumber=9 detail=no startt=(08/10/2008); The report consists of all records from August 10,...
Page 43 - Chapter 2. Process Queuing; Overview of the Transmission Control Queue; Scheduling Sterling Connect:Direct Activity; Process; statement; submit; Scheduling parameters are listed in the following section:
Chapter 2. Process Queuing Overview of the Transmission Control Queue The TCQ controls Process execution as Sterling Connect:Direct operates. After yousubmit a Process, it is stored in the TCQ. The TCQ consists of four queues:Execution, Wait, Timer, and Hold. After you submit a Process, you can moni...
Page 44 - command to examine that status of; Progression of a Process Through the TCQ
SchedulingParameter Queue Comments retain=initial Hold A copy of the Process remains in the Hold queueand executes every time the Process Manager isinitiated. retain=yes andhold=no or hold=call Hold A copy of the Process remains in the Hold queueto be executed when released. hold=yes Hold You can ex...
Page 45 - The Execution Queue
The Execution Queue Processes are placed in the Execution queue after Sterling Connect:Direct connectsto the remote node. Processes normally come from the Wait queue, but also can beplaced in the Execution queue by a submit command with maxdelay=0 specified. Processes in the Execution queue can be i...
Page 46 - parameter. By default, the Process moves to the Hold; The Wait Queue; The following table shows the status values for the Wait queue:
After a Process successfully completes, it is automatically deleted from theExecution queue. A flush process command with hold=yes moves a Process fromthe Execution queue and places it in the Hold queue. When a session isinterrupted, the Process moves from the Execution queue to the Timer queue ifre...
Page 47 - The Timer Queue; Processes move from the Timer queue to the Wait queue. A; The Hold Queue
The Timer Queue Processes are placed in the Timer queue by a submit command with the starttparameter specified. Processes in the Wait for Start Time (WS) status are waitingfor the start time to arrive before moving to the Wait queue. Processes also areplaced in the Timer queue in Retry (WC) status i...
Page 48 - Processes are moved from the Hold queue to the Execution queue by a; command with the release parameter specified.
Processes are placed in the Hold queue by a submit command with retain=initial,retain=yes, or hold=yes parameters specified. Processes submitted with hold=callalso are placed in the Hold queue. Processes are moved from the Timer queue tothe Hold queue by a change process command with hold=yes specif...
Page 49 - Chapter 3. Sterling Connect:Direct Utilities; Introduction to Translation Tables; To create a translation table, either copy the file called /
Chapter 3. Sterling Connect:Direct Utilities Introduction to Translation Tables Sterling Connect:Direct translates data from one character set code to a differentcharacter set code, such as from ASCII to EBCDIC, based on a character translationtable in the d_dir /ndm/xlate directory. Sterling Connec...
Page 50 - Compiling a Translation Table Using the ndmxlt Utility; Before you begin; To invoke the; ndmxlt; utility, type the following command at the UNIX prompt:; Example—Creating a Translation Table; About this task; Open the new translation table with a text editor.
Compiling a Translation Table Using the ndmxlt Utility Before you begin You can create or modify a translation table tailored to your requirements with thendmxlt utility program. To invoke the ndmxlt utility, type the following command at the UNIX prompt: $ ndmxlt -ssourcefile -ooutputfile [ -rradix...
Page 51 - Example—Modifying a Model Translation Table; Copy the modified file to; Using Translation During File Transfer Operations
3. Add the following lines to the bottom of the table. It should look like the tablein “Creating a Translation Table” on page 43when you have added thisinformation. ## Change the lowercase characters to uppercase.offset=61C1 C2 C3 C4 C5 C6 C7 C8 C9 D1 D2 D3 D4 D5 D6 D7D8 D9 E2 E3 E4 E5 E6 E7 E8 E9 4...
Page 52 - identifies the; Refer to the UNIX section of the IBM; copy; Translation Table Error Messages; Accessing Sterling Connect:Direct Messages; display message text with the; Message File Content
To specify a customized table for data translation, include the following sysoptssubparameter in the copy statement, where pathname/filename identifies the translation table: copy from file=filename to file=filenamesysopts=":xlate.tbl=pathname/filename:" Refer to the UNIX section of the IBM ...
Page 53 - Message File Record Format; Displaying Message Text
xxx is a 3-character Sterling Connect:Direct component identifiernnn is a 3-digit decimal numberI is the standard, though not required, suffix Message File Record Format The following example shows the format of the message file record. Each recordcan be up to 4K bytes long. Optional parameters and ...
Page 55 - Using the Standalone Batch Compression Utility; Following are the parameters for the cdsacomp utility:
Using the Standalone Batch Compression Utility Before you begin To invoke the standalone batch compression utility (cdsacomp), type the followingcommand at a UNIX prompt: cdsacomp Following are the parameters for the cdsacomp utility: Parameter Description Values -m Specify which mode to use: precom...
Page 57 - Example—Precompress a Text File
Parameter Description Values -a Use this option to replace zero-lengthrecords with a single, blank character. This parameter is valid only when youspecify the following: “-d text” and “-mcompress”. y | n y—yes n—no The default is y . Specify n if the data is copied to an i5OS ormainframe node. -h Us...
Page 58 - Examples—csdacomp Command Help
cdsacomp -m decompress -d text-i compressed.file-o dest.file-x /home/cd/ndm/xlate/def_recv.xlt Examples—csdacomp Command Help Requesting a summary of cdsacomp command parameters and help options: cdsacomp -h Example—Decompress a File on the Remote Node During theCopy Step The “precomp=yes” parameter...
Page 59 - Validate Configuration Files; cfgcheck; Configuration Reports
Validate Configuration Files When you manually edit any of the five text-based Sterling Connect:Directconfiguration files, the Configuration Checking Utility (cfgcheck) enables you tovalidate these files offline. The following files can be validated using this utility:userfile.cfg, initparm.cfg, net...
Page 60 - Generating a Configuration Report on the Base Installation; Enter
v Sterling Connect:Direct Secure Plus for UNIX v Sterling Connect:Direct for SWIFTNet for UNIX During the Sterling Connect:Direct installation, cdcustrpt is installed in the <installation> /etc/ directory. Generating a Configuration Report on the Base Installation Before you begin When you use...
Page 61 - installation
################################################################################## Connect:Direct for UNIX 4.0.00 configuration report ####### ###########################################################################Connect:Direct for UNIX Version 4000, Build 00, IBM/RS6000 AIX, Fix date:01OCT2007...
Page 62 - The following example shows an excerpt from a sample report:
The following example shows an excerpt from a sample report: ===== Begin: Secure+ parameters ===== =========================================All secure+ nodes: *************************************************************** Secure+ Command Line Interface * * Connect:Direct for UNIX v4.0.00 * *-------...
Page 65 - Introduction to Writing Custom Programs; Establish a connection to the Sterling Connect:Direct server; Compiling Custom Programs
Chapter 4. Writing Custom Programs Introduction to Writing Custom Programs The Sterling Connect:Direct Application Programming Interface (API) allows youto write custom programs in either C or C++ to use with Sterling Connect:Direct.With the C functions or the C++ classes, you can create programs to...
Page 67 - Writing Custom C Programs
Platform C Compile Command HP 32-bit /opt/ansic/bin/cc -I../include -o apicheck apicheck.c ../lib/ndmapi.a -lrpcsoc -lnsl -ldld -Wl,+s -lcl-lstd_v2 -lCsup_v2 64-bit /opt/ansic/bin/cc +DD64 -I../include -o apicheck apicheck.c ../lib/ndmapi64.a -L/usr/lib/pa20_64 -lnsl-ldld -Wl,+s -lcl -lstd_v2 -lCsup...
Page 68 - The following code defines the ERROR_H structure:
C++ Function C Function Description ndmapi_sendcmd() ndmapi_sendcmd_c() Sends commands to Sterling Connect:Direct.You must provide the command text. Theresp_moreflag is a pointer to the flagindicating that more responses are pendingfor the executed command. Invokendmapi_recvresp_c() for C programs o...
Page 73 - Following is a sample
Parameter Description Value STAT—Process status SNOD—SNODE SNVL—Source number ofvolumes SOPT—SYSOPTS record SRCR—Records read SRUX—RUs sent STIM—Schedule time STOP—Stop time of the event SUBM—Submitter ID SUBN—Submitter node SUMM—Summary outputselector SVOL—Source volume array TIME—Submit time XLAT—...
Page 78 - Following is the ConnectDirectSession class header:
Method Description Parameter Return Values GetPreviousError Moves the error data pointer tothe previous error in the list. void TRUE—If successful FALSE—If noprevious errorexists. GetFirstError Moves the error data pointer tothe first error in the list. void TRUE—If successful FALSE—If no erroris fo...
Page 81 - Chapter 5. Writing User Exits; User Exit Programs; The user exit programs are described in the following:; User Exit Functions; or
Chapter 5. Writing User Exits User Exit Programs The user exit API functions allow you to write custom programs to use withSterling Connect:Direct. The user exit programs are used by Sterling Connect:Directto invoke user-specific logic at strategic points within Sterling Connect:Directexecution. Use...
Page 86 - Security Exit Messages
v UNIX user name v A copy of the Sterling Connect:Direct copy control block v A copy of the Sterling Connect:Direct parsed sysopts structure (the copy controlblock contains the actual raw version from the process) FILE_OPEN_OUTPUT_REPLY_MSG The user exit program sends a reply message to the Sterling...
Page 88 - User Exit Stop Message; You can access the log files through the normal; fprintf
VALIDATE_REPLY_MSG The user exit program sends a reply message to the Sterling Connect:DirectVALIDATE_MSG. The VALIDATE_REPLY_MSG contains: v Status value of zero for success or non zero for failure v Status text message (if status value is failure, status text message is included inthe error messag...
Page 89 - Notices; IBM Director of Licensing
Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your are...
Page 90 - IBM Corporation
incorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice. Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner ...
Page 91 - Trademarks; are trademarks or registered trademarks of
This information is for planning purposes only. The information herein is subject tochange before the products described become available. This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thena...