Syntax for the identification of users

In some administration statements and commands you have to select one or more users to which the statement or command is to apply.

The identification of users is represented in abbreviated form in the syntax diagrams:

• <user-identification> in the syntax of administration statements

• user-identification in the syntax of administration commands.

In fact, the identification of users consists of up to four different partial qualifications.

A <user-identification> is partially qualified if not all data was specified for a user specification. A partially qualified <user-identification> can do more than identify a user. Depending on the administration command, a partially qualified <user-identification> is only permitted if it identifies exactly one user.

A <user-identification> is fully qualified when the user specifies all the relevant partial qualifications for unique identification.

Syntax of <user-identification> in administration statements

The complete syntax diagram of <user-identification> is as follows:

<user-identification> = *TSN(...) / *BY-SELECT(...)

	*TSN(...)
		|	TSN = <alphanum-name 4..4>
	*BY-SELECT(...)
		|	HOST-NAME = *NONE / <text 1..8>
		|	,APPLICATION-NAME = *NONE / *TSN(...) / <text 1..8> / <x-text 1..8>
		|		*TSN(...)
		|			|	TSN = <alphanum-name 4..4>
		|	,CUSTOMER-NAME = *NONE / <text 1..8>
		|	,CONVERSATION-ID = *NONE / <x-text 1..8>

Operands

<user-identification> =

Identifies an SQL or CALL DML user or a group of such users.

<user-identification> = *TSN(...)
User's short ID.
The short ID is adequate for users from a timesharing program on the same computer.

TSN = <alphanum-name 4..4>

Task sequence number of the timesharing user's task

<user-identification> = *BY-SELECT(...)
Identifies the user (timesharing user or application user) by means of the user name, which consists of different partial qualifications.

HOST-NAME = *NONE / <text 1..8>
Symbolic host name. The default is *NONE (i.e. no entry is made for this operand).

APPLICATION-NAME = *NONE / *TSN(...) / <text 1..8>
Name of the application. The default is *NONE (i.e. no entry is made for this operand).The name of the application depends on the user:

• • • JDBC: „DBAxxxxx“ (xxxxx = DBA server's 5-digit port number)

    • ADO.NET: „ADOxxxxx“ (xxxxx = DBA server's 5-digit port number)

    • PHP: „PHPxxxxx“ (xxxxx = DBA server's 5-digit port number)

    • otherwise: name of the application

APPLICATION-NAME = *TSN(...)
The name of the application corresponds to the TSN of the timesharing user's task.

TSN = <alphanum-name 4..4>
Task sequence number of the timesharing user's task

CUSTOMER-NAME = *NONE / <text 1..8> / <x-text 1..8>
Name of the user.
The default is *NONE (i.e. no entry is made for this operand).
The name of the user depends on the operating mode:

• • • TIAM: program name

    • openUTM: KDCSIGN name

    • DCAM: any name.

    • JDBC, ADO.NET, PHP: IP address of the JDBC, ADO.NET or PHP client in hexadecimal form (e.g. 7FC864C8 for IP address 127.200.100.200)

CONVERSATION-ID = *NONE / <x-text 1..8>
UTM conversation ID.
The default is *NONE (i.e. no entry is made for this operand).
The operation ID depends on the user:

• • • JDBC, ADO.NET, PHP: connection ID of the JDBC,ADO.NET or PHP client to the DBA server

    • openUTM: conversation number of a UTM conversation (must be entered whenever the user is an asynchronous UTM conversation)

Unique user identification

In some user-specific administration statements, it is enough to specify a partially qualified <user-identification>. Other statements require that the user be identified uniquely. In such cases, you must specify all the relevant partial qualifications of <user-identification>. These cases are known as fully qualified.

Which partial qualifications of <user-identification> are relevant depends on the answers to the following questions:

• Is the user local or remote?

• Is the user a timesharing, application user, JDBC, ADO.NET or PHP?

The following overview indicates what you have to enter to identify a user uniquely:

User	Entry
Local user in timesharing mode	TSN = <alphanum-name 4..4>
Remote user in timesharing mode	HOST-NAME = <text 1..8> ,APPLICATION-NAME = *TSN(...)
Local user in transaction mode (non-openUTM)	APPLICATION-NAME = <text 1..8> ,CUSTOMER-NAME = <text 1..8>
Local user in transaction mode (openUTM)	APPLICATION-NAME = <text 1..8> ,CUSTOMER-NAME = <text 1..8> [,CONVERSATION-ID = <x-text 1..8>]
Remote user in transaction mode (non-openUTM)	HOST-NAME = <text 1..8> ,APPLICATION-NAME = <text 1..8> ,CUSTOMER-NAME = <text 1..8>
Remote user in transaction mode (openUTM)	HOST-NAME = <name 1..8> ,APPLICATION-NAME = <text 1..8> ,CUSTOMER-NAME = <text 1..8> [,CONVERSATION-ID = <x-text 1..8>]
JDBC ADO.NET PHP	HOST-NAME = <name 1..8> ,APPLICATION-NAME = <text 1..8> ,CUSTOMER-NAME = <x-text 1..8> ,CONVERSATION-ID = <x-text 1..8>

Table 22: Unique user identification

Syntax of user-identification in administration commands

The syntax of user-identification in the administration commands is as follows:

user-identification ::= {user-spec|tsn-spec}
user-spec ::= USER=[host],[{appl|tsn-spec}],[user][,vg-id]
tsn-spec ::= TSN=tsn

In cases in which unique identification of a user is required, you must specify all the relevant partial qualifications. The following options are available to do this:

User	Entry
Local user in timesharing mode	TSN=tsn
Remote user in timesharing mode	USER=host,TSN=tsn,
Local user in transaction mode (nonopenUTM)	USER=,appl,[user]
Local user in transaction mode (openUTM)	USER=,appl,[user][,vg-id]
Remote user in transaction mode (non-openUTM)	USER=host,appl,[user]
Remote user in transaction mode (openUTM)	USER=host,appl,[user][vg-id]

Table 23: Partial qualifications with unique user identification