Using REGISTER › Using the RGCMD Command

Using the RGCMD Command

You can also use the RGCMD command to perform REGISTER functions. The RGCMD command is a line command that lets you add or delete users and manage the REGISTER service machine. You do not receive an immediate response when you issue the RGCMD command. Instead, REGISTER assigns you a transaction number. When processing is complete, REGISTER sends you the console log that contains messages and all return codes. The file you receive is the REGISTER transaction number.

The syntax for the RGCMD command is:

      { ADD      } {USER(userid) GROUP(grpid) PHONE(number)
      {          } NAME(user) PARM(info) ZOOM(exitnam,zmdata)
      {          } PW(initpw)}
      {          }
      { DELete   } {USER(userid) GROUP(grpid) PHONE(number)
      {          } NAME(user) PARM(info) ZOOM(exitnam,zmdata)
      {          } PW(initpw)}
      {          }
      { PURge    } transnum
RGCMD {          }
      { Query    } {TRANs|ALL}
      {          }
      { SHUTdown } {TRANEND }
      {          } {IMMed  }
      {          }
      { ?        } [subcommand]

Parameter Descriptions

ADD

Defines a user to all applications defined in the REGISTER APPLS file the user has access to.

ALL

Affects all transactions.

DELete

Removes a user to all applications defined in the REGISTER APPLS file the user has access to.

GROUP(grpid)

Specifies an optional value that identifies the group that the user belongs to. Some systems, such as CA Director, use groups as the basis for user privileges. (One to eight characters.)

IMMed

Shuts down the REGISTER service machine immediately.

NAME(user)

Specifies the full name of the user (1 to 40 characters).

PARM(info)

Identifies parameters specific to selected applications that are passed to the application exit. Your systems programmer must code the application exit to scan the info line for data that may apply to it. (1 to 60 characters.)

PHONE(number)

Specifies the user's telephone number or extension. This information is optional. (1 to 10 characters.)

PURge

Removes the transaction from the queue.

PW(initpw)

Specifies the user's initial logon password. The application exits can use this password. (One to eight characters.)

Query

Displays information on the transaction in the REGISTER service machine.

SHUTdown

Terminates the REGISTER service machine.

TRANEND

Shuts down the REGISTER service machine when the current transaction ends. This is the default.

TRANs

Returns the status of transactions in REGISTER.

transnum

Specifies the four‑digit REGISTER transaction number.

USER(userid)

Specifies the ID of the user you are adding or removing. (One to eight characters.)

ZOOM(exitnam,zmdata)

Specifies the exit name and data block that is passed to the REGISTER service machine. You can specify multiple entries, but you must specify them in pairs. The exit name is the name of the exit program. In a full‑screen zoom, REGISTER obtains it from the application exit field in the REGISTER APPLS file.

This field overrides the REGISTER APPLS file. If you specify this parm, you must have a pair for each application exit to call in the REGISTER service machine, even if the zmdata is null. The order of the pairs affects the order that REGISTER calls the application exits.

You can only specify this parameter if a REXX program invokes RGCMD.

?

Displays the syntax of all of the RGCMD subcommands and operands. If you specify a subcommand with the ?, displays only that subcommand and syntax.