Skip to content

ADD_SYSUSERS_TO_GROUPS

ADD_SYSUSERS_TO_GROUPS assigns one or more ADOxx system users to one or more system user groups.

Syntax

leo-grammar
CC "UserMgt" ADD_SYSUSERS_TO_GROUPS	
    userids:strValue 
    usergroups:strValue
		[ sep:strValue ] .
# --> RESULT ecode:intValue .
CC "UserMgt" ADD_SYSUSERS_TO_GROUPS	
    userids:strValue 
    usergroups:strValue
		[ sep:strValue ] .
# --> RESULT ecode:intValue .

Parameters

  • userids (tokenStr) - a tokenStr containing the user ids to be added to groups, identifier by usergroups, seperated by space.
  • usergroups (tokenStr) - a tokenStr containing the target user group names, seperated by sep.
  • sep (strValue) - seperator to be used for usergroups, default value is ";"

Returns

  • ecode (intValue) - contains the error code or is 0 in case of success.

Details

usergroups is a string containing usergroup names, separated by the character passed with sep. The default value for sep is ";" (semicolon). However, it is recommended to use sep:"\t" (TAB).

The returned error code ecode is 0 if the command has been executed successfully. Any other value means that an error occured, e.g. if a specified user does not exist.

Note: This command is available within both the Development Toolkitand the Modelling Toolkit.
In the Modelling Toolkit usually only users that also have access to the Development Toolkit can call this command. However, with ACTIVATE_READONLY_COMMANDS_FOR_BPMTK this command can be activated also for non-admins (although it is actually not a readonly command).

Examples

Assign the system users with IDs 47111 and 47112 to the system user groupsSysGroup1and SysGroup2.

asc
CC "UserMgt" ADD_SYSUSERS_TO_GROUPS
        userids:"47111 47112"
        usergroups:"SysGroup1\tSysGroup2" sep:"\t"
CC "UserMgt" ADD_SYSUSERS_TO_GROUPS
        userids:"47111 47112"
        usergroups:"SysGroup1\tSysGroup2" sep:"\t"

See Also

Versions and Changes

Available since ADOxx 1.3