Purpose
Updates or adds a user mapping to a routing rule.
Syntax
USER UPDATE <username> <accountstring> <role> <profile> <region> <routing> [ TOP | AFTER <mapId> | BEFORE <mapId]>;Wildcards
| Wildcard Pattern Example | Description |
|---|---|
| * | Matches any text for the parameter using this wildcard (username, accountstring, role, profile). |
| *usr | Matches any pattern ending with usr. |
| *usr* | Matches any username containing the text usr. |
Parameters
- username
- Name of the user. Name can contain a maximum of 25 characters.
- accountstring
- Account string expression to use to determine a match with the account string explicitly stated at logon. It must be an exact match to the target user mapping.
- role
- Role of the user mapping that is used to determine the match to the role assigned to the logon by the authorization provider (only applicable to external authentication mechanisms) .
- profile
- Profile of the user mapping that is used to match to the profile assigned to the logon by the authorization provider (only applicable to external authentication mechanisms).
- region
- Specifies either the name of a Unity region or asterisk (*) to indicate any region. Use this parameter to determine a match with the logon Endpoint's region. If you do not specify a region, the default asterisk (*) is used to specify any region.
- routing
- Name of the routing rule that identifies the routing assigned to the session that corresponds to the logon matching criteria. You can use ROUTING LIST to obtain a list of available routing rule definitions.
- AFTER mapId
- Adds the user mapping in the priority list after the given usermapid. Shift all other user mapping ID numbers accordingly.
- BEFORE mapId
- Adds the user mapping in the priority list before the given usermapid. Shifts all other user mapping ID numbers accordingly.
- TOP mapId
- Positions the user mapping at the top of the user mapping priority list, with ID 1. Shifts all other user mappings ID numbers accordingly. The top user mapping is the first mapping considered when determining which routing rule to use for a given user.
Usage Considerations
- If either TOP, AFTER, or BEFORE is not specified, the user mapping is added to the end of the user mapping priority list, but before the default mapping values.
- Creates a new user mapping rule that consists of an optional REGION parameter, four logon matching field values, the routing assigned to the user mapping, and a mapping priority option. If another rule with the same matching criteria (region, username, accountstring, role, and profile) already exists, the existing rule is updated with the routing and priority you specify in the command.
- TOP | AFTER mapid | BEFORE mapid is a designation of the mapping rules precedence in the list. Using TOP gives the rule the highest precedence. Using AFTER/BEFORE mapid places it either after or before the rule identified by the <mapid> parameter. If no precedence is indicated then the user mapping is placed at the end of the list but with precedence over the default user mapping.
- You can create a default rule for a region using a specific region and wildcards for all other criteria. For example, USER UPDATE REGION r1 * * * * Region1DefaultRouting BEFORE 9999;
You can use the wildcard * to match arbitrary values.
Example
At the unityadmin prompt:
| Input | Description |
|---|---|
| USER UPDATE mark * * * readOnlySys1; |
The following example demonstrates how to create a user mapping for user Mark to use the read-only routing rule: |
| USER UPDATE *mktg* * * * readSys1; |
The following example demonstrates how to create a user mapping for all marketing users to user the "read from system 1" routing rule: |
| USER UPDATE * *RB* * * rbRouting TOP; |
The following example demonstrates how to create a user mapping for all account string containing RB to use the rbRouting routing rule. This should be the first rule to match: |
| USER UPDATE robert acct4 dba * prefReadOnly AFTER 3; |
The following example demonstrates how to create a user mapping after the current user map 3: |