Aller à la page of
Les manuels d’utilisation similaires
Un bon manuel d’utilisation
Les règles imposent au revendeur l'obligation de fournir à l'acheteur, avec des marchandises, le manuel d’utilisation IBM 4J. Le manque du manuel d’utilisation ou les informations incorrectes fournies au consommateur sont à la base d'une plainte pour non-conformité du dispositif avec le contrat. Conformément à la loi, l’inclusion du manuel d’utilisation sous une forme autre que le papier est autorisée, ce qui est souvent utilisé récemment, en incluant la forme graphique ou électronique du manuel IBM 4J ou les vidéos d'instruction pour les utilisateurs. La condition est son caractère lisible et compréhensible.
Qu'est ce que le manuel d’utilisation?
Le mot vient du latin "Instructio", à savoir organiser. Ainsi, le manuel d’utilisation IBM 4J décrit les étapes de la procédure. Le but du manuel d’utilisation est d’instruire, de faciliter le démarrage, l'utilisation de l'équipement ou l'exécution des actions spécifiques. Le manuel d’utilisation est une collection d'informations sur l'objet/service, une indice.
Malheureusement, peu d'utilisateurs prennent le temps de lire le manuel d’utilisation, et un bon manuel permet non seulement d’apprendre à connaître un certain nombre de fonctionnalités supplémentaires du dispositif acheté, mais aussi éviter la majorité des défaillances.
Donc, ce qui devrait contenir le manuel parfait?
Tout d'abord, le manuel d’utilisation IBM 4J devrait contenir:
- informations sur les caractéristiques techniques du dispositif IBM 4J
- nom du fabricant et année de fabrication IBM 4J
- instructions d'utilisation, de réglage et d’entretien de l'équipement IBM 4J
- signes de sécurité et attestations confirmant la conformité avec les normes pertinentes
Pourquoi nous ne lisons pas les manuels d’utilisation?
Habituellement, cela est dû au manque de temps et de certitude quant à la fonctionnalité spécifique de l'équipement acheté. Malheureusement, la connexion et le démarrage IBM 4J ne suffisent pas. Le manuel d’utilisation contient un certain nombre de lignes directrices concernant les fonctionnalités spécifiques, la sécurité, les méthodes d'entretien (même les moyens qui doivent être utilisés), les défauts possibles IBM 4J et les moyens de résoudre des problèmes communs lors de l'utilisation. Enfin, le manuel contient les coordonnées du service IBM en l'absence de l'efficacité des solutions proposées. Actuellement, les manuels d’utilisation sous la forme d'animations intéressantes et de vidéos pédagogiques qui sont meilleurs que la brochure, sont très populaires. Ce type de manuel permet à l'utilisateur de voir toute la vidéo d'instruction sans sauter les spécifications et les descriptions techniques compliquées IBM 4J, comme c’est le cas pour la version papier.
Pourquoi lire le manuel d’utilisation?
Tout d'abord, il contient la réponse sur la structure, les possibilités du dispositif IBM 4J, l'utilisation de divers accessoires et une gamme d'informations pour profiter pleinement de toutes les fonctionnalités et commodités.
Après un achat réussi de l’équipement/dispositif, prenez un moment pour vous familiariser avec toutes les parties du manuel d'utilisation IBM 4J. À l'heure actuelle, ils sont soigneusement préparés et traduits pour qu'ils soient non seulement compréhensibles pour les utilisateurs, mais pour qu’ils remplissent leur fonction de base de l'information et d’aide.
Table des matières du manuel d’utilisation
-
Page 1
St er ling C o nn e ct:Dire ct f o r UN IX Us e r G u id e Ve r s i o n 4 . 1 [...]
-
Page 2
[...]
-
Page 3
St er ling C o nn e ct:Dire ct f o r UN IX Us e r G u id e Ve r s i o n 4 . 1 [...]
-
Page 4
Note Before using this information and the pr oduct it supports, read the information in “Notices” on page 83. This edition applies to version 4.1 of IBM Sterling Connect:Direct for UNIX and to all subsequent r eleases and modifications until otherwise indicated in new editions. © Copyright IBM Corporation 1999, 2013. US Government Users Restr[...]
-
Page 5
Contents Chapter 1. Controlling and Monitoring Processes .............. 1 Overview of the Command Line Interface .... 1 Starting the CLI ............ 1 Stopping the CLI ............ 1 CLI Commands ............ 1 CLI Job Control ............ 3 CLI History Commands ......... 4 Overview of Sterling Connect:Direct Commands . 4 Submitting a Process ....[...]
-
Page 6
iv Sterling Connect:Direct for UNIX: User Guide[...]
-
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 fr om a native command line environment. Y ou can also use the Sterling Connect:Direct Br owser User Interface to perform some of these tasks. Starting the CL[...]
-
Page 8
Option Description V alue Sample Command Entry -P Identifies the custom string to use at the command line prompt. If the prompt string includes spaces or special characters, enclose it in single or double quotation marks. The prompt string can also be specified in the ndmapi.cfg file. If a prompt string is specified on the command line and in the n[...]
-
Page 9
Option Description V alue Sample Command Entry -e nn Defines the error level above which the CLI automatically exits. If the returned err or code is greater than the err or level specified, the CLI automatically exits. Use this command within shell scripts. This parameter prevents unwanted execution of commands following a command that generates an[...]
-
Page 10
enables you to edit the text of saved Processes, issue UNIX commands, and r esolve Process err ors without exiting and reentering the CLI. Use the following commands to switch the CLI Process: v Press the suspend character ( Control-Z ) to stop or suspend the CLI Pr ocess. v Issue the fg command to move the CLI Process to the for eground. Note: If [...]
-
Page 11
Abbreviations for Common Sterling Connect:Direct Commands The following table lists valid abbreviations for commonly used parameters for Sterling Connect:Direct commands: Parameter Abbreviation detail det quit q recids r ec release r el pname pnam, pna pnumber pnum sunday sun monday mon tuesday tue wednesday wed thursday thu friday fri saturday sat[...]
-
Page 12
v When typing commands, type the entire command name or type the first thr ee characters or abbreviate specific parameters. Refer to “Abbr eviations for Common Sterling Connect:Direct Commands” on page 5for a list of abbreviations. v Do not abbreviate Pr ocess statements and parameters. v File names, group names, user IDs, and passwor ds are va[...]
-
Page 13
Parameter Description V alues class The node-to-node session on which a Process can execute. A Process can execute on the class specified or any higher session class. The default class is specified as the sess.default parameter of the local.node recor d in the initialization parameters file. 1|n A numeric value from 1 to the value of maximum concur[...]
-
Page 14
Parameter Description V alues notify The user e-mail to receive Pr ocess completion messages. This parameter uses the rmail utility available in the UNIX System V mail facility to deliver the completion messages. Note: Sterling Connect:Direct does not validate the e-mail address or user ID supplied to the notify parameter . Invalid e-mail addresses[...]
-
Page 15
Parameter Description V alues snode Identifies the name of the secondary node. Setting this value overrides the snode value in the Process statement. The snode parameter is requir ed either on the submit command or Process statement. name | host name | nnn.nnn.nnn.nnn or nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn[; port name | nnnnn ]] name—Specifie[...]
-
Page 16
Parameter Description V alues snodeid Specifies security user IDs and security passwords on the SNODE. The snodeid subparameters can contain one or more alphanumeric characters. If Sterling Connect:Direct finds that a Pr ocess has no snodeid parameter or defines a snodeid parameter and the initialization parameter proxy .attempt is set to y , then [...]
-
Page 17
Parameter Description V alues startt Identifies the date, day , and time to start the Process. Sterling Connect:Dir ect places the Process in the T imer queue in WS (W aiting for Start T ime) status. The date, day , and time are positional parameters. If you do not specify date or day , a comma must precede time. Do not code the startt parameter wh[...]
-
Page 18
Parameter Description V alues tracel Specifies the level of trace to perform for a Process. T racing by Process can be turned on in the submit command or as part of the Process definition. If you identify the snode or pnode immediately after the trace level definition, the trace level is turned on for all Processes submitted to and from the node id[...]
-
Page 19
Example - Submit a Process and T urn On T racing 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. T race information is written to the default file SMGR.TRC. Changing Process Parame[...]
-
Page 20
Parameter Description V alue snode Locate the Process to be changed by the secondary node name. This parameter can be used to specify a specific remote node, a generic value for matching remote node names (using pattern matching), or a list of multiple remote node names. The secondary node name typically contains the 1–16 character remote Sterlin[...]
-
Page 21
Parameter Description V alue hold Moves the Process to the Hold or W ait queue. yes | no | call yes—Places the Process in the Hold queue in HO status until it is released by another change process command. no—Places the Process in the W ait queue in WC (W aiting for Connection) status; the Process executes as soon as resour ces are available. T[...]
-
Page 22
Y ou select the Process to delete by Process name, Pr ocess number , secondary node name, submitter , or any combination of the search criteria parameters. Specify at least one of the following search criteria parameters: Parameter Description V alue pname Identify the Process to delete by Process name. The Process name is limited to 8 characters o[...]
-
Page 23
The following command deletes all nonexecuting Processes submitted by user ID cduser on node dallas: delete process submitter=(dallas, cduser); Removing a Process from the Execution Queue The flush process command removes Pr ocesses from the Execution queue. Y ou select the Process to r emove by Process name, Pr ocess number , secondary node name, [...]
-
Page 24
Parameter Description V alue submitter Locate the Pr ocesses to remove by the node specification (the Sterling Connect:Direct node name) and user ID of the Process owner . ( node specification, userid )| generic |( list ) node specification, userid—Specifies the node specification (the Sterling Connect:Direct node name) and user ID. generic—Spe[...]
-
Page 25
Y ou can specify the force, immediate, quiesce, or step parameters with the stop command. Note: The force parameter is r equired when running Sterling Connect:Dir ect with the LU6.2 feature on any supported platform other than AIX. Following are the parameters for the stop command: Parameter Description force Forcibly terminates Sterling Connect:Di[...]
-
Page 26
Parameter Description V alue pname Locate the Process to view by Process name. The Process name is limited to 8 characters on Sterling Connect:Direct for Micr osoft W indows and Sterling Connect:Direct for z/OS. name | generic |( list ) name—Specifies the Process name, up to 8 alphanumeric characters. generic—Specifies a nonspecific value for t[...]
-
Page 27
Parameter Description V alue status Specifies the Processes to be viewed by Process status. If you do not specify a status value, information is generated for all status values. E X|H C|H E|H I|H O|H R|H S|P E | WC | WR | WS | (list) EX (Execution)—Specifies to select Processes from the Execution queue. HC (Held for Call)—Specifies to select Pr[...]
-
Page 28
Parameter Description V alue submitter Locate the Processes to view by the node specification (the Sterling Connect:Direct node name) and user ID of the Process owner . The length of this parameter is unlimited. ( node specification, userid )| generic |( list ) node specification, userid—Specifies the node specification (the Sterling Connect:Dire[...]
-
Page 29
Parameter Description V alue queue Specifies the Pr ocesses to be selected by the specified queue names. The default is all . all | exec | hold | wait | timer all—Selects Processes fr om all queues. this is the default. exec—Selects Processes fr om the Execution queue. hold—Selects Processes fr om the Hold queue. timer—Selects Processes fr [...]
-
Page 30
Parameter Description V alue status Specifies the Processes to be selected by Process status. If you do not specify a status value, information is generated for all status values. E X|H C|H E|H I|H O|H R|H S|P E |W C|W R|W S|( list ) EX (Execution)—Specifies to select Processes from the Execution queue. HC (Held for Call)—Specifies to select Pr[...]
-
Page 31
Parameter Description V alue submitter Locate the Processes to select by the node specification (the Sterling Connect:Direct node name) and user ID of the Process owner . The length of this parameter is unlimited. ( node specification, userid )| generic |( list ) node specification, userid—Specifies the node specification (the Sterling Connect:Di[...]
-
Page 32
Determining the Outcome of a Process The select statistics command is used to examine Process statistics fr om the Sterling Connect:Direct statistics file. The type of information in the statistics r eport includes copy status and execution events. The search criteria pr ovide flexibility in selecting information you want to display . The parameter[...]
-
Page 33
Parameter Description V alue pname Locate the statistics to select by Process name. The Process name is limited to 8 characters on Sterling Connect:Direct for Microsoft W indows and Sterling Connect:Direct for z/OS. name | generic |( list ) name—Specifies the Process name, up to 8 alphanumeric characters. generic—Specifies a nonspecific value f[...]
-
Page 34
Parameter Description V alue CTRM—Child Process terminated. CUKN—Child Process unknown status. CXIT—Child Process exited. DELP—The delete Process command issued. FLSP—The flush Process command issued. FMR V—Error occurr ed in function management. information receive operation. FMSD—Error occurr ed in function management. information s[...]
-
Page 35
Parameter Description V alue PSTR—Process started. QCEX—A Process moved fr om another queue to the EXEC queue. QCW A—A Process moved from another queue to the W AIT queue. QCTI—A Process moved fr om another queue to the TIMER queue. QCHO—A Process moved fr om another queue to the HOLD queue. RJED—The run job ended. RNCF—Remote node co[...]
-
Page 36
Parameter Description V alue UNKN—Unknown command issued. USEC—Security check for user ID failed. USMG—Sterling Connect:Direct is shutting down. XCMM—Command manager (CMGR) messages. XCPR—Copy receive. XCPS—Copy send. XIPT—Communication errors. XLKL—Low-level TCQ recor d locking errors. XMSG—Message sent to user exit. XP AE—Pars[...]
-
Page 37
Parameter Description V alue snode Locate the statistics file recor d by the secondary node name. This parameter can be used to specify a specific remote node, a generic value for matching remote node names (using pattern matching), or a list of multiple remote node names. The secondary node name typically contains the 1–16 character remote Sterl[...]
-
Page 38
Parameter Description V alue stopt Specifies that Sterling Connect:Direct sear ches for statistics recor ds up to and including the designated date, day , and time positional parameters. If you do not specify date or day , a comma must precede time. [ date | day ] [, hh:mm:ss [am|pm]] date—Specifies the day (dd), month (mm), and year (yy), which [...]
-
Page 39
Generating a Summary Report for a Process Y ou can use the select statistics command to generate a summary report for a Process. The following command generates summary statistics for Pr ocess number 9: sel stat pnumber=9 detail=no startt=(08/10/2008); The report consists of all r ecords fr om August 10, 2008. Sample output that describes all Proce[...]
-
Page 40
Parameter Description V alue cmgr T o trace the Command Manager . level=0 | 1|2|4 file=name level—Specifies the level of detail displayed in the trace output. The default is 4 . 0—T erminates the trace. 1—Is the basic level that provides function entry and function exit. 2—Includes level 1 plus function arguments. 4—Enables a [...]
-
Page 41
Parameter Description V alue pmgr T o trace the Process Manager . level=0 | 1|2|4 file=name level—Specifies the level of detail displayed in the trace output. The default is 4 . 0—T erminates the trace. 1—Is the basic level that provides function entry and function exit. 2—Includes level 1 plus function arguments. 4—Enables a [...]
-
Page 42
trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc; A partial sample trace output is illustrated in the following section. A trace identifies the Process ID and the function, the month and day , and the time in microseconds. The first column contains the Pr ocess ID. Column two indicates the month and day in the form of MM/DD. Column three indi[...]
-
Page 43
Chapter 2. Process Queuing Overview of the T ransmission Control Queue The TCQ controls Pr ocess execution as Sterling Connect:Direct operates. After you submit a Process, it is stor ed in the TCQ. The TCQ consists of four queues: Execution, W ait, T imer , and Hold. After you submit a Process, you can monitor the status, modify specific characteri[...]
-
Page 44
Scheduling Parameter Queue Comments retain=initial Hold A copy of the Process remains in the Hold queue and executes every time the Process Manager is initiated. retain=yes and hold=no or hold=call Hold A copy of the Process remains in the Hold queue to be executed when released. hold=yes Hold Y ou can execute the Process by specifying the change p[...]
-
Page 45
The Execution Queue Processes ar e placed in the Execution queue after Sterling Connect:Direct connects to the remote node. Pr ocesses normally come from the W ait queue, but also can be placed in the Execution queue by a submit command with maxdelay=0 specified. Processes in the Execution queue can be in execution (EX) status or pending execution [...]
-
Page 46
After a Process successfully completes, it is automatically deleted fr om the Execution queue. A flush process command with hold=yes moves a Process fr om the Execution queue and places it in the Hold queue. When a session is interrupted, the Pr ocess moves from the Execution queue to the T imer queue if retry values ar e specified. If connection i[...]
-
Page 47
The T imer Queue Processes ar e placed in the T imer queue by a submit command with the startt parameter specified. Processes in the W ait for Start T ime (WS) status are waiting for the start time to arrive before moving to the W ait queue. Processes also ar e placed in the T imer queue in Retry (WC) status if one of the following error conditions[...]
-
Page 48
Processes ar e placed in the Hold queue by a submit command with retain=initial, retain=yes, or hold=yes parameters specified. Pr ocesses submitted with hold=call also are placed in the Hold queue. Pr ocesses are moved fr om the T imer queue to the Hold queue by a change process command with hold=yes specified. Additionally , Processes ar e moved f[...]
-
Page 49
Chapter 3. Sterling Connect:Direct Utilities Introduction to T ranslation T ables Sterling Connect:Direct translates data fr om one character set code to a differ ent character set code, such as from ASCII to EBCDIC, based on a character translation table in the d_dir /ndm/xlate directory . Sterling Connect:Dir ect provides a default character tran[...]
-
Page 50
Compiling a T ranslation T able Using the ndmxlt Utility Before you begin Y ou can create or modify a translation table tailored to your r equirements with the ndmxlt utility program. T o invoke the ndmxlt utility , type the following command at the UNIX prompt: $ ndmxlt -ssourcefile -ooutputfile [ -rradix] [ -ffiller] -mxlatefile The parameters fo[...]
-
Page 51
3. Add the following lines to the bottom of the table. It should look like the table in “Creating a T ranslation T able” on page 43when you have added this information. # # Change the lowercase characters to uppercase. offset=61 C1 C2 C3 C4 C5 C6 C7 C8 C9 D1 D2 D3 D4 D5 D6 D7 D8 D9 E2 E3 E4 E5 E6 E7 E8 E9 4. Copy the modified file to cd_dir /nd[...]
-
Page 52
T o specify a customized table for data translation, include the following sysopts subparameter in the copy statement, where pathname/filename identifies the translation table: copy from file=filename to file=filename sysopts=":xlate.tbl=pathname/filename:" Refer to the UNIX section of the IBM ® Sterling Connect:Direct Pr ocesses W eb si[...]
-
Page 53
xxx is a 3-character Sterling Connect:Direct component identifier nnn is a 3-digit decimal number I is the standard, though not required, suffix Message File Record Format The following example shows the format of the message file recor d. Each recor d can be up to 4K bytes long. Optional parameters and values are in brackets. message id [long.text[...]
-
Page 54
short.text=CMGR RPC call returns NULL long.text=The ndmapi_sendcmd RPC call made by the API to the CMGR returns a NULL pointer.There is probably an RPC error.ndm.action=None user.action=First, check if the ndmcmgr is still running; it could have been killed accidently.If so, then abort the current CLI and restart the CLI. If the same problem occurs[...]
-
Page 55
Using the Standalone Batch Compression Utility Before you begin T o invoke the standalone batch compression utility (cdsacomp), type the following command at a UNIX prompt: cdsacomp Following are the parameters for the cdsacomp utility: Parameter Description V alues -m Specify which mode to use: precompr ess or decompress. This ar gument is requir [...]
-
Page 56
Parameter Description V alues -p Use this option to specify codepages for file conversion. Default is no codepage translation. This parameter is mutually exclusive with -xlate. source codepage, destination codepage -d Specify the datatype of the file. When you use “-m compress”, the datatype values result in the following: v text Strips newline[...]
-
Page 57
Parameter Description V alues -a Use this option to replace zero-length recor ds with a single, blank character . This parameter is valid only when you specify the following: “-d text” and “-m compress”. y|n y—yes n—no The default is y . Specify n if the data is copied to an i5OS or mainframe node. -h Use this option to display online h[...]
-
Page 58
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 the Copy Step The “precomp=yes” parameter is used when the file was compr essed[...]
-
Page 59
V alidate Configuration Files When you manually edit any of the five text-based Sterling Connect:Direct configuration files, the Configuration Checking Utility (cfgcheck) enables you to validate these files offline. The following files can be validated using this utility: userfile.cfg, initparm.cfg, netmap.cfg, ndmapi.cfg, and sysacl.cfg. Note: The[...]
-
Page 60
v Sterling Connect:Direct Secur e 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 cdcustrpt to generate a report on the base Ster[...]
-
Page 61
########################################################################### ####### Connect:Direct for UNIX 4.0.00 configuration report ####### ########################################################################### Connect:Direct for UNIX Version 4000, Build 00, IBM/RS6000 AIX, Fix date: 01OCT2007 Install directory: /sci/users/jbrown1/cd40 Loc[...]
-
Page 62
The following example shows an excerpt from a sample r eport: ===== Begin: Secure+ parameters ===== ========================================= All secure+ nodes: ************************************************************** * Secure+ Command Line Interface * * Connect:Direct for UNIX v4.0.00 * *------------------------------------------------------[...]
-
Page 63
Log.MaxVersions="5" [connection.info] # Connection information for Connect:Direct’s API port. (Used when forwarding files to the back office.) Comm.Info="spyglass;10102" Userid="jbrown1" Passwd="******** "# this is a test #ClientInfo="/sci/users/jbrown1/swift31/ndm/SwiftNet/Version3/program/<Encrypt[...]
-
Page 64
58 Sterling Connect:Direct for UNIX: User Guide[...]
-
Page 65
Chapter 4. Writing Custom Programs Introduction to W riting Custom Programs The Sterling Connect:Direct Application Programming Interface (API) allows you to write custom programs in either C or C++ to use with Sterling Connect:Dir ect. W ith the C functions or the C++ classes, you can create programs to perform the following tasks: v Establish a c[...]
-
Page 66
Platform C++ Compile Command 64-bit /opt/SUNWspro/bin/CC -xar ch=generic64 -DBSD_COMP -I../include -o sdksample sdksample.C ../lib/ndmapi64.a -L/usr/ucblib/sparcv9 -L/usr/lib/spar cv9 -L/usr/ucblib/amd64 -lsocket -lrpcsoc -lnsl -lelf -ldl -R/usr/ucblib/sparcv9 -R/usr/ucblib/amd64 HP 32-bit /opt/aCC/bin/aCC -AA -I../include -o sdksample sdksample.C [...]
-
Page 67
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_v2 HP-Itanium 32-bit /opt/ansic/bin/cc -I../inc[...]
-
Page 68
C++ Function C Function Description ndmapi_sendcmd() ndmapi_sendcmd_c() Sends commands to Sterling Connect:Direct. Y ou must provide the command text. The resp_mor eflag is a pointer to the flag indicating that more r esponses are pending for the executed command. Invoke ndmapi_recvr esp_c() for C programs or ndmapi_recvr esp() for C++ programs to [...]
-
Page 69
from the commands. Contr ol returns to the application when the connection is established and Sterling Connect:Direct is r eady for the first API request or when an error condition is set. Following is the format for the ndmapi_connect() or ndmapi_connect_c() function: int32 ndmapi_connect ERROR_H error, char * ndm_hostname, char * ndm_portname The[...]
-
Page 70
Receiving Responses Using ndmapi_recvresp() or ndmapi_recvresp_c() Use ndmapi_recvresp() or ndmapi_recvresp_c() to receive r esponses that are associated with a previous command sent fr om the application. Following is the format for ndmapi_recvresp() or ndmapi_recvresp_c() : int32 ndmapi_recvresp ERROR_H error int32 * resp_length, char * resp_buff[...]
-
Page 71
Parameter Description V alue DDS1—Destination disposition 1 DDS2—Destination disposition 2 DDS3—Destination disposition 3 DESC—Sterling Connect:Direct administrator description DFIL—Destination file DMSG—Destination message ID DNVL—Destination number of volumes DRCW—Records written DRUX—RUs received DVOL—Destination volume array[...]
-
Page 72
Parameter Description V alue PNOD—PNODE PNUM—Process number PPMN—PDS member name PR TY—Priority QUEU—Queue RECC—Record category RECI—Record ID RET A—Retain Process RMTP—Remote IP addr ess and port number RSTR—Process r estarted RUSZ—RU Size SACC—SNODE account SBID—Submitter node ID SBND—Submitter node name SBYR—Bytes r[...]
-
Page 73
Parameter Description V alue ST A T—Process status SNOD—SNODE SNVL—Source number of volumes SOPT—SYSOPTS recor d SRCR—Records r ead SRUX—RUs sent STIM—Schedule time STOP—Stop time of the event SUBM—Submitter ID SUBN—Submitter node SUMM—Summary output selector SVOL—Source volume array TIME—Submit time XLA T—T ranslation r[...]
-
Page 74
Sending a Command to Sterling Connect:Direct Using ndmapi_sendcmd() or ndmapi_sendcmd_c() Use ndmapi_sendcmd() or ndmapi_sendcmd_c() to allow a command to be sent to a Sterling Connect:Direct application. Following is the format of ndmapi_sendcmd() or ndmapi_sendcmd_c() : int32 rc, resp_moreflag; struct sendcmd_data ret_data; rc=ndmapi_sendcmd (err[...]
-
Page 75
Parameter Description V alue cmd_id A four -byte identifier of the command that was found in the command text. Following are the four -byte identifiers: /**************Command IDs*******************/ #define CHANGE_PROCESS 0x43484750 /* "CHGP" */ #define DELETE_PROCESS 0x44454c50 /* "DELP"*/ #define FLUSH_PROCESS 0x464c5350 /* &[...]
-
Page 76
Note: The environment variable NDMAPICFG must be set to the pathname of the client configuration file. Refer to “Starting the CLI” on page 1for instructions on setting the environment variable. T o use the ConnectDirectSession class, your application must include the cdunxsdk.h header file provided in the installation and must link with the ndm[...]
-
Page 77
Method Description Parameter Return V alues Connect Provides a connection to the Sterling Connect:Direct server . Connect() with a void parameter connects to the hostname and port specified in the client configuration file. void or a pointer to an IP address and port. CD_SUCCESS or CD_F AILURE DisConnect Disconnects the current session. void CD_SUC[...]
-
Page 78
Method Description Parameter Return V alues GetPreviousErr or Moves the error data pointer to the previous err or in the list. void TRUE—If successful F ALSE—If no previous err or exists. GetFirstError Moves the error data pointer to the first error in the list. void TRUE—If successful F ALSE—If no error is found. GetLastError Moves the err[...]
-
Page 79
// Methods for retrieving ReceiveResponse data... virtual const char *GetResponse(void) = 0; virtual int GetResponseLength(void) = 0; virtual bool MoreData(void) = 0; // Methods for retrieving SendCommand return data... virtual const char *GetCommandName(void) = 0; virtual long GetProcessNumber(void) = 0; virtual long GetProcessCount(void) = 0; // [...]
-
Page 80
74 Sterling Connect:Direct for UNIX: User Guide[...]
-
Page 81
Chapter 5. Writing User Exits User Exit Programs The user exit API functions allow you to write custom programs to use with Sterling Connect:Direct. The user exit pr ograms are used by Sterling Connect:Dir ect to invoke user-specific logic at strategic points within Sterling Connect:Dir ect execution. User exit programs must be C or C++ language pr[...]
-
Page 82
C++ Function C Function Description exit_child_init() exit_child_init_c() Use this function as the first line in a user exit program to initialize communications between Sterling Connect:Direct and the user exit pr ogram. recv_exit_msg() recv_exit_msg_c() Used by both Sterling Connect:Dir ect and the user exit program to r eceive a message from the[...]
-
Page 83
W aiting for a Message Using recv_exit_msg() or recv_exit_msg_c() The recv_exit_msg() or r ecv_exit_msg_c() function waits until it receives a message from Sterling Connect:Dir ect. Control is suspended until a message is r eceived or an error occurs. The r ecv_exit_msg() has the following format: int recv_exit_msg( int exit_flag ) int * msg_type, [...]
-
Page 84
The send_exit_file() or send_exit_file_c() function calls have the following return codes. Return codes for the function are defined in ndmapi.h. Header Header GOOD_RC The file descriptor was received successfully . ERROR_RC An error occurr ed and the file descriptor was not sent successfully . Possible causes include: Sterling Connect:Direct termi[...]
-
Page 85
Overview of User Exit Messages Sterling Connect:Direct sends and r eceives 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 fo raCp r ogram. For the exact definition of the data sent in each message, see the files located in d_dir /ndm/include/ user_[...]
-
Page 86
v UNIX user name v A copy of the Sterling Connect:Direct copy contr ol block v A copy of the Sterling Connect:Direct parsed sysopts str ucture (the copy control block contains the actual raw version from the pr ocess) FILE_OPEN_OUTPUT_REPL Y_MSG The user exit program sends a r eply message to the Sterling Connect:Direct FILE_OPEN_OUTPUT_MSG. The FI[...]
-
Page 87
v V ALIDA TE_MSG v V ALIDA TE_REPL Y_MSG CAUTION: If the security exit is used, Sterling Connect:Direct relies on it for user ID authentication. If the security exit is not implemented correctly , security can be compromised. GENERA TE_MSG Sterling Connect:Direct sends a generate message to the user exit pr ogram at the start of a session to establ[...]
-
Page 88
V ALIDA TE_REPL Y_MSG The user exit program sends a r eply message to the Sterling Connect:Direct V ALIDA TE_MSG. The V ALIDA TE_REPL Y_MSG contains: v Status value of zero for success or non zer o for failure v Status text message (if status value is failure, status text message is included in the error message) v ID used for security context v Se[...]
-
Page 89
Notices This information was developed for products and services of fered in the U.S.A. IBM may not offer the pr oducts, services, or features discussed in this document in other countries. Consult your local IBM repr esentative for information on the products and services curr ently available in your area. Any refer ence to an IBM product, pr ogra[...]
-
Page 90
incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the pr ogram(s) described in this publication at any time without notice. Any refer ences in this information to non-IBM W eb sites are provided for convenience only and do not in any manner serve as an endorsement of those W eb sites.[...]
-
Page 91
This information is for planning purposes only . The information herein is subject to change before the pr oducts described become available. This information contains examples of data and reports used in daily business operations. T o illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and p[...]
-
Page 92
Microsoft, W indows, W indows NT , and the W indows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. ITIL is a registered trademark, and a r egistered community trademark of the Of fice of Government Commerce, and is r egistered in the U.S. Patent and T rademark Office. UNIX is a register ed trademark of [...]
-
Page 93
Index Special characters -e nn parameter , direct command 3 -h parameter , for direct 3 -n name parameter , direct command 3 -p nnnnn parameter , direct command 3 -r parameter , direct command 3 -s parameter direct command 2 -t nn parameter , direct command 2 -x parameter , direct command 3 -z parameter , direct 3 &symbolic name parameter , sub[...]
-
Page 94
I informational responses, API 62 Initializing communications using user exit functions 76 L logfile parameter exit_child_init() function 76 M Managing Processes 37 maxdelay parameter 7 Message message ID format 46 Message file recor d format 47 Message File Content 46 Message file recor d format 47 Message files overview 46 Message text 47 Modifyi[...]
-
Page 95
User Exit Stop Message (continued) STOP_MSG 82 Using the Stand-alone Batch Compression Utility 49 Using translation during file transfer operationg 45 Utilities translation table and the copy statement 45 V V alidate configuration files 53 V ALIDA TE_MSG 81 V ALIDA TE_REPL Y_MSG 82 view process command 4 W W ait queue 40 W aiting for a message usin[...]
-
Page 96
90 Sterling Connect:Direct for UNIX: User Guide[...]
-
Page 97
[...]
-
Page 98
Product Number: 5725-C99 Printed in USA[...]