(Update with the copy of version:DRAFT) |
m (1 révision importée) |
||
Ligne 1 : | Ligne 1 : | ||
− | = | + | =Parameters= |
− | + | Operational Parameters are parameters used to customize Routing Strategies. In Operational Parameter Management, the Service Provider defines Parameters and groups them into Parameter Group Templates. Tenants to whom the Parameter Group Templates are subsequently deployed customize the values of the Parameters, which are then read by a Routing Strategy and incorporated into the call flow. | |
− | |||
<tabber> | <tabber> | ||
− | + | Viewing Parameters= | |
− | + | This screen displays a list of all defined Parameters for which you have the required role privileges to view. To refresh the list at any time, click '''Refresh'''. Click a Parameter in the list. Its properties, including its type, is displayed to the right of the list. | |
− | + | You can filter the contents of this list in several ways: | |
− | * | + | *Type the name or partial name of the Parameter, Key, Type, or Tenant in the Quick Filter field. |
− | * | + | *Click the '''Tenant Filter''' button (the icon with the circle and horizontal bar) to open the Tenant filter panel. In this panel, click the checkbox(es) beside the tenants that you want to select. Use the Quick Filter field in this panel to filter the tenant list. |
− | * | + | *You can sort the Parameter in the list by clicking on a column head. Clicking a column head a second time reverses the sort order. |
|-| | |-| | ||
− | + | Properties= | |
{| | {| | ||
− | |+ <b> | + | |+ <b>Properties of Parameters</b> |
|- | |- | ||
− | ! | + | ! Property |
! Description | ! Description | ||
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Display Name |
− | | | + | | The name of the Parameter. It must be unique in the system. |
|- <!-- line 2 --> | |- <!-- line 2 --> | ||
− | | | + | | Key Name |
− | | | + | | The name of the Parameter as it would be entered in the Annex/Options tab of the Transaction object in Genesys Administrator. If this field is left blank, the name that is displayed under Display Name is used. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
| Type | | Type | ||
− | | | + | | The Parameter. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | Type | + | | Object Type |
− | | | + | | This field appears only for Parameters of Type Configuration Object, and specifies the type of configuration object. Optionally, when Configuration Object is selected, you can check the checkbox named '''Multiple Types''' to select multiple configuration objects to add to this Parameter. If the checkbox named '''Global''' is checked, a separate panel will open to allow you to select which tenants will receive the Parameter. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | Type | + | | DN Type |
− | | | + | | This field appears only for Parameters of Type Configuration Object and Object Type DN, and specifies the type of DN. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Custom List<br> |
− | + | Custom Value | |
− | | | + | | These properties apply only to Parameters of type Custom List and specify the members of the Custom List. Define the list, as follows: |
− | * | + | *To add an item to the list, enter it in the Custom Value edit box, and click Add. |
− | * | + | *To modify an item in the list, select the value, make the change, and click OK. |
− | {{NoteFormat| | + | {{NoteFormat|If you want the display value of an item in the Custom List to be different from the actual value stored in the transaction object, enter that information in the Key field.}} |
− | * | + | *To remove an item from the list, select it, and click Delete. |
− | * | + | *To reorder the items in the list, select an item in the list and use the Up and Down arrow buttons to move it up or down in the list. |
− | * | + | *For integers, dates, and times, you can define minimum and/or maximum values (limits). |
|- | |- | ||
− | | | + | | Mandatory |
− | | | + | | Specifies whether the Parameter is mandatory or optional. If checked, a value must be entered for this Parameter before it is saved. If not checked, the Parameter is considered optional and can be saved without a value. This property can be modified later (for example, to change a mandatory Parameter to an optional Parameter). |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
| Global | | Global | ||
− | | | + | | If checked, this Parameter is unique in the entire system and is shared across all tenants. Its actual value must be defined at the time of creation, and can be changed only by the Service Provider. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Value |
− | | | + | | If this Parameter is Global, this is the actual value of the Parameter and cannot be changed. A default value can be set that is not propagated to deployed Parameter Group instances. Providing of a default value is optional. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Help Text |
− | | | + | | Optional text describing the Parameter or providing additional information. |
|- | |- | ||
|} | |} | ||
|-| | |-| | ||
Types= | Types= | ||
− | + | The Parameter type appears in the Type field of the properties of a Parameter. | |
{| | {| | ||
|- | |- | ||
Ligne 65 : | Ligne 64 : | ||
! Description | ! Description | ||
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Audio Resource |
− | | | + | | The ARID of an Audio Resource. |
|- <!-- line 2 --> | |- <!-- line 2 --> | ||
− | | | + | | Boolean |
− | | | + | | True or false only. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Configuration Object |
− | | | + | | The type of a configuration object, which is specified in the Object Type field of the Parameter's properties. Optionally, when Configuration Object is selected, you can check the checkbox named '''Multiple Types''' to select multiple configuration objects to add to this Parameter. If the checkbox named '''Global''' is checked, a separate panel will open to allow you to select which tenants will receive the Parameter. The following types are supported: |
− | * | + | * Agent Group |
* DN | * DN | ||
− | * | + | * Person (more often referred to as User) |
− | * | + | * Place |
− | * | + | * Place Group |
− | * | + | * Skill |
* Stat Server | * Stat Server | ||
* Transaction | * Transaction | ||
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Custom List |
− | | | + | | Valid values are limited to the values that are specified in a user-defined list, specified in the Custom List/Custom Value field of the properties of the Parameter. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
| Date | | Date | ||
− | | | + | | A date value, in the format yyyy-mm-dd. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Integer |
− | | 0 ( | + | | A 0 (zero), negative, or positive number with no decimal value. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Personality |
− | | | + | | The name of a Personality, given by the Personality Identifier value that is specified in the list of Personalities. |
|- | |- | ||
− | | [[Parameters#Schedule_Parameter| | + | | [[Parameters#Schedule_Parameter|Schedule]] |
− | | | + | | Enables users to configure date and time ranges. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | String |
− | | | + | | A string of characters, both alphanumeric and symbols. |
|- <!-- Line 1 --> | |- <!-- Line 1 --> | ||
− | | | + | | Time |
− | | | + | | A time value, in the format hh:mm. |
|- | |- | ||
|} | |} | ||
− | + | ===Schedule Parameter=== | |
− | === | + | <toggledisplay linkstyle font-size:larger showtext="[+] Click to show section" hidetext="[-] Click to hide section"> |
− | <toggledisplay linkstyle font-size:larger showtext="[+] | ||
− | + | The Schedule Parameter enables users to specify a series of date and time ranges for Parameter Groups. | |
− | + | For example, the Schedule Parameter can specify opening and closing hours for each Tenant. | |
{{Procedure | {{Procedure | ||
Ligne 118 : | Ligne 116 : | ||
|Steps= | |Steps= | ||
<ol> | <ol> | ||
− | <li> | + | <li>On the '''Parameter List''' panel, click '''+'''.</li> |
− | <li> | + | <li>On the '''+''' panel that is displayed to the right of the '''Parameter List''' panel, define the properties of the new Parameter.</li> |
− | <li> | + | <li>In the '''Type''' field, select '''Schedule'''. A new section called '''Schedule''' appears below the '''Type''' field.</li> |
− | <li> | + | <li>In the '''Schedule''' section, click '''Add'''.</li> |
− | <li> | + | <li>In the '''Date''' panel that appears to the right, select the '''Schedule''' type. You can select '''Date''', to select a specific date, or you can select '''Day of Week''', to select a day of the week.</li> |
− | + | If you select '''Date''': | |
<ol type="a"> | <ol type="a"> | ||
− | <li> | + | <li>You must select the '''Year, Month, Day, and Time Zone''' (optional) to apply the Schedule Parameter. If you do not select a '''Time Zone''', the system's local time zone will be used.</li> |
− | <li> | + | <li>The '''Time Ranges''' field is optional. This field graphically represents the time range for the Schedule Parameter, based on a 24-hour clock. If the '''Time Ranges''' field is empty, the Schedule Parameter will apply to the entire day. To specify a time range: |
<ol type="i"> | <ol type="i"> | ||
− | <li> | + | <li>Move your mouse cursor to the time for which you want this Schedule Parameter to begin.</li> |
− | <li> | + | <li>Click and drag the mouse cursor to the end time for this Schedule Parameter. A box will appear to visually display the times for which this Schedule Parameter will apply.</li> |
− | <li> | + | <li>Click the '''Save''' button.</li> |
</ol></li> | </ol></li> | ||
</ol> | </ol> | ||
− | + | If you select '''Day of Week''': | |
<ol type="a"> | <ol type="a"> | ||
− | <li> | + | <li>You must select the '''Day of Week''' and '''Time Zone''' (optional) to apply the Schedule Parameter. If you do not select a '''Time Zone''', the system's local time zone will be used.</li> |
− | <li> | + | <li>The '''Time Ranges''' field is optional. This field graphically represents the time range for the Schedule Parameter, based on a 24-hour clock. If the '''Time Ranges''' field is empty, the Schedule Parameter will apply to the entire day. To specify a time range: |
<ol type="i"> | <ol type="i"> | ||
− | <li> | + | <li> Move your mouse cursor to the time for which you want this Schedule Parameter to begin.</li> |
− | <li> | + | <li>Click and drag the mouse cursor to the end time for this Schedule Parameter. A box will appear to visually display the times for which this Schedule Parameter will apply.</li> |
− | <li> | + | <li>Click '''Save'''.</li> |
</ol></li> | </ol></li> | ||
</ol> | </ol> | ||
− | <li> | + | <li>In the '''+''' panel, do one of the following: |
<ul> | <ul> | ||
− | <li> | + | <li>To save the new Parameter, click '''Save'''.</li> |
− | <li> | + | <li>To cancel the new Parameter and not save it in the database, click '''Cancel'''.</li> |
</ul> | </ul> | ||
</li> | </li> | ||
Ligne 154 : | Ligne 152 : | ||
</toggledisplay> | </toggledisplay> | ||
|-| | |-| | ||
− | + | Working with Parameters= | |
− | + | You can perform the following tasks in this screen: | |
− | * | + | *Define new Parameters |
− | * | + | *Modify Parameters |
− | * | + | *Delete Parameters |
− | + | ===Defining Parameters=== | |
− | === | + | Normally, the Service Provider defines new Parameters. Tenant administrators can also define their own, but these can be added only to Parameter Group Templates in the same tenant. |
− | |||
− | <toggledisplay linkstyle font-size:larger showtext="[+] | + | <toggledisplay linkstyle font-size:larger showtext="[+] Click to show procedure" hidetext="[-] Click to hide procedure"> |
{{Procedure | {{Procedure | ||
− | |Title= | + | |Title=Defining Parameters |
|Purpose= | |Purpose= | ||
|Prereqs= | |Prereqs= | ||
|Steps= | |Steps= | ||
<ol> | <ol> | ||
− | <li> | + | <li>On the '''Parameter List''' panel, click '''+'''.</li> |
− | <li> | + | <li>On the '''+''' panel that is displayed to the right of the '''Parameter List''' panel, define the properties of the new Parameter.</li> |
− | <li> | + | <li>Do one of the following: |
− | <ol type="a"><li> | + | <ol type="a"><li>To save the new Parameter, click '''Save'''.</li> |
− | <li> | + | <li>To cancel the new Parameter and not save it in the database, click '''Cancel'''.</li> |
</ol></li> | </ol></li> | ||
</ol> | </ol> | ||
Ligne 183 : | Ligne 180 : | ||
</toggledisplay> | </toggledisplay> | ||
− | + | ===Modifying Parameters=== | |
− | === | + | <toggledisplay linkstyle font-size:larger showtext="[+] Click to show procedure" hidetext="[-] Click to hide procedure"> |
− | <toggledisplay linkstyle font-size:larger showtext="[+] | ||
{{Procedure | {{Procedure | ||
− | |Title= | + | |Title=Modifying Parameters |
|Purpose= | |Purpose= | ||
|Prereqs= | |Prereqs= | ||
|Steps= | |Steps= | ||
− | {{NoteFormat| | + | {{NoteFormat|Follow the instructions in this topic to modify any property of a Parameter except '''Value'''. To set or change the actual value of a Parameter in a Parameter Group, see "Setting and Modifying Values in Parameter Groups" in the Procedures tab of the [[ParameterGroups|Parameter Groups]] page.}} |
− | + | When you modify a Parameter, the changes are propagated to any Parameter Group Templates that contain the modified parameter. However, the changes are not propagated to any deployed Parameter Groups. | |
− | # | + | #On the '''Parameter List''' panel, select the Parameter that you want to modify. |
− | # | + | #On the <Parameter name> panel that is displayed to the right of the '''Parameter List''' panel, modify the properties of the Parameter, as required. |
− | # | + | #Click '''Save''' to save your changes, or click '''Cancel''' to leave the Parameter unchanged. |
|NextSteps= | |NextSteps= | ||
}} | }} | ||
</toggledisplay> | </toggledisplay> | ||
− | + | ===Deleting Parameters=== | |
− | === | + | You can delete only Parameters that are not assigned to Parameter Group Templates. |
− | |||
− | <toggledisplay linkstyle font-size:larger showtext="[+] | + | <toggledisplay linkstyle font-size:larger showtext="[+] Click to show procedure" hidetext="[-] Click to hide procedure"> |
{{Procedure | {{Procedure | ||
− | |Title= | + | |Title=Deleting Parameters |
|Purpose= | |Purpose= | ||
|Prereqs= | |Prereqs= | ||
|Steps= | |Steps= | ||
<ol> | <ol> | ||
− | <li> | + | <li>On the '''Parameter List''' panel, select the Parameter that you want to delete.</li> |
− | <li> | + | <li>On the <Parameter name> panel that is displayed to the right of the '''Parameter List''' panel, click '''Delete'''.</li> |
− | <li> | + | <li>In the Confirm Deletion dialog box, do one of the following: |
<ol type="a"> | <ol type="a"> | ||
− | <li> | + | <li>To remove the Parameter from the database, click '''OK'''.</li> |
− | <li> | + | <li>To keep the Parameter and not remove it from the database, click '''Cancel'''.</li> |
</ol></li> | </ol></li> | ||
</ol> | </ol> |
Version du mai 10, 2019 à 17:10
Parameters
Operational Parameters are parameters used to customize Routing Strategies. In Operational Parameter Management, the Service Provider defines Parameters and groups them into Parameter Group Templates. Tenants to whom the Parameter Group Templates are subsequently deployed customize the values of the Parameters, which are then read by a Routing Strategy and incorporated into the call flow.
This screen displays a list of all defined Parameters for which you have the required role privileges to view. To refresh the list at any time, click Refresh. Click a Parameter in the list. Its properties, including its type, is displayed to the right of the list. You can filter the contents of this list in several ways:
- Type the name or partial name of the Parameter, Key, Type, or Tenant in the Quick Filter field.
- Click the Tenant Filter button (the icon with the circle and horizontal bar) to open the Tenant filter panel. In this panel, click the checkbox(es) beside the tenants that you want to select. Use the Quick Filter field in this panel to filter the tenant list.
- You can sort the Parameter in the list by clicking on a column head. Clicking a column head a second time reverses the sort order.
Property | Description |
---|---|
Display Name | The name of the Parameter. It must be unique in the system. |
Key Name | The name of the Parameter as it would be entered in the Annex/Options tab of the Transaction object in Genesys Administrator. If this field is left blank, the name that is displayed under Display Name is used. |
Type | The Parameter. |
Object Type | This field appears only for Parameters of Type Configuration Object, and specifies the type of configuration object. Optionally, when Configuration Object is selected, you can check the checkbox named Multiple Types to select multiple configuration objects to add to this Parameter. If the checkbox named Global is checked, a separate panel will open to allow you to select which tenants will receive the Parameter. |
DN Type | This field appears only for Parameters of Type Configuration Object and Object Type DN, and specifies the type of DN. |
Custom List Custom Value |
These properties apply only to Parameters of type Custom List and specify the members of the Custom List. Define the list, as follows:
Important If you want the display value of an item in the Custom List to be different from the actual value stored in the transaction object, enter that information in the Key field.
|
Mandatory | Specifies whether the Parameter is mandatory or optional. If checked, a value must be entered for this Parameter before it is saved. If not checked, the Parameter is considered optional and can be saved without a value. This property can be modified later (for example, to change a mandatory Parameter to an optional Parameter). |
Global | If checked, this Parameter is unique in the entire system and is shared across all tenants. Its actual value must be defined at the time of creation, and can be changed only by the Service Provider. |
Value | If this Parameter is Global, this is the actual value of the Parameter and cannot be changed. A default value can be set that is not propagated to deployed Parameter Group instances. Providing of a default value is optional. |
Help Text | Optional text describing the Parameter or providing additional information. |
The Parameter type appears in the Type field of the properties of a Parameter.
Type | Description |
---|---|
Audio Resource | The ARID of an Audio Resource. |
Boolean | True or false only. |
Configuration Object | The type of a configuration object, which is specified in the Object Type field of the Parameter's properties. Optionally, when Configuration Object is selected, you can check the checkbox named Multiple Types to select multiple configuration objects to add to this Parameter. If the checkbox named Global is checked, a separate panel will open to allow you to select which tenants will receive the Parameter. The following types are supported:
|
Custom List | Valid values are limited to the values that are specified in a user-defined list, specified in the Custom List/Custom Value field of the properties of the Parameter. |
Date | A date value, in the format yyyy-mm-dd. |
Integer | A 0 (zero), negative, or positive number with no decimal value. |
Personality | The name of a Personality, given by the Personality Identifier value that is specified in the list of Personalities. |
Schedule | Enables users to configure date and time ranges. |
String | A string of characters, both alphanumeric and symbols. |
Time | A time value, in the format hh:mm. |
Schedule Parameter
[+] Click to show sectionYou can perform the following tasks in this screen:
- Define new Parameters
- Modify Parameters
- Delete Parameters
Defining Parameters
Normally, the Service Provider defines new Parameters. Tenant administrators can also define their own, but these can be added only to Parameter Group Templates in the same tenant.
[+] Click to show procedureModifying Parameters
[+] Click to show procedureDeleting Parameters
You can delete only Parameters that are not assigned to Parameter Group Templates.
[+] Click to show procedure