Jump to: navigation, search

Contact options

[Modified: 8.5.101.14, 8.5.104.15, 8.5.105.12, 8.5.110.13, 8.5.112.08, 8.5.117.18, 8.5.126.07]

Contents

contact.all-interactions-default-time-filter-main

[Added: 8.5.104.15]

  • Default Value: 1W
  • Valid Values: A value from the following list: All, 1M, 1W, 1D
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies which Time Filter is selected by default in the Interaction Search view.
    • All: All interactions from Main UCS Data Base.
    • 1M: Interactions from Main UCS Data Base that were created less than 1 month ago.
    • 1W: interactions from Main UCS Data Base that were created less than 1 week ago.
    • 1D: interactions from Main UCS Data Base that were created less than 1 day ago.

contact.all-interactions-displayed-columns

[Added: 8.5.104.15]

  • Default Value: ""
  • Valid Values: A comma-separated value list of interaction attribute names from the following list: Subject, Status, ContactId, StartDate, OwnerId, EndDate, and custom attributes.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of interaction attributes that are displayed in the result list of the Interaction Search view, for example: Status, Subject, StartDate, EndDate

contact.all-interactions-displayed-columns-treeview

[Added: 8.5.126.07]

  • Default Value: Status,Subject,StartDate
  • Valid Values: A comma-separated value list of interaction attribute names.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of interaction attributes that are displayed in the tree view of the Interaction Search view, for example: Status, Subject, StartDate, EndDate

contact.all-interactions-quick-search-attributes

[Added: 8.5.104.15]

  • Default Value: ""
  • Valid Values: A comma-separated value list of valid interaction attribute names.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the interaction attributes that are used to search interactions in the quick search mode of the Interaction Search view.

contact.available-directory-page-sizes

  • Default Value: 5,10,25,50
  • Valid Values: A comma-separated list of numbers that define the number of rows per result page from which the agent can make selections.
  • Changes take effect: When the application is started or restarted.
  • Description: The possible values for number of rows per page in the Contact Directory search result view.

contact.cache-timeout-delay

  • Default Value: 600
  • Valid Values: An integer from 1 through 3600.
  • Changes take effect: When the application is started or restarted.
  • Description: The delay, in seconds, before the cache of the result of a Universal Contact Server request is cleared.

contact.date-search-types

[Modified: 8.5.104.15]

  • Default Value: On,OnOrAfter,Before,Between
  • Valid Values: On, OnOrAfter, Before, Between
  • Changes take effect: When the application is started or restarted.
  • Description: The list of search types that are available for the agent to use to search the contact database by date.

contact.default-directory-page-size

  • Default Value: 10
  • Valid Values: An integer from 1 through 50.
  • Changes take effect: When the application is started or restarted.
  • Description: The default value for the number of rows per page in the Contact Directory search result view. The value must be defined in the contact.available-directory-page-sizes option.

contact.directory-advanced-default

[Modified: 8.5.112.08]

  • Default Value: LastName,PhoneNumber
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to searchable contact field names.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of contact attributes that are presented by default in the advanced search form of the Contact Directory view. Once an agent has personalized the list of advanced search attributes the personalized list of attributes takes precedence over this option in the subsequent sessions (8.5.112.08 and higher).

contact.directory-auto-append-star-to-search

[Added: 8.5.117.18]

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: At the next search.
  • Description: Specifies whether an asterisk ("*") character is automatically appended to a Contact Directory keyword search to force a starts with search. When searching in languages, such as Chinese or Japanese, set this option to false and set up a CJK Analyzer in Universal Contact Server.

contact.directory-default-mode

  • Default Value: ListView
  • Valid Values: A value from the following list: ListView, GridView
  • Changes take effect: Immediately.
  • Description: Specifies which view of the Contact Directory is displayed by default. ListView provides quicker search performance and tokenized search items, but no sort on the result. GridView results are sortable result, but the search is less powerful, and the search items are non-tokenized.

contact.directory-displayed-columns

  • Default Value: LastName,FirstName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names -- for example: LastName,FirstName,PhoneNumber,EmailAddress.
  • Changes take effect: When the application is started or restarted.
  • Description: The list of contact fields that are displayed when the results of a contact search are rendered.

contact.directory-enabled-modes

[Added: 8.5.105.12]

  • Default Value: ListView,GridView
  • Valid Values: A comma-separated value list of views from the following list: ListView, GridView.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies which view(s) of the Contact Directory can be selected by an agent. Genesys recommends that the value is set to ListView in environments with a large number of contacts and, in particular, where contact segmentation is used.
    • ListView: Allows for faster search performance and tokenized search items, but the results are not sorted. This view can be enabled only if the Contact index is activated in UCS.
    • GridView: The results are sortable, but the search is less powerful, and the search items are non-tokenized.

contact.directory-permissions.<ContactAttributeName>

  • Default Value: ""
  • Valid Values: In a key, a valid searchable contact attribute name. In a value, a comma-separated list of strings that are applicable to the specified contact attribute.
  • Changes take effect: At the next contact search.
  • Description: This option can be used as a template to specify a contact attribute name (in a key) and the associated values (in a value) that is used to restrict the access of specific agents to the Contact Directory view. Modifies the search logic whenever the Application, Tenant, Agent Group, or Agent makes a contact search request based on a set of attribute values that are configured for contacts in your Universal Contact Server database. Refer to the Restricted Access section for information about how to configure this option.

contact.directory-search-attributes

  • Default Value: LastName,FirstName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to searchable contact field names.
  • Changes take effect: When the application is started or restarted.
  • Description: The list of contact fields that can be used as search parameters.

contact.directory-search-types

[Modified: 8.5.110.13]

  • Default Value: begins-with,is
  • Valid Values: A comma-separated list of values from the following: contains, begins-with, is
  • Changes take effect: When the application is started or restarted.
  • Description: The list of search types that are available for the agent to use to search the contact database in Advanced Search mode. Specifying the value contains might have a performance impact on Universal Contact Server.

contact.displayed-attributes

  • Default Value: Title,FirstName,LastName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.
  • Changes take effect: When the application is started or restarted.
  • Description: The list of contact fields that are displayed when a Contact record is rendered.

contact.editable-attributes

[Added: 8.5.101.14]

  • Default Value: &All$
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names: either $All$ or one or more of the values that are defined by the contact.displayed-attributes option. If this option is left blank (""), no fields are editable.
  • Changes take effect: At the next contact selection.
  • Description: The list of contact fields that can be edited by agents.

contact.history-auto-append-star-to-search

[Added: 8.5.117.18]

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: At the next search.
  • Description: Specifies whether an asterisk ("*") character is automatically appended to a History keyword search to force a starts with search. When searching in languages, such as Chinese or Japanese, set this option to false and set up a CJK Analyzer in Universal Contact Server.

contact.history.filters-<custom attribute>

[Modified: 8.5.104.15]

  • Default Value: ""
  • Valid Values: In the key, a valid searchable interaction attribute name. In the value, a comma-separated list of strings applicable to the specified interaction attribute. Use the $All$ and $Other$ keywords to enable filtering on "all" or "other" values for this attribute.
  • Changes take effect: At the next contact search.
  • Description: This option can be used as a template to specify an interaction attribute name (in a key) and the associated values (in a value) that is used to automatically filter any list of interactions displayed in Contact History, My History, and Interaction Search views. Refer to Managing Contacts for more information. In a key, a valid searchable interaction attribute name. In the value, a comma-separated list of strings applicable to the specified interaction attribute. Use the $All$ and $Other$ keywords to enable filtering on "all" or "other" values for this attribute.

contact.history.highlight-current-interaction

[Added: 8.5.117.18]

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: At the next interaction.
  • Description: Specifies whether the current interaction is highlighted in the interactions list or tree of the Contact History view.

contact.history.media-filters

[Modified: 8.5.104.15, Social Media Plugin 9.0.002.05]

  • Default Value: voice,email,chat,sms
  • Valid Values: A comma-separated value of valid media type names including: voice,email,chat,sms,facebook,facebooksession,facebookprivatemessage,twitter,twitterdirect
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of media types that can be used to filter the Contact History, My History, and the result list of Interaction Search.

contact.history-advanced-default

[Modified: 8.5.104.15, 8.5.112.08]

  • Default Value: Status,StartDate
  • Valid Values: A comma-separated value list of interaction attributes.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of interaction attributes that are presented by default in the advanced search form of the Contact History, My History and Interaction Search views. Once an agent has personalized the list of advanced search attributes, the personalized list of attributes takes precedence over this option in subsequent sessions (8.5.112.08 and higher).

contact.history-custom-attribute-values.<attribute-name>

[Added: 8.5.104.15]

  • Default Value: ""
  • Valid Values: A comma-separated value list of interaction attribute values.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies a list of attribute value names that are used to create a drop-down menu that contains valid values of custom interaction attributes in the Advanced Search mode of Contact History, My History, and Interaction Search views. Use this option as a template, modifying its name by replacing <attribute-name> by the name of an interaction attribute configured to be displayed in the Advanced Search view. You can define a display name that can be localized to each of the possible values of this interaction attribute by creating the key Contacts.ContactDirectoryView.CustomAttribute.<custom-attribute-name>.<attribute-value-name> in any dictionary file of the corresponding language and assigning it a "Content" attribute that contains the display name.

contact.history-default-time-filter-main

  • Default Value: 1M
  • Valid Values: A value from the following list: All, 1M, 1W, 1D.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies which Time Filter is selected by default in the Contact History view when an agent accesses the main history data source.
    • All: all interactions from Main UCS Data Base.
    • 1M: interactions from Main UCS Data Base that were created less than 1 month ago.
    • 1W: interactions from Main UCS Data Base that were created less than 1 week ago.
    • 1D: interactions from Main UCS Data Base that were created less than 1 day ago.

contact.history-displayed-columns

  • Default Value: Status,Subject,StartDate,EndDate,OwnerId
  • Valid Values: A comma-separated value list of contact history items to display in the Interaction Search view -- for example: Status,Subject,StartDate,EndDate,OwnerId.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of contact history items that are displayed in the Interaction Search view.

contact.history-displayed-columns-treeview

  • Default Value: Subject,Status,StartDate
  • Valid Values: A comma-separated value list of contact history items to display in the threaded view of interactions, for example: Status,Subject,StartDate,EndDate,OwnerId
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of contact history items that are displayed in the threaded view of interactions.

contact.history-quick-search-attributes

[Added: 8.5.104.15]

  • Default Value: Subject
  • Valid Values: A comma-separated value list of valid interaction attribute names.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the interaction attributes that are used to search interactions in the quick search mode of the Contact History view.

contact.history-search-attributes

[Modified: 8.5.104.15]

  • Default Value: Status,StartDate,EndDate,Subject
  • Valid Values: A comma-separated value list of Interaction attributes.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of interaction attributes that an agent can use in the Advanced Search mode of Contact History, My History and Interaction Search views.

contact.history-search-attribute-group.<group-name>

[Added: 8.5.104.15]

  • Default Value: ""
  • Valid Values: A comma-separated value list of interaction attributes.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies a group of interaction search attributes. Use this option as a template, modifying the name by replacing the <group-name> by the name of a group to be displayed in the Advanced Search mode of Contact History, My History, and Interaction Search views. You can define a display name that can be localized to this group by creating the key Contacts.InteractionSearchView.Group.<group-name> in any dictionary file of the corresponding language and assigning it a 'String' attribute that contains the display name.

contact.last-called-agent.enable

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: When this option is set to true, the LastCalledAgent_EmployeeID of the contact is set to employee ID of the agent when an interaction is presented to the agent. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

This option is taken into account only when the option contact.last-called-agent.<media-type>.enable is not defined for the applicable media type.

contact.last-called-agent.<media-type>.enable

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: When this option is set to true, the LastCalledAgent_EmployeeID of the contact is set to the employee ID of the agent when an interaction of the given media type is presented to the agent. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

This option overrides the contact.last-called-agent.enable option. Use the voice-campaign media-type to define the look-up behavior for outbound campaign interactions.

contact.lookup.auto-assign-mode

[Added: 8.5.117.18]

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: At the next interaction.
  • Description: Specifies contact lookup behavior if the value of contact.lookup.enable is set to true.
    • true: If there is only one contact in the UCS database, that contact is assigned automatically. If there are two or more contact in the UCS database, the first one is assigned to the interaction automatically.
    • false: If there is only one contact in the UCS database, that contact is assigned automatically. If there are two or more contacts, these are displayed in the Contact view of the interaction and the agent must either select one, search for a different contact, or create a new contact.
      This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
Depends on contact.lookup.enable.

contact.lookup.enable

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: Activates the Workspace features that rely on the Universal Contact Server (UCS) for contact lookup when an interaction is presented to the Agent.
    This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
    Note: This option is overridden by the attached data IdentifyCreateContact and the option contact.lookup.<media-type>.enable.

contact.lookup.enable-create-contact

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: When option contact.lookup.enable is set to true, this option specifies that the Universal Contact Server (UCS) can create a contact if the initial search cannot find any existing contact.
    This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
    Note: This option is overridden by the attached data IdentifyCreateContact and the contact.lookup.<media-type>.enable-create-contact option.

contact.lookup.<media-type>.auto-assign-mode

[Added: 8.5.117.18]

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: At the next interaction.
  • Description: Specifies contact lookup behavior if Contact lookup is enabled for the specified media type.
    • true: If there is only one contact in the UCS database, that contact is assigned automatically. If there are two or more contact in the UCS database, the first one is assigned to the interaction automatically.
    • false: If there is only one contact in the UCS database, that contact is assigned automatically. If there are two or more contacts, these are displayed in the Contact view of the interaction and the agent must either select one, search for a different contact, or create a new contact.
      This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
Depends on contact.lookup.<media-type>.enable.

contact.lookup.<media-type>.enable

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: Activates the Workspace features that rely on Universal Contact Server (UCS) for contact lookup when an interaction of the given media type is presented to the agent.
    This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
    Note: This option overwrites the contact.lookup.enable option. It is not taken into account when the attached data 'IdentifyCreateContact' is set in the interaction. Use the voice-campaign media-type to define the lookup behavior in the context of outbound campaign interactions.

contact.lookup.<media-type>.enable-create-contact

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: When contact lookup is enabled in the context of the current interaction, this option specifies that the Universal Contact Server (UCS) can create a contact if the initial search cannot find any existing contact.
    This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
    Note: This option overwrites the contact.lookup.enable-create-contact option. It is not taken into account when the attached data 'IdentifyCreateContact' is set in the interaction. Use the voice-campaign media-type to define the lookup and create behavior in the context of outbound campaign interactions.

contact.lookup.voice.use-dialed-phone-number

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: At the next interaction.
  • Description: When the value of this option is set to true, Workspace executes the UCS Contact Look-up request using the normalized value of the number that was manually dialed by the agent.
    Note: The normalized phone number is the string that results from the execution of the logic that is configured by the expression.phone-number.supported-characters option and before the dial-plan-rule-<name> is applied. When the value is set to false, Workspace applies the Contact Look-up with the phone number that is returned by the T-Server in the EventDialing, which can contain the string transformed by the execution of the dialing rules.

contact.mandatory-attributes

  • Default Value: FirstName,LastName
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.
  • Changes take effect: When the application is started or restarted. For example: Title,FirstName,LastName,PhoneNumber,EmailAddress
  • Description: The list of contact fields that must be filled to be able to save a contact.

contact.metrics.enable-interactions-in-progress

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Activates the Workspace features that display the number of eServices interactions that are in progress in the current contact history.

contact.metrics.time-frame-customer-notification

  • Default Value: 1
  • Valid Values: 0 or any positive integer value less than or equal to 1000.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the search timeframe, in days, from which existing open and closed interactions are to be reported. If the value is set to 0, the feature is disabled. If the value is set to a number that is greater than 0, the feature that displays in the Interaction Search view the number of interactions that were sent or received by the contact for the specified number of days is activated.

contact.multiple-value-attributes

  • Default Value: EmailAddress,PhoneNumber
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.
  • Changes take effect: When the application is started or restarted.
  • Description: A list of contact attributes that can support multiple values.

contact.myhistory-default-time-filter-main

  • Default Value: 1W
  • Valid Values: A value from the following list: All, 1M, 1W, 1D.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies which Time Filter is selected by default in the My History view when an agent accesses the main history data source.
    • All: all interactions from Main UCS Data Base.
    • 1M: interactions from Main UCS Data Base that were created less than 1 month ago.
    • 1W: interactions from Main UCS Data Base that were created less than 1 week ago.
    • 1D: interactions from Main UCS Data Base that were created less than 1 day ago.

contact.myhistory-displayed-columns

[Added: 8.5.104.15]

  • Default Value: Status,Subject,StartDate,EndDate
  • Valid Values: A comma-separated value list of interaction attributes.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of interaction attributes that are displayed in My History view, for example: Status, Subject, StartDate, EndDate.

contact.myhistory-displayed-columns-treeview

[Modified: 8.5.110.13]

  • Default Value: Subject,Status,StartDate
  • Valid Values: A comma-separated value list of contact history items to be displayed in the threaded view of interactions in the My History view, for example: Status, Subject, StartDate, and EndDate.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of contact history items that are displayed in the threaded mode of the My History view.

contact.myhistory-quick-search-attributes

[Added: 8.5.104.15]

  • Default Value: Subject
  • Valid Values: A comma-separated value list of valid interaction attribute names.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the interaction attributes that are used to search interactions in the quick search mode of the My History view.

contact.threading-ucs-interaction.enable

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: Activates the Workspace feature that associates interactions that are submitted during multi-channel contact communication, such as smssession, in threads in Universal Contact Server history.

contact.timeout-delay

  • Default Value: 60
  • Valid Values: An integer from 1 through 3600.
  • Changes take effect: When the application is started or restarted.
  • Description: The delay, in seconds, before a UCS request times out.

contact.ucs-interaction.<media-type>.enable-create

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: Activates the Workspace feature that generates the interaction history in Universal Contact Server (UCS) based on the inbound and outbound interactions of type <media-type> that are handled by Workspace. Enable agents to create interactions of type <media-type>. The option is forced to the value false for the media-types email, chat, and smssession, as Media Server is responsible for submitting those interactions in UCS. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

contact.ucs-interaction.<media-type>.enable-lookup

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: Immediately.
  • Description: Activates the Workspace feature that looks up the history of existing interactions of the given <media-type> in Universal Contact Server (UCS) to update their content and status according to live interaction lifecycle.
    This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
    Note: For the media type email, this option is forced to the value true.

contact.ucs-interaction.<media-type>.use-server-date

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies for the specified <media-type> whether Workspace sets the start and end dates of interactions by using the time of the local agent workstation, or uses the date and time specified by Universal Contact Server (UCS) when it creates or updates an interaction record in UCS. Use this option as a template and modify its name by replacing the <media-type> by an actual media type that is defined in Management Framework.
    Note: Depending on which UCS version you are using, setting this option to true might generate an additional request to UCS when Mark Done is set.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on October 26, 2018, at 06:33.