CONNECT-CMD-SERVER

Create/modify entry in operator command table

Component:	BS2000
Functional area:	Operator function control
Domain:	not allocated
Privileges:	OPERATING
Routing code:	K

Function

The CONNECT-CMD-SERVER creates or modifies an entry in the command table. This entry links the command specified by means of CMD-NAME with a $CONSOLE application, which then functions as the command server.

The CONNECT-CMD-SERVER is only permitted for $CONSOLE applications.

Format

CONNECT-CMD-SERVER                                                                                                                            

CMD = *PARAMETERS (...)
	*PARAMETERS(...)
		|	CMD-NAME = <structured-name 1..30>
		|	,SAME-NAME = *NONE / list-poss(8): <structured-name 1..30>
		|	,AUTHORIZATION-CODE = *STD / <c-string 1..1>
		|	,PASSWORD-POSSIBLE = *NO / *YES
,SELECT = *EXTERNAL-SERVER (...)
	*EXTERNAL-SERVER(...)
		|	APPLICATION-NAME = *OWN
		|	,COMPLETION-CONTROL = *NO / *YES(...)
		|		*YES(...)
		|			|	QUESTION-POSSIBLE = *YES / *NO

Operands

CMD = *PARAMETERS(...)
Defines a structure for the command for which an entry is to be created or modified.

CMD-NAME = <text 1..30>
Defines the full command name for which an entry in the command table is to be created or modified. The command name may be up to 30 characters long and must comply with the naming convention for command names.

SAME-NAME = 
Defines aliases.
This operand is only relevant if a command is being defined. This operand is ignored when changing the attributes of commands that have already been entered.

SAME-NAME = *NONE
The command may only be entered using the command name specified using CMD-NAME.

SAME-NAME = list-poss(8): <text 1..30>
Defines the set of aliases that may be used in place of the command name defined using CMD-NAME. An alias may be up to 30 characters long and must comply with the naming convention for command names.

AUTHORIZATION-CODE =
Defines the authorization code which a command issuer must have in order to use the command identified by CMD-NAME.
An authorization code can only be generated when a new entry in the command table is being created. This operand is ignored when an existing entry is being modified.

AUTHORIZATION-CODE = *STD
This operand causes the specified command to be protected by the authorization code (default = E) defined in the class 2 system parameter NBACODE.

AUTHORIZATION-CODE = <c-string 1..1>
Explicit specification of an authorization code (A..Z, 0-9 or *,#,@,$).

PASSWORD-POSSIBLE =
Specifies whether SDF is to be called and passwords deleted before the command is logged in the CONSLOG file.

PASSWORD-POSSIBLE = *NO
The command is not checked to see whether it contains a password before being entered to the CONSLOG file.

PASSWORD-POSSIBLE = *YES
Causes SDF to be called in order to delete any passwords from the command before it is logged in the CONSLOG file. 

This operand value is only to be used in connection with SDF commands whose operands are all explicitly defined in the SDF syntax file (syntax of each operand can be analyzed).
Passwords in special commands that are not contained in the SDF syntax file or whose operands are not explicitly defined will be included in the system CONSLOG file.

SELECT = *EXTERNAL-SERVER(...)
The entry should refer to a special operator command. Special operator commands are commands which are executed in $CONSOLE applications (authorized user programs).

APPLICATION-NAME =
Defines the name of the $CONSOLE application.

APPLICATION-NAME = *OWN
The entry is to be made for a special operator command for which the command issuer should also function as the command processor.

COMPLETION-CONTROL =
Specifies whether commands to be executed in $CONSOLE applications can continue to be administered by the OPR subsystem once they have been passed to the application. This is always the case if the $CONSOLE application executing the command informs the OPR subsystem that command processing has terminated.

COMPLETION-CONTROL = *NO
The OPR subsystem considers the command involved to be terminated as soon as it has been passed to the executing application. Once the command has been passed on successfully, the OPR subsystem issues message NBR0768 to indicate command termination.

COMPLETION-CONTROL = *YES(...)
The OPR subsystem does not consider the command involved to be terminated until it has received a command termination acknowledgment from the executing application. The OPR subsystem indicates command termination, as for normal operator commands, by issuing message NBR0740.

QUESTION-POSSIBLE =
Informs the system whether the application may ask questions regarding the command during command execution.

QUESTION-POSSIBLE = *YES
The application may ask questions regarding the command during command execution. In this case, the job ID must be unique within the set of commands being processed by this application. Otherwise, the command is rejected.

QUESTIONS-POSSIBLE = *NO
The application does not ask any questions regarding the command during command execution.

Return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	No error
2	0	NBR1125	Parameters only evaluated at initial logon
2	0	NBR1118	Command executed, but at least one SAME name rejected
	1	CMD0202	Syntax error
	64	NBR1113	Maximum number of links already reached
1	64	NBR1115	Semantic operand error
	64	NBR1119	Command permitted only for $CONSOLE application
	64	NBR1124	Operand error connected with selected interface version