From Bright Pattern Documentation
Wyler.metge (talk | contribs) (→Settings: clarifications based on trac #37254) |
Wyler.metge (talk | contribs) (Updated via BpClonePage extension. Source page: draft:Scenario-builder-reference-guide/ScenarioBlocks/GetUserConfiguration) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 21: | Line 21: | ||
; User properties to return | ; User properties to return | ||
| − | : If a user is found based on the ''Find user by'' and ''Value'' criteria, you can assign one or more of the user's properties to a variable. This variable can then be accessed elsewhere in the workflow. Click '''Add''', select the desired ''User property'', and indicate the ''Variable name'' to store the property's value: | + | : If a user is found based on the ''Find user by'' and ''Value'' criteria, you can assign one or more of the user's properties to a variable. This variable can then be accessed elsewhere in the workflow. Click '''Add''', select the desired ''User property'', and indicate the ''Variable name'' to store the property's value. |
| + | : The following user properties can be selected, using the names as they appear in the Contact Center Administrator application: <br /> | ||
:* '''First Name''' – The user’s first name | :* '''First Name''' – The user’s first name | ||
:* '''Last Name''' – The user’s last name | :* '''Last Name''' – The user’s last name | ||
| Line 30: | Line 31: | ||
:* '''Team ID''' – The global unique identifier of the user’s team in system configuration | :* '''Team ID''' – The global unique identifier of the user’s team in system configuration | ||
:* '''Team name''' – The name of the user’s team | :* '''Team name''' – The name of the user’s team | ||
| − | :* '''Voice Mail Greeting | + | :* '''Voice Mail Greeting ID''' – The ID of the user’s currently selected voicemail greeting. The greeting can be accessed with the special URL <code>config://<Voice Mail Greeting ID></code> |
:* '''Skill''' – The identifier of user’s skill from the specified group with a non-zero value; this parameter can be used for group-based routing (other users with the same skill); see the description of option ''Specific skill from variable'' of the Find Agent block for more information | :* '''Skill''' – The identifier of user’s skill from the specified group with a non-zero value; this parameter can be used for group-based routing (other users with the same skill); see the description of option ''Specific skill from variable'' of the Find Agent block for more information | ||
:* '''User ID''' – The global unique identifier of this user in system configuration; user ID can be used, for example, to associate contacts/cases/interactions in third-party systems with agents who handled them in order to facilitate personal routing; see the description of option ''Specific agent'' of the [[scenario-builder-reference-guide/FindAgent|Find Agent]] block for more information. | :* '''User ID''' – The global unique identifier of this user in system configuration; user ID can be used, for example, to associate contacts/cases/interactions in third-party systems with agents who handled them in order to facilitate personal routing; see the description of option ''Specific agent'' of the [[scenario-builder-reference-guide/FindAgent|Find Agent]] block for more information. | ||
| − | :* '''User Type''' - Indicates "user" or "hunt group" representing that the user found is an individual user or a hunt group <br | + | :* '''User Type''' - Indicates "user" or "hunt group" representing that the user found is an individual user or a hunt group <br /> |
| − | If the search criterion is Phone (hard or soft) and the phone number found is associated with a hunt group, the fields return the following information: | + | :If the search criterion is Phone (hard or soft) and the phone number found is associated with a hunt group, the fields return the following information: |
| − | + | :* '''First Name''' – The hunt group's name | |
| − | * '''First Name''' – The hunt group's name | + | :* '''Last Name''' – none |
| − | * '''Last Name''' – none | + | :* '''Login ID''' – none |
| − | * '''Login ID''' – none | + | :* '''Email address''' – The email address of the user indicated in the Use voicemail box of field for the hunt group |
| − | * '''Email address''' – The email address of the user indicated in the Use voicemail box of field for the hunt group | + | :* '''Softphone number''' – none |
| − | * '''Softphone number''' – none | + | :* '''Hardphone number''' – none |
| − | * '''Hardphone number''' – none | + | :* '''Team ID''' – none |
| − | * '''Team ID''' – none | + | :* '''Team name''' – none |
| − | * '''Team name''' – none | + | :* '''Voice Mail Greeting ID''' – The ID of the hunt group’s custom greeting, if one exists, otherwise the ID of the contact center's default voicemail greeting. The greeting can be accessed with the special URL <code>config://<Voice Mail Greeting ID></code> |
| − | * '''Voice Mail Greeting | + | :* '''Skill''' – none |
| − | * '''Skill''' – none | + | :* '''User ID''' – The global unique identifier of the user specified in the Use voicemail box of field for the hunt group |
| − | * '''User ID''' – The global unique identifier of the user specified in the Use voicemail box of field for the hunt group | + | :* '''User Type''' - Indicates "hunt group" representing that the user found is a group and not an individual user <br></br> |
| − | * '''User Type''' - Indicates "hunt group" representing that the user found is a group and not an individual user <br></br> | ||
Scenario variable names are specified as strings and are referenced using the ''$(varname)'' format. For example, if ''last.name'' is specified as the variable name, its value can be retrieved elsewhere in the workflow using ''$(last.name)''. | Scenario variable names are specified as strings and are referenced using the ''$(varname)'' format. For example, if ''last.name'' is specified as the variable name, its value can be retrieved elsewhere in the workflow using ''$(last.name)''. | ||
Latest revision as of 09:34, 26 June 2025
Get User Configuration
The Get User Configuration scenario block obtains one or more of the properties of a user, such as username, phone number, email address, or unique identifier, and saves them in scenario variables for future use.
Settings
- Title text
- Title text is the name of the instance of the block. Enter a name in the text field and click the Update button at the bottom of the Edit pane. The new name of the block appears in the flowchart.
- Find user by
- Find user by specifies the type of the property that will be used to find the user. You can find a user by using the following properties:
- Login ID – The username
- Email address – The user’s email address
- Phone – The user’s assigned phone extension or default hardphone number
- User ID – The global unique identifier of this user in system configuration; global identifiers can be used, for example, to associate contacts/cases/interactions in third-party systems with agents who handled them
- Value
- Value specifies the value of the property that will be used to find the user.
- User properties to return
- If a user is found based on the Find user by and Value criteria, you can assign one or more of the user's properties to a variable. This variable can then be accessed elsewhere in the workflow. Click Add, select the desired User property, and indicate the Variable name to store the property's value.
- The following user properties can be selected, using the names as they appear in the Contact Center Administrator application:
- First Name – The user’s first name
- Last Name – The user’s last name
- Login ID – The user’s username
- Email address – The user’s email address
- Softphone number – The user’s phone extension
- Hardphone number – The user’s default hardphone number
- Team ID – The global unique identifier of the user’s team in system configuration
- Team name – The name of the user’s team
- Voice Mail Greeting ID – The ID of the user’s currently selected voicemail greeting. The greeting can be accessed with the special URL
config://<Voice Mail Greeting ID> - Skill – The identifier of user’s skill from the specified group with a non-zero value; this parameter can be used for group-based routing (other users with the same skill); see the description of option Specific skill from variable of the Find Agent block for more information
- User ID – The global unique identifier of this user in system configuration; user ID can be used, for example, to associate contacts/cases/interactions in third-party systems with agents who handled them in order to facilitate personal routing; see the description of option Specific agent of the Find Agent block for more information.
- User Type - Indicates "user" or "hunt group" representing that the user found is an individual user or a hunt group
- If the search criterion is Phone (hard or soft) and the phone number found is associated with a hunt group, the fields return the following information:
- First Name – The hunt group's name
- Last Name – none
- Login ID – none
- Email address – The email address of the user indicated in the Use voicemail box of field for the hunt group
- Softphone number – none
- Hardphone number – none
- Team ID – none
- Team name – none
- Voice Mail Greeting ID – The ID of the hunt group’s custom greeting, if one exists, otherwise the ID of the contact center's default voicemail greeting. The greeting can be accessed with the special URL
config://<Voice Mail Greeting ID> - Skill – none
- User ID – The global unique identifier of the user specified in the Use voicemail box of field for the hunt group
- User Type - Indicates "hunt group" representing that the user found is a group and not an individual user
Scenario variable names are specified as strings and are referenced using the $(varname) format. For example, if last.name is specified as the variable name, its value can be retrieved elsewhere in the workflow using $(last.name).
For more information, see Contact Center Administrator Guide sections Users, Teams, and Skill Levels.
