Overview of the Command Line Interface, Starting the CLI | IBM 4J

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 also use the Sterling Connect:Direct Browser User Interface to perform some of these tasks.

Starting the CLI

Procedure

1.If you have not defined the NDMAPICFG environment variable, type the following command for the appropriate shell, where d_dir is the path to the Sterling Connect:Direct subdirectory.

In the C shell:

% setenv NDMAPICFG d_dir/ndm/cfg/cliapi/ndmapi.cfg

In the Bourne or Korn shell:

$NDMAPICFG=d_dir/ndm/cfg/cliapi/ndmapi.cfg

$export NDMAPICFG

2.Type the following command to invoke Sterling Connect:Direct CLI. Type options as required:

$direct [-P string -s -t n -e nn -n name -p nnnnn -x -r -h -z]

Stopping the CLI

Procedure

Stop the CLI operation by typing Control-Dor quit at the prompt.

CLI Commands

Refer to the following table for a description of the command options and sample command entries:

© Copyright IBM Corp. 1999, 2013

1

Image 7

IBM 4J Overview of the Command Line Interface, Starting the CLI, Stopping the CLI, CLI Commands, Bourne or Korn shell

Contents

User Guide Page User Guide Copyright IBM Corporation 1999 Contents Iv Sterling ConnectDirect for Unix User Guide Stopping the CLI Overview of the Command Line InterfaceCLI Commands Starting the CLI Option Description Value Entry Sample Command Cdpnum CLI Job Control Command Abbreviation Description CLI History CommandsOverview of Sterling ConnectDirect Commands Command Parameter Abbreviation Abbreviations for Common Sterling ConnectDirect Commands Pname = A?PROD5 Submitting a ProcessParameter Description Values Parameter Description Values Id , pswd Username@hostname or user@localhost Name nnnnn Name host name nnn.nnn.nnn.nnn or Snodeid field Id ,pswd ,newpswd Specify retain=initial Following command submits the Process named copyfil Following command submits the Process named payroll Name generic list Following command submits the Process named copy.cdpChanging Process Parameters Parameter Description Value Node specification, userid generic list Remote node specification generic list Deleting a Process from the TCQ Number list Removing a Process from the Execution Queue Stopping Sterling ConnectDirect Flush process command has the following optional parameters Parameter Description Viewing a Process in the TCQ Pname 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 number All 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 Process Record id list Caev Capr CAEV, Capr Parameter Description Value Parameter Description Value Parameter Description Value Date day , hhmmss ampm Srcf=/path/file name Generating a Detailed Output Report for a Process Recid LOG Timepname Pnumber Stepname Ccod Fdbk Msgid Running System DiagnosticsGenerating a Summary Report for a Process Select Statistics COMM.TRC Smgr Trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc Scheduling Parameter Queue Comments Command DefinitionOverview of the Transmission Control Queue Scheduling Sterling ConnectDirect Activity Progression of a Process Through the TCQ Execution Queue Element Comment Wait QueueStatus Comment Hold Queue Timer Queue Held for Call indicates that the Process was Creating a Translation Table Introduction to Translation Tables Example-Creating a Translation Table Compiling a Translation Table Using the ndmxlt Utility Example-Modifying a Model Translation Table Using Translation During File Transfer Operations Diagnostic Number Description Translation Table Error MessagesAccessing Sterling ConnectDirect Messages Message File Content Following are the parameters for the message file record Following is a sample ndmmsg commandMessage File Record Format Displaying Message Text Sterling ConnectDirect for Unix User Guide Memory-The amount Using the Standalone Batch Compression UtilityFollowing are the parameters for the cdsacomp utility Level-Compression level Codepage Source codepage, destinationNnnnn Example-Decompress a Text File Example-Precompress a Text FileExample-Precompress a Text File With Codepage Conversion Example-Precompress a Binary File Examples-csdacomp Command Help Argument Description Validate Configuration FilesConfiguration Reports Cfgcheck command has the following arguments Type the following command at a Unix prompt Generating a Configuration Report on the Base Installation Sterling ConnectDirect Utilities Following example shows an excerpt from a sample report Sterling ConnectDirect Utilities Sterling ConnectDirect for Unix User Guide Compiler version to use for each platform Program using the C++ API callsIntroduction to Writing Custom Programs Compiling Custom Programs You want to create such as apicheck Platform Compile Command ++ Function Description Writing Custom C Programs Ndmerrenth Ndmerror Ndmnoerror Ndmapirecvresp or Receiving Responses Using ndmapirecvresp or ndmapirecvrespcNdmapirecvrespc Parameter Description Value PNOD-PNODE Truncated Following is a sample ndmapirecvresp functionSNOD-SNODE Return Code Description Ndmapirecvresp or ndmapirecvrespc to retrieve Selectstatistics or Selectprocess , the CLI Writing Custom C++ ProgramsNdmapisendcmdc function call has the following return codes Following is a sample ndmapisendcmd function Sterling ConnectDirect for Unix User Guide Cdfailure Method Description Parameter Return Values Cdsuccess = 0, Cdfailure = Following is the ConnectDirectSession class header Writing Custom Programs Sterling ConnectDirect for Unix User Guide Chown root exitskeleton User Exit ProgramsUser Exit Functions Program Description Return Code Goodrc Errorrc Exitprogram Waiting for a Message Using recvexitmsg or recvexitmsgc Header Following are the parameters for sendexitmsg or sendexitmsgc Statistics Exit Message Overview of User Exit MessagesFile Open Exit Messages Fileopenoutputreplymsg Security Exit Messages Validatemsg Validatereplymsg Generatemsg Copy 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