Purpose
Specifies or adds a user mapping to a routing profile.
Syntax
USER MAP UPDATE [ID <user map id>] [USER <username>] [ACC <account string>] [ROLE <role>] [PRO <ldap/kerb/etc profile>] [REG <ldap/kerb/etc region>] [TW <time window>] RULE <routing rule> [ TOP | AFTER <user map id> | BEFORE <user map id> ]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
- user map id
- Unique identifier of the user map entry.
- username
- Name of the user. Name can contain a maximum of 25 characters.
- account string
- Account string expression that matches the account string stated at logon. It must be an exact match to the target user mapping.
- role
- Role of the user mapping that matches the role assigned to the logon by the authorization provider (only applicable to external authentication mechanisms).
- ldap/kerb/etc profile
- Profile of the user mapping that matches the profile assigned to the logon by the authorization provider (only applicable to external authentication mechanisms).
- ldap/kerb/etc region
- Specifies either the name of a Business Continuity Manager region or asterisk (*) to indicate any region. Use this parameter to determine a match with the logon Endpoint region. If you do not specify a region, the default asterisk (*) is used to specify any region.
- time window
- Name of the time window that you can use to automatically start or stop user mappings, updates, or scripts based on a scheduled time.
- routing rule
- 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 user map id
- Adds the user mapping in the priority list after the given usermapid. Shift all other user mapping ID numbers accordingly.
- BEFORE user map id
- Adds the user mapping in the priority list before the given usermapid. Shifts all other user mapping ID numbers accordingly.
- TOP user map id
- 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 user map id | BEFORE user map id is a designation of the mapping rules precedence in the list. Using TOP gives the rule the highest precedence. Using AFTER/BEFORE user map id places it either after or before the rule identified by the <user map id> 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 MAP UPDATE REGION r1 * * * * Region1DefaultRouting BEFORE 9999;
You can use the wildcard * to match arbitrary values.
Example
At the bcmadmin prompt:
| Input | Description |
|---|---|
| USER MAP UPDATE USER John REG region1 RULE ETL; | Maps user John to the ETL routing rule within region1. |
| USER MAP UPDATE ID 123 RULE readSys1; | Updates the user map entry identified by ID 123 with the "read from system 1" routing rule. |
| USER MAP UPDATE USER John RULE readSys1; | Assigns the "read from system 1" routing rule to user John. |
| USER MAP UPDATE USER John RULE REJECT ROLE Admin; | Maps user John to the the rule definition REJECT and assigns the role Admin. |
| USER MAP UPDATE USER John RULE REJECT PRO ldap; | Maps user John to the rule definition REJECT using the ldap authentication profile. |
| USER MAP UPDATE USER John PRO 2 RULE ETL TOP; | Maps user John to the rule definition ETL using profile 2, placing it at the top of the user map list. |
| USER MAP UPDATE USER John RULE REJECT TW Upgrade Outage; | Maps user John to the rule definition REJECT and applies the Upgrade Outage time window. |
| USER UPDATE ${USER} ${ACCOUNT} ${ROLE} ${PROFILE} ${REGION} ${ROUTING}; | A template for dynamically updating user mappings using variables for user, account, role, profile, region, and routing rule. |