IBM Connect:Direct Command Syntax

Use the same command syntax for commands typed at the CLI prompt or used as the command text parameter for an ndmapi_sendcmd() function. Refer to Writing User Exits, for details on function calls. The following conventions are used when typing commands:

  • When selecting a password or user ID, do not use IBM Connect:Direct keywords.
  • Be aware that user names and file names are case sensitive.
  • Type an individual command keyword in uppercase, lowercase, or mixed-case characters.
  • Terminate all commands with a semicolon (;).
  • When typing commands, type the entire command name or type the first three characters or abbreviate specific parameters. Refer to Abbreviations for Common IBM Connect:Direct Commandsfor a list of abbreviations.
  • Do not abbreviate Process statements and parameters.
  • File names, group names, user IDs, and passwords are variable length strings and can be any length.
  • A IBM Connect:Direct node name is 1–16 characters long. The name of a record in the netmap describing a remote node is typically the remote IBM Connect:Direct node name, but can be any string 1–256 characters long. You can also specify a remote node name as an IP address or hostname and a port number or port name.

“Generic” Parameter Value

When the word generic is specified as a parameter value in a syntax definition, provide a string that can include the asterisk (*) and question mark (?) characters. These characters provide a pattern matching or wildcard facility for parameter values. The asterisk matches zero or more characters, and the question mark matches any single character. The following sample illustrates the use of the asterisk and question mark characters:


The generic Process name specified in the previous sample shows a specification that matches all Processes beginning with the letter A, followed by any single character in position two with the string PROD5 in positions three through seven. The asterisk takes the place of zero or more characters beginning in position eight.

“List” Parameter Value

When (list) is a parameter value, you can specify multiple parameter values by enclosing the group in parentheses and separating each value with a comma. A list can also include generic values. The following command illustrates a list:

(pnumber1, pnumber2, pnumber3)