ADDRESS VOX Commands › Notification Manager Database Maintenance Commands › CREATELOGIN Command

CREATELOGIN Command

The CREATELOGIN command creates a new login.

This command has the following format:

ADDRESS VOX "CREATELOGIN USERNAME(name) 
  [ENTITY(key|name)]"

USERNAME

Specifies the name of the login to be created. Usernames can contain uppercase and lowercase letters, numbers, blanks, periods, and the following special characters: - _ @ # $ % \ . :

ENTITY

(Optional) Specifies the entity to which the login is to be associated. If no value is given, the login is created without an associated entity. This can either be a key or a name. Each entity is only allowed one login.

Note: The key or name given cannot be a Notification group.

Default: 0

Return Information:

After the CREATELOGIN command executes, it sets the special REXX return code variable RC.

• If the command executes successfully, the RC variable contains a value of zero. The REXX variable vox.CreateLogin.NewKey contains the key of the newly created login.
• If the command does not execute successfully, the RC variable contains a nonzero value. The VOX.ERROR variable also contains the complete VOX error message, which includes the four digit return code and error message text.

Usage Notes:

Privileges for a login cannot be set from the REXX interface. Each login created from REXX is assigned the same privileges as the Guest login account.

Example:

The following example creates an entry in the database for login SMIJO21:

ADDRESS VOX "CreateLogin USERNAME(SMIJ021) ENTITY(John Smith) "