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

Page 7

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

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 CLIOption Description Value Entry Sample CommandCdpnum CLI Job ControlCommand Abbreviation Description CLI History CommandsOverview of Sterling ConnectDirect Commands CommandParameter 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 payrollName generic list Following command submits the Process named copy.cdpChanging Process Parameters Parameter Description ValueNode 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 Recid LOG Timepname Pnumber Stepname Ccod Fdbk Msgid Running System DiagnosticsGenerating a Summary Report for a Process Select StatisticsCOMM.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 ActivityProgression 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 OperationsDiagnostic Number Description Translation Table Error MessagesAccessing Sterling ConnectDirect Messages Message File ContentFollowing are the parameters for the message file record Following is a sample ndmmsg commandMessage File Record Format Displaying Message TextSterling ConnectDirect for Unix User Guide Memory-The amount Using the Standalone Batch Compression UtilityFollowing are the parameters for the cdsacomp utility Level-Compression levelCodepage Source codepage, destinationNnnnn Example-Decompress a Text File Example-Precompress a Text FileExample-Precompress a Text File With Codepage Conversion Example-Precompress a Binary FileExamples-csdacomp Command Help Argument Description Validate Configuration FilesConfiguration Reports Cfgcheck command has the following argumentsType 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 Compiler version to use for each platform Program using the C++ API callsIntroduction to Writing Custom Programs Compiling Custom ProgramsYou 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 Truncated Following is a sample ndmapirecvresp functionSNOD-SNODE Return Code DescriptionNdmapirecvresp 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 functionSterling 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 Chown root exitskeleton User Exit ProgramsUser Exit Functions Program DescriptionReturn 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