Jump to: navigation, search

contact.phone-number-validation.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.84

In environments using UCSX server, this option specifies whether phone numbers are validated on the client side when contact records are created or updated.

views.CaseSideRegion.activate-order

Section: interaction-workspace
Default Value: AgentAssistSuggestionsView,ContactView,SRLView,RelatedView,CoBrowseView
Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified by the section names in the option 'interaction.web-content'): ContactView,ExtensionSectionName,SRLView,RelatedView,CoBrowseView. CoBrowseView is not supported for on-premises deployments.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.94, 9.0.000.93, 9.0.000.68

Specifies, in order of precedence, the view selected by default in the Case Side Region. (The default view is the first configured view, if visible; otherwise, it's the second configured view, if visible, and so on.) If this option is not configured, then the default setting is used. If you do not specify all the options, then the default order is used, except where an item order is specified.

views.CaseSideRegion.order

Section: interaction-workspace
Default Value: AgentAssistSuggestionsView,CoBrowseView,ContactView,SRLView,RelatedView
Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified by the section names in the option 'interaction.web-content'): ExtensionSectionName,CoBrowseView,ContactView,SRLView,RelatedView. CoBrowseView is not supported for on-premises deployments.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.94, 9.0.000.93, 9.0.000.68

Specifies the order (left to right, top to bottom) in which the views are displayed in the Case Side Region. If this option is not configured, then the default ordering is used. If you do not specify all the options, then the default setting is used for any item not specified.

interaction.related.disposition.key-name

Section: interaction-workspace
Default Value: $Default$
Valid Values: A valid key name or $Default$.
Changes Take Effect: Immediately
Introduced: 9.0.000.94

Specifies the key that is used to populate the attached data or a user event when a disposition code is submitted from the Related tab to the back-end system, such as T-Server, Interaction Server, or Contact Server. The value $Default$ specifies that the value of the interaction.disposition.key-name option is used.

interaction.related.disposition.value-business-attribute

Section: interaction-workspace
Default Value: $Default$
Valid Values: A valid Business Attribute name or $Default$.
Changes Take Effect: Immediately
Introduced: 9.0.000.94

Specifies the name of the Business Attribute that contains the Attribute Values that are used as an enumerated value for a disposition code displayed in the Related tab. The value $Default$ specifies that the value of the interaction.disposition.value-business-attribute option is used.

contact.related-interactions.custom-attributes

Section: interaction-workspace
Default Value: No default value
Valid Values: A comma-separated list of interaction custom attributes
Changes Take Effect: Immediately
Introduced: 9.0.000.90

Specifies the list of interaction custom attributes to be displayed as tags in the Related tab interaction cards. Only the first two attributes are displayed. If you specify more than two attributes, the others are included in the Sort by menu but not as tags in the cards.

contact.related-interactions.sort-by.attributes

Section: interaction-workspace
Default Value: $All$
Valid Values: A comma-separated list of predefined and custom attributes of an interaction. Example: StartDate,Status,Subject,OwnerId,TypeId,CustomAttr1. To include all predefined and custom attributes, use the value $All$ in this option.
Changes Take Effect: Immediately
Introduced: 9.0.000.90

Specifies the list of predefined and custom attributes by which the interactions in the Related tab may be sorted. In the Sort By menu, the attributes are displayed in the configured order. Custom attributes specified by this option must also be specified by the contact.related-interactions.custom-attribute.

contact.history-quick-search-attributes

Section: interaction-workspace
Default Value: Subject
Valid Values: A comma-separated value list of valid interaction attribute names, for example: Subject. Possible searchable attributes are: BccAddresses, CcAddresses, FromAddress, FromPersonal, Id, Mailbox, ReplyToAddress, StructuredText, Subject, Text, TheComment, ToAddresses
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74

Specifies the interaction attributes that are used to search interactions in the quick search mode of the Contact History view. These attributes should be text attributes. You can use custom interaction attributes. For more information, see 'Making an Attribute Searchable from the Desktop' in the PureEngage Digital Administrator's Guide.

contact.related-interactions.open.max-number

Section: interaction-workspace
Default Value: 10
Valid Values: An integer from 1 through 10.
Changes Take Effect: Immediately
Introduced: 9.0.000.90

Specifies the maximum number of related interactions that may be opened simultaneously by a single Open action.

privilege.contact.can-delete-related-interactions

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.94

Enables an agent to delete single and multiple related interactions from the Related tab in the interaction view

privilege.contact.can-mark-done-related-interactions

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.94

Enables an agent to use the Related tab in the interaction view to mark as Done single and multiple related interactions and apply the same disposition code to each.

privilege.contact.can-use-related-interactions

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.90

Enables an agent to access the Related tab in the Case Side View. The Related tab contains interactions in the same thread (conversations) as the current interaction. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.history-search-attributes

Section: interaction-workspace
Default Value: Status,StartDate,EndDate,Subject
Valid Values: A comma-separated value list of Interaction attributes.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of interaction attributes that an agent can use in Advanced Search mode of the Contact History, My History and Interaction Search views. You can also use custom interaction attributes.

contact.all-interactions-quick-search-attributes

Section: interaction-workspace
Default Value: Subject
Valid Values: A comma-separated value list of valid interaction attribute names, for example: Subject
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the interaction attributes that are used to search interactions in the Quick Search mode of the Interaction Search view.

contact.myhistory-quick-search-attributes

Section: interaction-workspace
Default Value: Subject
Valid Values: A comma-separated value list of valid interaction attribute names, for example: Subject. Possible searchable attributes are: BccAddresses, CcAddresses, FromAddress, FromPersonal, Id, Mailbox, ReplyToAddress, StructuredText, Subject, Text, TheComment, ToAddresses
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74

Specifies the interaction attributes that are used to search interactions in the quick search mode of the My History view. These attributes must be text attributes. You can use custom interaction attibutes. For more information, see 'Making an Attribute Searchable from the Desktop' in the PureEngage Digital Administrator's Guide.

contact.history-quick-search-attributes

Section: interaction-workspace
Default Value: Subject
Valid Values: A comma-separated value list of valid interaction attribute names, for example: Subject. Possible searchable attributes are: BccAddresses, CcAddresses, FromAddress, FromPersonal, Id, Mailbox, ReplyToAddress, StructuredText, Subject, Text, TheComment, ToAddresses
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74

Specifies the interaction attributes that are used to search interactions in the quick search mode of the Contact History view. These attributes should be text attributes. You can use custom interaction attributes. For more information, see 'Making an Attribute Searchable from the Desktop' in the PureEngage Digital Administrator's Guide.

contact.date-search-types

Section: interaction-workspace
Default Value: On,OnOrAfter,Before,Between
Valid Values: Select at least one from the list.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of search types that are available for the agent to use to search the contact database by date.

contact.history.media-filters

Section: interaction-workspace
Default Value: voice,email,chat,twitter,facebook,$OtherMedia$
Valid Values: A comma-separated value of valid media type names or $OtherMedia$.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65
Related Options: privilege.contact.can-filter-contact-history, privilege.contact.can-filter-my-history, privilege.contact.can-filter-all-interactions

Specifies the list of media types that can be used to filter the Contact History (depends on privilege.contact.can-filter-contact-history), My History (depends on privilege.contact.can-filter-my-history), and the result list of Interaction Search (depends on privilege.contact.can-filter-all-interactions). $OtherMedia$ allows to add the filter returning any media not listed in this option.

contact.all-interactions-displayed-columns

Section: interaction-workspace
Default Value: Status,Subject,StartDate,EndDate
Valid Values: A comma-separated value list of Contact History items to display in the interaction view MyHistory, for example: Status, Subject, StartDate, EndDate.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74

Specifies the list of interaction attributes that are displayed in the result list of the Interaction Search view.

contact.date-search-types

Section: interaction-workspace
Default Value: On,OnOrAfter,Before,Between
Valid Values: Select at least one from the list.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of search types that are available for the agent to use to search the contact database by date.

contact.history-search-attributes

Section: interaction-workspace
Default Value: Status,StartDate,EndDate,Subject
Valid Values: A comma-separated value list of Interaction attributes.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of interaction attributes that an agent can use in Advanced Search mode of the Contact History, My History and Interaction Search views. You can also use custom interaction attributes.

contact.history.quick-search.max-input-length

Section: interaction-workspace
Default Value: 10
Valid Values: An integer value from 1 through 20.
Changes Take Effect: Immediately
Introduced: 9.0.000.85

Specifies the maximum number of words that can be used to make a quick search of interaction in My History, Contact History and Interaction Search

contact.all-interactions-quick-search-attributes

Section: interaction-workspace
Default Value: Subject
Valid Values: A comma-separated value list of valid interaction attribute names, for example: Subject
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the interaction attributes that are used to search interactions in the Quick Search mode of the Interaction Search view.

privilege.contact.can-filter-all-interactions

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to filter interactions in the Interaction Search view.

privilege.contact.can-advanced-search-all-interactions

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to do advanced searches of all interactions.

privilege.contact.can-search-all-interactions

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to search among all interactions.

contact.lookup.<media-type>.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.enable

Specifies that 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 are activated. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.last-called-agent.<media-type>.enable

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.last-called-agent.enable

Specifies if the last called agent properties are set in the contact when an interaction of the corresponding media type is presented to the agent. 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.last-called-agent.enable

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.last-called-agent.<media-type>.enable

Specifies if the last called agent properties are set in the contact when an interaction is presented to the agent. This option is taken into account only when the contact.last-called-agent.<media-type>.enable option is not defined for the applicable media type.

privilege.voice-history.can-click-to-search

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.61

Enables an agent to use Click-to-search to open the Contact Directory by clicking a Contact name in the Details tab of the My History or Interaction Search views.

privilege.voice-history.can-click-to-dial

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.61

Enables an agent to use the Click-to-dial feature to dial a voice call from the Details tab of the history of a voice interaction in any History view.

contact.history.media-filters

Section: interaction-workspace
Default Value: voice,email,chat,twitter,facebook,$OtherMedia$
Valid Values: A comma-separated value of valid media type names or $OtherMedia$.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65
Related Options: privilege.contact.can-filter-contact-history, privilege.contact.can-filter-my-history, privilege.contact.can-filter-all-interactions

Specifies the list of media types that can be used to filter the Contact History (depends on privilege.contact.can-filter-contact-history), My History (depends on privilege.contact.can-filter-my-history), and the result list of Interaction Search (depends on privilege.contact.can-filter-all-interactions). $OtherMedia$ allows to add the filter returning any media not listed in this option.

contact.date-search-types

Section: interaction-workspace
Default Value: On,OnOrAfter,Before,Between
Valid Values: Select at least one from the list.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of search types that are available for the agent to use to search the contact database by date.

contact.history-search-attributes

Section: interaction-workspace
Default Value: Status,StartDate,EndDate,Subject
Valid Values: A comma-separated value list of Interaction attributes.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of interaction attributes that an agent can use in Advanced Search mode of the Contact History, My History and Interaction Search views. You can also use custom interaction attributes.

contact.history.quick-search.max-input-length

Section: interaction-workspace
Default Value: 10
Valid Values: An integer value from 1 through 20.
Changes Take Effect: Immediately
Introduced: 9.0.000.85

Specifies the maximum number of words that can be used to make a quick search of interaction in My History, Contact History and Interaction Search

contact.myhistory-quick-search-attributes

Section: interaction-workspace
Default Value: Subject
Valid Values: A comma-separated value list of valid interaction attribute names, for example: Subject. Possible searchable attributes are: BccAddresses, CcAddresses, FromAddress, FromPersonal, Id, Mailbox, ReplyToAddress, StructuredText, Subject, Text, TheComment, ToAddresses
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74

Specifies the interaction attributes that are used to search interactions in the quick search mode of the My History view. These attributes must be text attributes. You can use custom interaction attibutes. For more information, see 'Making an Attribute Searchable from the Desktop' in the PureEngage Digital Administrator's Guide.

contact.myhistory-displayed-columns

Section: interaction-workspace
Default Value: Status,Subject,StartDate,EndDate
Valid Values: A comma-separated value list of Contact History items to display in the interaction view MyHistory, for example: Status, Subject, StartDate, EndDate.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Contact History items that are displayed in the My History view.

contact.myhistory-default-time-filter-main

Section: interaction-workspace
Default Value: 1M
Valid Values: A value from the following list: All, 1M, 1W, 1D
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies which Time Filter option is selected by default in the My History view when an agent accesses the main history data source:

  • All: All interactions from the main Universal Contact Server (UCS) database.
  • 1M: Interactions from main UCS database that were created less than 1 month ago.
  • 1W: Interactions from main UCS database that were created less than 1 week ago.
  • 1D: Interactions from main UCS database that were created less than 1 day ago.

privilege.contact.can-filter-my-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to filter interactions within the My history view.

privilege.contact.can-advanced-search-my-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to do advanced searches within My History.

privilege.contact.can-search-my-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to search for interactions in the My History view.

contact.myhistory-displayed-columns

Section: interaction-workspace
Default Value: Status,Subject,StartDate,EndDate
Valid Values: A comma-separated value list of Contact History items to display in the interaction view MyHistory, for example: Status, Subject, StartDate, EndDate.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Contact History items that are displayed in the My History view.

privilege.contact.can-mark-done.<media-type>.from-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to mark done in-progress interactions of the corresponding media-type from history. Depends on 'Contact - Can Use'.

privilege.contact.can-mark-done.email.from-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to mark done in-progress email interactions from the interaction history. Depends on 'Contact - Can Use'.

privilege.contact.can-inline-forward.email.from-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to forward email interactions from the Interaction History that are marked as Done.

privilege.contact.can-use-contact-myhistory

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables an agent to access their own history of interactions with contacts.

contact.history.media-filters

Section: interaction-workspace
Default Value: voice,email,chat,twitter,facebook,$OtherMedia$
Valid Values: A comma-separated value of valid media type names or $OtherMedia$.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65
Related Options: privilege.contact.can-filter-contact-history, privilege.contact.can-filter-my-history, privilege.contact.can-filter-all-interactions

Specifies the list of media types that can be used to filter the Contact History (depends on privilege.contact.can-filter-contact-history), My History (depends on privilege.contact.can-filter-my-history), and the result list of Interaction Search (depends on privilege.contact.can-filter-all-interactions). $OtherMedia$ allows to add the filter returning any media not listed in this option.

contact.date-search-types

Section: interaction-workspace
Default Value: On,OnOrAfter,Before,Between
Valid Values: Select at least one from the list.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of search types that are available for the agent to use to search the contact database by date.

contact.history-search-attributes

Section: interaction-workspace
Default Value: Status,StartDate,EndDate,Subject
Valid Values: A comma-separated value list of Interaction attributes.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of interaction attributes that an agent can use in Advanced Search mode of the Contact History, My History and Interaction Search views. You can also use custom interaction attributes.

privilege.contact.can-filter-contact-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to filter interactions in the Contact History view.

privilege.contact.can-advanced-search-contact-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to do advanced searches within the Contact History view.

privilege.contact.can-search-contact-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to search for interactions in the Contact History view.

openmedia.chat-history-channels

Section: workspace-service
Default Value: No default value
Valid Values: A comma-separated list of valid Media Types.
Changes Take Effect: Immediately
Introduced: 9.0.000.95

Specifies the list of Open Media channels for which the transcript is to be handled as a chat interactions, such as Facebook public and Twitter public, and displayed in the interaction details pane of the History views.

contact.history.media-filters

Section: interaction-workspace
Default Value: voice,email,chat,twitter,facebook,$OtherMedia$
Valid Values: A comma-separated value of valid media type names or $OtherMedia$.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65
Related Options: privilege.contact.can-filter-contact-history, privilege.contact.can-filter-my-history, privilege.contact.can-filter-all-interactions

Specifies the list of media types that can be used to filter the Contact History (depends on privilege.contact.can-filter-contact-history), My History (depends on privilege.contact.can-filter-my-history), and the result list of Interaction Search (depends on privilege.contact.can-filter-all-interactions). $OtherMedia$ allows to add the filter returning any media not listed in this option.

contact.history-search-attributes

Section: interaction-workspace
Default Value: Status,StartDate,EndDate,Subject
Valid Values: A comma-separated value list of Interaction attributes.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of interaction attributes that an agent can use in Advanced Search mode of the Contact History, My History and Interaction Search views. You can also use custom interaction attributes.

contact.history.quick-search.max-input-length

Section: interaction-workspace
Default Value: 10
Valid Values: An integer value from 1 through 20.
Changes Take Effect: Immediately
Introduced: 9.0.000.85

Specifies the maximum number of words that can be used to make a quick search of interaction in My History, Contact History and Interaction Search

contact.history-quick-search-attributes

Section: interaction-workspace
Default Value: Subject
Valid Values: A comma-separated value list of valid interaction attribute names, for example: Subject. Possible searchable attributes are: BccAddresses, CcAddresses, FromAddress, FromPersonal, Id, Mailbox, ReplyToAddress, StructuredText, Subject, Text, TheComment, ToAddresses
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74

Specifies the interaction attributes that are used to search interactions in the quick search mode of the Contact History view. These attributes should be text attributes. You can use custom interaction attributes. For more information, see 'Making an Attribute Searchable from the Desktop' in the PureEngage Digital Administrator's Guide.

contact.history-default-time-filter-main

Section: interaction-workspace
Default Value: 1M
Valid Values: A value from the following list: All, 1M, 1W, 1D
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies which Time Filter option is selected by default in the Contact History view when an agent accesses the main history data source:

  • All: All interactions from the main Universal Contact Server (UCS) database.
  • 1M: Interactions from main UCS database that were created less than 1 month ago.
  • 1W: Interactions from main UCS database that were created less than 1 week ago.
  • 1D: Interactions from main UCS database that were created less than 1 day ago.

contact.history-displayed-columns

Section: interaction-workspace
Default Value: Status,Subject,StartDate,EndDate,OwnerId
Valid Values: A comma-separated value list of Contact History items to display in the interaction view, for example: Status, Subject, StartDate, EndDate, OwnerId.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Contact History items that are displayed in the interaction view.

privilege.contact.can-mark-done.<media-type>.from-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to mark done in-progress interactions of the corresponding media-type from history. Depends on 'Contact - Can Use'.

privilege.contact.can-mark-done.email.from-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to mark done in-progress email interactions from the interaction history. Depends on 'Contact - Can Use'.

privilege.contact.can-inline-forward.email.from-history

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to forward email interactions from the Interaction History that are marked as Done.

privilege.contact.can-use-contact-history-notepad

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to see notes about interactions in the Contact History view.

privilege.contact.can-use-contact-history-detail

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to see the detail of interactions in the Contact History view.

privilege.contact.can-use-contact-history-case-data

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to see the case information of interactions in the Contact History view.

privilege.contact.can-use-contact-history

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to access the Contact History view.

privilege.contact.can-delete-contact

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to delete contacts from the contact database.

privilege.contact.can-create-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to create contacts.

contact.enable-force-delete-contact

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.72

Specifies whether an agent is allowed to delete a contact even if the contact has one or more in-progress interactions.

contact.displayed-attributes

Section: interaction-workspace
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: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of contact fields that are displayed when a Contact record is displayed.

contact.directory-search-mode

Section: interaction-workspace
Default Value: sql
Valid Values: A value from the following list: sql, lucene
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.39

Specifies the technical mode used in the Contact Directory view to search for contacts. The lucene mode must be used for large database of contacts.

contact.directory-search-attributes

Section: interaction-workspace
Default Value: LastName,FirstName,PhoneNumber,EmailAddress
Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names that can be used as search parameters.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Contact fields that can be used as search parameters.

contact.directory-displayed-columns

Section: interaction-workspace
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: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of contact fields that are displayed when the results of a contact search are displayed.

contact.default-directory-page-size

Section: interaction-workspace
Default Value: 10
Valid Values: An integer from 1 through 50.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.available-directory-page-size

Specifies the default value for the number of rows per page in the contact directory search result view. The value must be defined in the option contact.available-directory-page-size.

contact.cache-timeout-delay

Section: interaction-workspace
Default Value: 0
Valid Values: An integer from 1 through 3600. 0 to deactivate it
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the delay, in seconds, before the cache of the result of a Universal Contact Server request is cleared.

contact.available-directory-page-sizes

Section: interaction-workspace
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: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the possible values for the number of rows per page in the contact directory search result view.

privilege.contact.can-use-save-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to commit (save) modifications to contact information.

privilege.contact.can-use-contact-directory

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to view and search the Contact Directory.

contact.ucs-interaction.voice.enable-create

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies that the feature that generates the interaction history in Universal Contact Server (UCS) for Voice interactions is activated. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.ucs-interaction.voice.unanswered.enable-create

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68

Specifies whether a call history is created in UCS for outgoing calls that are not answered by a contact. If this option is set to true, unanswered calls are added to the UCS database and are viewable in the My History, Contact Directory, Interaction History, and Contact History tabs. This option can be overridden by a routing strategy, as described in the Configuration Guide.

contact.ucs-interaction.voice-campaign.enable-create

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies that the feature that generates the interaction history in Universal Contact Server (UCS) for Voice Outbound Campaign interactions is activated. This option can be overridden by a routing strategy as described in the Configuration Guide.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies that the feature that generates the interaction history in Universal Contact Server (UCS) for Open Media Workitem interactions is activated. This option can be overridden by a routing strategy as described in the Configuration Guide.

privilege.contact.can-use

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables access to the Contact features.

contact.ucs-interaction.voice-campaign.create-without-contact

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.90

Specifies whether a outbound campaign interaction is created in Universal Contact Server (UCS) when there is no associated contact. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.ucs-interaction.voice.enable-create-without-contact

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.90

Specifies whether a voice interaction is created in Universal Contact Server (UCS) when there is no associated contact. This option can be overridden by a routing strategy as described in the Configuration Guide.

privilege.contact.can-use-assign-contact

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to assign a contact to an interaction.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.80

When contact lookup is enabled in the context of the current interaction, this option specifies that the Universal Contact Server (UCS) creates a contact if the initial search cannot find any existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.<media-type>.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.enable

Specifies that 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 are activated. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.enable-create-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable-create-contact

When the value of this option is true and the value of ontact.lookup.enable is also set to true, this option specifies that Universal Contact Server (UCS) creates a contact if the initial search does not find a matching existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable-create-contact option is not specified for the applicable media type.

contact.lookup.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable

Specifies that Universal Contact Server (UCS) lookup is activated for contacts when an interaction is presented to the Agent. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable option is not specified for the applicable media type.

contact.lookup.enable-create-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable-create-contact

When the value of this option is true and the value of ontact.lookup.enable is also set to true, this option specifies that Universal Contact Server (UCS) creates a contact if the initial search does not find a matching existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable-create-contact option is not specified for the applicable media type.

contact.lookup.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable

Specifies that Universal Contact Server (UCS) lookup is activated for contacts when an interaction is presented to the Agent. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable option is not specified for the applicable media type.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.80

When contact lookup is enabled in the context of the current interaction, this option specifies that the Universal Contact Server (UCS) creates a contact if the initial search cannot find any existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.<media-type>.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.enable

Specifies that 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 are activated. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.last-called-agent.<media-type>.enable

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.last-called-agent.enable

Specifies if the last called agent properties are set in the contact when an interaction of the corresponding media type is presented to the agent. 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.last-called-agent.enable

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.last-called-agent.<media-type>.enable

Specifies if the last called agent properties are set in the contact when an interaction is presented to the agent. This option is taken into account only when the contact.last-called-agent.<media-type>.enable option is not defined for the applicable media type.

privilege.contact.can-use-assign-contact

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables agents to assign a contact to an interaction.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68
Related Options: contact.lookup.auto-assign-mode

Specifies the contact assignment policy when Contact Lookup is enabled for the specified media type. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of number of matched contacts. This option overrides contact.lookup.auto-assign-mode for the specified media type. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.auto-assign-mode

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68

Specifies the contact assignment policy when Contact Lookup is enabled. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of the number of matched contacts. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.enable-create-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable-create-contact

When the value of this option is true and the value of ontact.lookup.enable is also set to true, this option specifies that Universal Contact Server (UCS) creates a contact if the initial search does not find a matching existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable-create-contact option is not specified for the applicable media type.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies that the feature that generates the interaction history in Universal Contact Server (UCS) for Open Media Workitem interactions is activated. This option can be overridden by a routing strategy as described in the Configuration Guide.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.80

When contact lookup is enabled in the context of the current interaction, this option specifies that the Universal Contact Server (UCS) creates a contact if the initial search cannot find any existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.ucs-interaction.<media-type>.enable-create

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies that the feature that generates the interaction history in Universal Contact Server (UCS) for Open Media Workitem interactions is activated. This option can be overridden by a routing strategy as described in the Configuration Guide.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.80

When contact lookup is enabled in the context of the current interaction, this option specifies that the Universal Contact Server (UCS) creates a contact if the initial search cannot find any existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.<media-type>.auto-assign-mode

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68
Related Options: contact.lookup.auto-assign-mode

Specifies the contact assignment policy when Contact Lookup is enabled for the specified media type. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of number of matched contacts. This option overrides contact.lookup.auto-assign-mode for the specified media type. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.<media-type>.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.enable

Specifies that 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 are activated. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.auto-assign-mode

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68

Specifies the contact assignment policy when Contact Lookup is enabled. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of the number of matched contacts. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.enable-create-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable-create-contact

When the value of this option is true and the value of ontact.lookup.enable is also set to true, this option specifies that Universal Contact Server (UCS) creates a contact if the initial search does not find a matching existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable-create-contact option is not specified for the applicable media type.

contact.lookup.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable

Specifies that Universal Contact Server (UCS) lookup is activated for contacts when an interaction is presented to the Agent. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable option is not specified for the applicable media type.

contact.potential-match.search-query.or-clause

Section: interaction-workspace
Default Value: PhoneNumber, EmailAddress
Valid Values: List of contact attributes including custom attributes
Changes Take Effect: Immediately
Introduced: 9.0.000.74
Related Options: contact.potential-match.search-query.and-clause

Specifies the list of contact attributes, each of which will be added as an OR clause in the search query to retrieve potential duplicate contacts from UCS during contact creation in Workspace.

contact.potential-match.search-query.and-clause

Section: interaction-workspace
Default Value: No default value
Valid Values: List of contact attributes including custom attributes
Changes Take Effect: Immediately
Introduced: 9.0.000.74
Related Options: contact.potential-match.search-query.or-clause

Specifies the list of contact attributes, each of which will be added as an AND clause in the search query to retrieve potential duplicate contacts from UCS during contact creation in Workspace.

contact.create-contact.check-duplicate

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.74
Related Options: contact.potential-match.search-query.and-clause, contact.potential-match.search-query.or-clause

If an agent tries to create a contact that potentially matches one or more in the contact database, Workspace displays the list of potential matches, then allows an agent to either create the new contact or select an existing contact instead. Use the following options to control what UCS attributes are searched to determine whether a new contact is a potential duplicate. These options can be configured individually or together to allow \"AND\" and \"OR\" searches.

This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.multiple-value-attributes

Section: interaction-workspace
Default Value: PhoneNumber,EmailAddress
Valid Values: A comma separated value list of Attribute Value names that correspond to contact field names.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of contact attributes that can support multiple values.

contact.mandatory-attributes

Section: interaction-workspace
Default Value: FirstName,LastName
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: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Contact fields that must be completed for a contact.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.80

When contact lookup is enabled in the context of the current interaction, this option specifies that the Universal Contact Server (UCS) creates a contact if the initial search cannot find any existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.enable-create-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable-create-contact

When the value of this option is true and the value of ontact.lookup.enable is also set to true, this option specifies that Universal Contact Server (UCS) creates a contact if the initial search does not find a matching existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable-create-contact option is not specified for the applicable media type.

contact.lookup.voice.use-formatted-number

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.76

Specifies that the phone number of an inbound voice interaction is subject to processing by the expression.phone-number.supported-characters option prior to contact lookup. This option depends on the option contact.lookup.enable-create-contact. This option can be overridden by a routing strategy as described in the Configuration Guide.

expression.phone-number.supported-characters

Section: interaction-workspace
Default Value: 0123456789+
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. All special characters that are valid Windows file names.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the characters that are permitted when building a request to the T-Server that relies on a phone number. Any other characters from the original string coming from the User Interface are removed. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.enable-create-contact

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable-create-contact

When the value of this option is true and the value of ontact.lookup.enable is also set to true, this option specifies that Universal Contact Server (UCS) creates a contact if the initial search does not find a matching existing contact. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable-create-contact option is not specified for the applicable media type.

contact.lookup.auto-assign-mode

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68

Specifies the contact assignment policy when Contact Lookup is enabled. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of the number of matched contacts. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.auto-assign-mode

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68

Specifies the contact assignment policy when Contact Lookup is enabled. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of the number of matched contacts. This option can be overridden by a routing strategy as described in the Configuration Guide.

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

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68
Related Options: contact.lookup.auto-assign-mode

Specifies the contact assignment policy when Contact Lookup is enabled for the specified media type. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of number of matched contacts. This option overrides contact.lookup.auto-assign-mode for the specified media type. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.auto-assign-mode

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68

Specifies the contact assignment policy when Contact Lookup is enabled. If set to false and there are multiple matched contacts for an interaction, they are listed as suggested contacts. If set to true, the first contact will be assigned automatically irrespective of the number of matched contacts. This option can be overridden by a routing strategy as described in the Configuration Guide.

contact.lookup.<media-type>.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.enable

Specifies that 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 are activated. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable

Specifies that Universal Contact Server (UCS) lookup is activated for contacts when an interaction is presented to the Agent. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable option is not specified for the applicable media type.

contact.lookup.<media-type>.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.enable

Specifies that 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 are activated. This option can be overridden by a routing strategy as described in the Configuration Guide. 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.enable

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: contact.lookup.<media-type>.enable

Specifies that Universal Contact Server (UCS) lookup is activated for contacts when an interaction is presented to the Agent. This option can be overridden by a routing strategy as described in the Configuration Guide. Note: This option is taken into account only when attached data 'IdentifyCreateContact' is not set in the interaction and the contact.lookup.<media-type>.enable option is not specified for the applicable media type.

(Update with the copy of version: 9.0.0DRAFT)
(Update with the copy of version: 9.0.0DRAFT)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Enabling agents to manage contacts=
+
=Enabling agents to manage contacts and interactions=
 
__TOC__
 
__TOC__
  
 
==Procedure: Enabling Automatic Contact Lookup==
 
==Procedure: Enabling Automatic Contact Lookup==
 
'''Purpose:'''
 
'''Purpose:'''
To enable Universal Contact Server to lookup and create contacts when a new interaction is routed to an agent.
+
To enable Universal Contact Server to lookup and create contacts when a new interaction is routed to an agent or when an agent [[SettingUpAgents#DialPlan|dials a call]].
  
 
'''Prerequisites'''
 
'''Prerequisites'''
* A working knowledge of Genesys Administrator Extension (GAX).
+
* The <tt>GWS Application Server object</tt> application object exists in the Configuration Database.
* The <tt>Cloud_Cluster</tt> application object exists in the Configuration Database.
+
* The <tt>GWS Application Server object</tt> application has a connection to Universal Contact Server.
* The <tt>Cloud_Cluster</tt> application has a connection to Universal Contact Server.
 
 
'''Start'''
 
'''Start'''
 
<ol type="1">
 
<ol type="1">
Line 16: Line 15:
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable}}</li>
 +
{{NoteFormat|If more than one contact matches, by default the first found contact is assigned.|1}}
 
</ul>
 
</ul>
 +
</li>
 +
<li>If the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable}} (or {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable}}) options is <tt>true</tt>, you can use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-auto-assign-mode}} (or {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zauto-assign-mode}}) option to enable contact look up to either assign the first contact that matches the search criteria (for example, the phone number) or to allow an agent to review multiple matches and select the correct match. For example, multiple people could be using the same phone to make calls into your contact center. Each of these contacts has a unique record in UCS that have the same phone number.<br />
 +
 +
To enable agents to select from a list of multiple contacts that match contact lookup criteria, set the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-auto-assign-mode}} option to <tt>false</tt>. If the value of the option is <tt>false</tt>, and multiple contacts match the search criteria, the '''Suggested Contacts''' view containing all the contacts that match the search criteria is displayed in the interaction window.<br />
 +
 +
If the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-auto-assign-mode}} option is <tt>true</tt>, the first contact that matches the search criteria is assigned to the interaction automatically and the '''Suggested Contacts''' view is not displayed.<br />
 +
{{NoteFormat|The maximum number of suggested contacts that can be displayed is limited to 50.|1}}
 +
</li>
 +
<li>
 +
If an inbound call is not already assigned to a contact by using a strategy, you can preprocess the inbound phone number prior to performing contact lookup in Universal Contact Server (UCS) to avoid potential duplicate contact creation.
 +
<ol>
 +
<li> Set the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable-create-contact|contact.lookup.enable-create-contact}} option to <tt>true</tt>.</li>
 +
<li>Remove unsupported characters by using the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:expression-phone-number-supported-characters|expression.phone-number.supported-characters}} option.</li>
 +
<li> Set the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-voice-use-formatted-number}} option to <tt>true</tt> to specify that the phone number of an inbound voice interaction is subject to processing by the <tt>expression.phone-number.supported-characters</tt> option prior to contact lookup. This option can be [[OverridingInteractionWorkspaceOptions|overridden by a routing strategy]].</li>
 +
</ol>
 
</li>
 
</li>
 
<li>Enable Workspace to create a new contact in UCS if the contact is not found:
 
<li>Enable Workspace to create a new contact in UCS if the contact is not found:
Line 26: Line 41:
 
<li>Specify which contact attributes an agent must complete when a contact is created by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-mandatory-attributes}} option.</li>
 
<li>Specify which contact attributes an agent must complete when a contact is created by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-mandatory-attributes}} option.</li>
 
<li>Specify which contact attributes can have more than one value, for example multiple phone numbers, by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-multiple-value-attributes}} option.</li>
 
<li>Specify which contact attributes can have more than one value, for example multiple phone numbers, by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-multiple-value-attributes}} option.</li>
<li>To enable Contact Search, follow the [[EnablingAgentsToManageContacts#InteractionSearch|Enabling the Interactions Search view]] procedure.
+
<li>To alert agents who try to create a contact that potentially already exists in the UCS contact database, set the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-create-contact-check-duplicate}} option to <tt>true</tt>. If an agent tries to create a contact that potentially matches one or more in the contact database, Workspace displays the list of potential matches, then allows an agent to either create the new contact or select an existing contact instead.
 +
<br />
 +
Use the following options to control what UCS attributes are searched to determine whether a new contact is a potential duplicate. These options can be configured individually or together to allow "AND" and "OR" searches.
 +
<ul>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-potential-match-search-query-and-clause}}: These UCS contact attributes are added to the search query using AND logic.</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-potential-match-search-query-or-clause}}: These UCS contact attributes are added to the search query using OR logic.</li>
 +
</ul>
 +
</li>
 +
<li>To enable Contact Search, follow the [[EnablingAgentsToManageContacts#InteractionSearch|Enabling the Interactions Search view]] procedure.</li>
 
</ol>
 
</ol>
  
 
'''End'''
 
'''End'''
 +
{{AnchorDiv|Lookup}}
 +
==Triggering contact look-up and populating History==
 +
 +
Interactions can be assigned to a contact in the contact database automatically or manually. Automatic assignment is handled by contact look-up when an inbound interaction is received.
  
==Procedure: Enabling the Contact Directory, Contact History, and My History==
+
Use the following configurations to specify how automatic contact assignment and creation is handled.
 +
 
 +
===Automatic contact look-up and interaction storage===
 +
 
 +
Workspace can be configured to automatically assign a new inbound interaction to an existing contact in the contact database, or to create a new contact if the contact is not found. This behavior can be specified for all channels or for individual channels. To enable this capability, configure the following options:
 +
 
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable}}: Specifies that the [[Documentation:ES:Admin:UCS|Universal Contact Server]] (UCS) identify service is to be used for contact lookup.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable-create-contact}}: Specifies that the [[Documentation:ES:Admin:UCS|Universal Contact Server]] (UCS) creates a contact service to be used if the identify service fails to find the contact.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-auto-assign-mode}}: When there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches that he or she can manually choose the contact.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable}}: Activates the Workspace features that rely on the Universal Contact Server (UCS) '''IdentifyService''' for contact lookup when an interaction is presented to the Agent.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zauto-assign-mode}}: For the specified media type, when there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches that he or she can manually choose the contact.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable-create-contact}}: 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.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-zmedia-type-zenable-create}}: Activates the Workspace feature that generates the interaction history in Universal Contact Server (UCS) based on the inbound and outbound interactions of type &lt;media-type&gt; that are handled by Workspace. Enable agents to create interactions of type &lt;media-type&gt;.
 +
 
 +
====Directly dialed calls====
 +
If you want to record calls in your Contact Database that were directly dialed by agents so the the calls can be tracked in the agent's history, ensure that the following two options are set to <tt>true</tt>:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable-create-contact}}
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-zmedia-type-zenable-create}}
 +
To enable agents to manually create a contact when they have an active interaction, set the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable-create-contact}} option to <tt>true</tt>.
 +
 
 +
===Improving automatic contact assignment===
 +
 
 +
If you implement the default contact look-up configuration, Workspace selects the first contact from the list of matching contacts returned by UCS, based on interaction attributes. However, if more than one contact matches the information available for a new inbound interaction, the subsequent matches are not considered. To improve automatic contact assignment when multiple matches are found, use the following configuration options to enable agents to choose a contact from the list of matches returned by UCS:
 +
 
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-auto-assign-mode}}: When there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches from which he or she can manually choose the contact.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zauto-assign-mode}}: For the specified media type, when there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches from which he or she can manually choose the contact.
 +
 
 +
=====Example: Preventing automatic contact creation in case of no UCS match and automatic contact assignment in case of multiple UCS matches=====
 +
 
 +
This example is for the voice channel, but it can be applied to all channels or to other specific channels. Normally, if there is a single contact in the Universal Contact Server (UCS) database, Workspace automatically assigns the contact. In these scenarios:
 +
 
 +
* If you want to enable your agents to assign a contact to an interaction based on a look-up in the UCS database in scenarios where no match is found for the inbound interaction, but you do not want a new contact to be created automatically without your agent searching the contact database first,
 +
* If you want to enable an agent to review the possible contact matches and choose the appropriate one in scenarios where there are multiple contacts that match an incoming interaction,
 +
 
 +
:Use the following configuration:
 +
:* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use-assign-contact}}
 +
:* <tt>contact.lookup.voice.enable</tt> = <tt>true</tt>
 +
:* <tt>contact.lookup.voice.enable-create-contact</tt> = <tt>false</tt>
 +
:* <tt>contact.lookup.voice.auto-assign-mode</tt> = <tt>false</tt>
 +
 
 +
===Contact Management: Last Routed Agent===
 +
The Last Routed Agent Feature enables you to save in the Contact Profile, information about the last agent who handled interactions from that contact. The agent handling information can then be used during the routing of subsequent interactions from this contact. When an agent actively handles an interaction of a given media type from a contact, the following keys are set in the Contact Profile:
 +
* <tt>LastCalledAgent_EmployeeID</tt>
 +
* <tt>LastCalledAgent_TimeStamp</tt>
 +
* <tt>LCA_EmplID_&lt;MediaType&gt;</tt>
 +
* <tt>LCA_TimeStamp_&lt;MediaType&gt;</tt>
 +
 
 +
Where <tt>&lt;MediaType&gt;</tt> corresponds to the media of the interaction.
 +
 
 +
Refer to the [[Documentation/ES|eServices]] and [[Documentation/R|Routing]] documentation for more information about this feature.
 +
 
 +
You can activate this option globally by setting to true the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-last-called-agent-enable}} option in the <tt>Contact</tt> section. Or you can activate it by media type by setting the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-last-called-agent-zmedia-type-zenable}} option to <tt>true</tt> in the <tt>Contact</tt> section.
 +
 
 +
{{AnchorDiv|DisableLookup}}
 +
==Disabling Automatic Contact Look-up==
 +
To disable automatic contact lookup and contact creation when Genesys handles a new interaction, configure these options with the following values:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable}} = <tt>false</tt>
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable-create-contact}} = <tt>false</tt>
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable}} = <tt>false</tt>
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable-create-contact}} = <tt>false</tt>
 +
 
 +
{{AnchorDiv|OverrideLookup}}
 +
==Overriding Contact Look-up==
 +
You can override automatic contact look-up and contact creation by including the '''IdentifyCreateContact''' option in the interaction attached data. If present, this option overrides the following contact look-up options. Refer to the '''Supported value for the IdentifyCreateContact option''' table to see how different values for the '''IdentifyCreateContact''' option override contact look-up and creation:
 +
 
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable}}
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-enable-create-contact}}
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable}}
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-lookup-zmedia-type-zenable-create-contact}}
 +
 
 +
{| border="1"
 +
|+ '''Supported value for the IdentifyCreateContact option'''
 +
|-
 +
! Value
 +
! Override
 +
|-
 +
| 1
 +
|
 +
* Disable contact lookup (overrides <tt>contact.lookup.enable = true</tt> and <tt>contact.lookup.&lt;media-type&gt;.enable = true</tt>)
 +
* Disable contact creation on unsuccessful lookup (overrides <tt>contact.lookup.enable-create-contact = true</tt> and <tt>contact.lookup.&lt;media-type&gt;.enable-create-contact = true</tt>)
 +
|-
 +
| 2
 +
|
 +
* Enables contact lookup (overrides <tt>contact.lookup.enable = false</tt> and <tt>contact.lookup.&lt;media-type&gt;.enable = false</tt>)
 +
* Disable contact creation on unsuccessful lookup (overrides <tt>contact.lookup.enable-create-contact = true</tt> and <tt>contact.lookup.&lt;media-type&gt;.enable-create-contact = true</tt>)
 +
|-
 +
| 3
 +
|
 +
* Enables contact lookup (overrides <tt>contact.lookup.enable = false</tt> and <tt>contact.lookup.&lt;media-type&gt;.enable = false</tt>)
 +
* Enables contact creation on unsuccessful lookup (overrides <tt>contact.lookup.enable-create-contact = false</tt> and <tt>contact.lookup.&lt;media-type&gt;.enable-create-contact = false</tt>)
 +
|-
 +
| Any other value or an invalid value.
 +
| The options are not overridden.
 +
|}
 +
 
 +
{{AnchorDiv|NocontactId}}
 +
==Procedure: Enabling agents to handle voice interactions without an assigned contact==
 +
'''Purpose:'''
 +
To create voice interactions in the Universal Contact Server (UCS) database without an associated '''contactId'''. This feature also enables the '''Note''' view for interactions without an assigned contact.
 +
 
 +
By default, Workspace does not create a voice interaction in the UCS database if a '''contactId''' is not assigned to a voice call. An interaction might not have an assigned '''ContactId''' if the contact lookup request returns no matching contact and the agent does not assign a contact to the interaction. In some environments, agent configuration might prevent the association of a '''contactId''' with an interaction. For example:
 +
* The value of '''contact.lookup.voice.enable''' is '''false'''. In this scenario, contact lookup is not performed and no '''contactId''' is assigned.
 +
* The value of '''contact.lookup.voice.enable''' is '''true''', but the value of '''contact.lookup.voice.enable-create-contact''' is set to '''false'''. In this scenario, contact lookup is performed, but when no matching contact is found, the interaction history is not created in the UCS database.
 +
* The value of {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use-assign-contact}} is set to '''false'''. In this scenario, when a '''contactId''' cannot be assigned automatically to a voice interaction, it is not possible for the agent to manually create a contact or assign an interaction to a known contact.
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension.
 +
* Procedure: Enabling agents to manage contacts
 +
 
 +
'''Start'''
 +
 
 +
# Configure the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-enable-create-without-contact}} option to '''true'''.
 +
# Configure the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-campaign-create-without-contact}} option to '''true''' to enable this feature for [[IntOutboundCampaigns|Outbound campaigns]].
 +
'''End'''
 +
 
 +
{{AnchorDiv|EnableContactHistory}}
 +
==Procedure: Enabling the Contact Directory, Contact History, and My History==
 
'''Purpose:'''
 
'''Purpose:'''
 
To enable an agent to use the Contact Directory, Contact History, and My History views.
 
To enable an agent to use the Contact Directory, Contact History, and My History views.
Line 40: Line 183:
  
 
'''Prerequisites'''
 
'''Prerequisites'''
* A working knowledge of Genesys Administrator Extension (GAX).
+
* The <tt>GWS Application Server object</tt> application object exists in the Configuration Database.
* The <tt>Cloud_Cluster</tt> application object exists in the Configuration Database.
+
* The <tt>GWS Application Server object</tt> application has a connection to Universal Contact Server.
* The <tt>Cloud_Cluster</tt> application has a connection to Universal Contact Server.
+
* The <tt>GWS Application Server object</tt> application has a connection to Interaction Server.
* The <tt>Cloud_Cluster</tt> application has a connection to Interaction Server.
 
 
* The agent object is configured to use one or more of the following media channels:
 
* The agent object is configured to use one or more of the following media channels:
 
** [[SettingUpAgents|Voice]]
 
** [[SettingUpAgents|Voice]]
** [[EnablingComms|Email]]
+
** [[IntEmail|Email]]
** [[EnablingComms|Chat]]
+
** [[IntChat|Chat]]
 
<!--** [[EnablingComms|Facebook]]-->
 
<!--** [[EnablingComms|Facebook]]-->
 
<!--** [[EnablingComms|Twitter]]-->
 
<!--** [[EnablingComms|Twitter]]-->
Line 71: Line 213:
 
</li>
 
</li>
 
<li>'''Grant the Contact - Can Use privilege''': {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use}}</li>
 
<li>'''Grant the Contact - Can Use privilege''': {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use}}</li>
<li>'''To create interactions in Universal Contact Server''' (UCS),  configure the following Interaction options in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> object:
+
<li>'''To create interactions in Universal Contact Server''' (UCS),  configure the following Interaction options in the <tt>interaction-workspace</tt> section of the <tt>GWS Application Server object</tt> object:
 
<ul>
 
<ul>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-zmedia-type-zenable-create}}: Set to <tt>true</tt>. For example to enable voice interactions, set <tt>contact.ucs-interaction.voice.enable-create</tt> to <tt>true</tt>.</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-zmedia-type-zenable-create}}: Set to <tt>true</tt>. For example to enable voice interactions, set <tt>contact.ucs-interaction.voice.enable-create</tt> to <tt>true</tt>.</li>
 
<li>By default, these options should be set to <tt>true</tt> except for Outbound Campaign voice call, where the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-campaign-enable-create}}
 
<li>By default, these options should be set to <tt>true</tt> except for Outbound Campaign voice call, where the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-campaign-enable-create}}
 
option deactivates this by default; to create interactions in UCS for voice Outbound Campaign calls, set the value of contact.ucs-interaction.voice-campaign.enable-create to <tt>true</tt>.</li>
 
option deactivates this by default; to create interactions in UCS for voice Outbound Campaign calls, set the value of contact.ucs-interaction.voice-campaign.enable-create to <tt>true</tt>.</li>
 +
<li>Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-unanswered-enable-create}} option to specify whether a call history is created for outgoing calls that are not answered by a contact. If this option is set to <tt>true</tt>, unanswered calls are added to the UCS database and are viewable in the '''My History''', '''Contact Directory''', '''Interaction History''', and '''Contact History''' tabs. This option depends on the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-enable-create}} option being set to <tt>true</tt>.
 +
</li>
 
</ul>
 
</ul>
 
</li>
 
</li>
Line 90: Line 234:
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-directory-displayed-columns}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-directory-displayed-columns}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-directory-search-attributes}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-directory-search-attributes}}</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-directory-search-mode}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-displayed-attributes}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-displayed-attributes}}</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-enable-force-delete-contact}}: Allows an agent to force-delete a contact who has one or more in-progress interactions.
 +
</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-create-contact}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-create-contact}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-delete-contact}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-delete-contact}}</li>
Line 104: Line 251:
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-email-from-history}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-email-from-history}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-zmedia-type-zfrom-history}} (for example ''media-type'' = fax, sms, workitem, pdf, or other open media type)</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-zmedia-type-zfrom-history}} (for example ''media-type'' = fax, sms, workitem, pdf, or other open media type)</li>
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-open-email-from-history}}</li>
+
<li>Enable agents to open interactions from the History and control which interactions can be opened. Refer to [[SettingUpAgents#HistoryPrivileges|Granting basic Interaction History privileges]].</li>
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-open-zmedia-type-zfrom-history}} (for example ''media-type'' = fax, sms, workitem, pdf, or other open media type)</li>
 
 
</ul>
 
</ul>
 
then '''configure the Contact options''' in the <tt>interaction-workspace</tt> section:
 
then '''configure the Contact options''' in the <tt>interaction-workspace</tt> section:
Line 112: Line 258:
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-default-time-filter-main}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-default-time-filter-main}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-quick-search-attributes}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-quick-search-attributes}}</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-quick-search-max-input-length}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-media-filters}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-media-filters}}</li>
 
</ul>
 
</ul>
 
</li>
 
</li>
<li>'''Enable Contact History search'''. You can enable basic and advanced searching in the History view in the Contact Directory and in the Interaction window for agents in your contact center and configure which advanced search options are displayed in the Workspace Agent Desktop. With advanced searching enabled, agents can search contact history by date range, interaction type, and specific default and custom attributes. The search returns a maximum of 100 results.
+
<li>
 +
To enable the display of chat transcripts for Open Media channels that are handled as chat interactions, such as Facebook public and Twitter public, configure the {{Optionslink|link=Options:Genesys_Web_Services:workspace-service:openmedia-chat-history-channels}} in the <tt>workspace-service</tt> section.
 +
</li>
 +
<li>'''Enable Contact History search'''. You can enable basic and advanced searching in the History view in the Contact Directory and in the Interaction window for agents in your contact center and configure which advanced search options are displayed in the Agent Workspace. With advanced searching enabled, agents can search contact history by date range, interaction type, and specific default and custom attributes. The search returns a maximum of 100 results.
 
<ol type="a">
 
<ol type="a">
 
<li>Activate the basic search privilege. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-search-contact-history}}.</li>
 
<li>Activate the basic search privilege. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-search-contact-history}}.</li>
Line 132: Line 282:
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-email-from-history}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-email-from-history}}</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-zmedia-type-zfrom-history}} (for example ''media-type'' = fax, sms, workitem, pdf, or other open media type)</li>
 
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-zmedia-type-zfrom-history}} (for example ''media-type'' = fax, sms, workitem, pdf, or other open media type)</li>
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-open-email-from-history}}</li>
+
<li>Enable agents to open interactions from the History and control which interactions can be opened. Refer to [[SettingUpAgents#HistoryPrivileges|Granting basic Interaction History privileges]].</li>
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-open-zmedia-type-zfrom-history}} (for example ''media-type'' = fax, sms, workitem, pdf, or other open media type)</li>
 
 
</ul>
 
</ul>
 
then '''configure the Contact options''' in the <tt>interaction-workspace</tt> section:
 
then '''configure the Contact options''' in the <tt>interaction-workspace</tt> section:
Line 140: Line 289:
 
</ul>
 
</ul>
 
</li>
 
</li>
<li>'''Enable My History Search'''. You can enable basic and advanced searching in the '''My History''' tab in the '''Connect''' group for agents in your contact center and specify which advanced search options are displayed in Workspace Agent Desktop. With advanced searching enabled, agents can search their own interaction history by date range, interaction type, and specific default and custom attributes. The search returns a maximum of 100 results.
+
<li>'''Enable My History Search'''. You can enable basic and advanced searching in the '''My History''' tab in the '''Connect''' group for agents in your contact center and specify which advanced search options are displayed in Agent Workspace. With advanced searching enabled, agents can search their own interaction history by date range, interaction type, and specific default and custom attributes. The search returns a maximum of 100 results.
 
<ol type="a">
 
<ol type="a">
 
<li>Activate the basic search privilege. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-search-my-history}}.</li>
 
<li>Activate the basic search privilege. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-search-my-history}}.</li>
Line 147: Line 296:
 
<li>Enable chronological filtering by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-myhistory-default-time-filter-main}} option.</li>
 
<li>Enable chronological filtering by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-myhistory-default-time-filter-main}} option.</li>
 
<li>Specify which attribute columns are displayed in the My History view by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-myhistory-displayed-columns}} option.</li>
 
<li>Specify which attribute columns are displayed in the My History view by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-myhistory-displayed-columns}} option.</li>
<li>Specifies the interaction attributes that are used to search interactions in the quick search mode of the My History view by configuring the  
+
<li>Specify the interaction attributes that are used to search interactions in the quick search mode of the My History view by configuring the  
 
{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-myhistory-quick-search-attributes}} option.</li>
 
{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-myhistory-quick-search-attributes}} option.</li>
 +
<li>Specify the maximum number of words that can be used for a quick search phrase by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-quick-search-max-input-length}} option. Genesys recommends using the default value of <tt>10</tt> to avoid impact on your system resources.</li>
 
<li>Define the list of attributes displayed on the Advanced Search window. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}}.</li>
 
<li>Define the list of attributes displayed on the Advanced Search window. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}}.</li>
 
<li>Define the list of date search options on the Advanced Search window. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-date-search-types}}.</li>
 
<li>Define the list of date search options on the Advanced Search window. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-date-search-types}}.</li>
 
<li>Specify which interaction types (channels) are included in the '''My History''' view list of interactions. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-media-filters}}.</li>
 
<li>Specify which interaction types (channels) are included in the '''My History''' view list of interactions. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-media-filters}}.</li>
 
</ol>
 
</ol>
 +
<li>'''Enable Click to dial and click to search'''. Agents can be enabled to make calls or to open the contact information in the '''Contact Directory''' from the '''Details''' tab of a History view.
 +
<ol type="a">
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-history-can-click-to-dial}}: Enables an agent to use Click-to-dial a voice call from the '''Details''' tab of the history of a voice interaction in any History view.</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-history-can-click-to-search}}: Enables an agent to use Click-to-search to open the '''Contact Directory''' by clicking a Contact name in the '''Details''' tab of the '''My History''' or '''Interaction Search''' views.</li>
 +
</ol>
 +
</li>
 
</ol>  
 
</ol>  
  
Line 178: Line 334:
 
{{AnchorDiv|InteractionSearch}}
 
{{AnchorDiv|InteractionSearch}}
 
== Procedure: Enabling the Interactions Search view==
 
== Procedure: Enabling the Interactions Search view==
In Workspace Agent Desktop you can enable the '''Interactions Search''' view. When enabled, agents can select the '''Interactions Search''' tab from the'''Connect''' group and then use a variety of advanced search controls to locate the interactions that they want to view. The search returns a maximum of 100 results.
+
In Agent Workspace you can enable the '''Interactions Search''' view. When enabled, agents can select the '''Interactions Search''' tab from the'''Connect''' group and then use a variety of advanced search controls to locate the interactions that they want to view. The search returns a maximum of 100 results.
  
 
'''Start'''
 
'''Start'''
Line 185: Line 341:
 
#Enable the filtering of interactions. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-filter-all-interactions}}.
 
#Enable the filtering of interactions. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-filter-all-interactions}}.
 
#Define the list of attributes that the agent can select in the '''Quick Search''' view. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-all-interactions-quick-search-attributes}}.
 
#Define the list of attributes that the agent can select in the '''Quick Search''' view. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-all-interactions-quick-search-attributes}}.
 +
#Specify the maximum number of words that can be used for a quick search phrase by configuring the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-quick-search-max-input-length}} option. Genesys recommends using the default value of <tt>10</tt> to avoid impact on your system resources.
 
#Define the list of attributes that the agent can select in the '''Advanced Search''' view. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}}.
 
#Define the list of attributes that the agent can select in the '''Advanced Search''' view. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}}.
 
#Define the list of search types that the agent can use to define a date range for the search. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-date-search-types}}.
 
#Define the list of search types that the agent can use to define a date range for the search. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-date-search-types}}.
 
#Define the columns displayed in the returned search results. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-all-interactions-displayed-columns}}.
 
#Define the columns displayed in the returned search results. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-all-interactions-displayed-columns}}.
 
#Specify which interaction types (channels) are included in the '''Interaction Search''' view list of interactions. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-media-filters}}.
 
#Specify which interaction types (channels) are included in the '''Interaction Search''' view list of interactions. See {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-media-filters}}.
 +
# Enable agents to open interactions from the History and control which interactions can be opened. Refer to [[SettingUpAgents#HistoryPrivileges|Granting basic Interaction History privileges]].
 
'''End'''
 
'''End'''
 +
{{AnchorDiv|AdvancedSearch}}
 
===Advanced Search===
 
===Advanced Search===
The standard search enables agents to search for interactions by status, subject, start date, end date, contact first name, and contact last name. You can expand the capabilities of the advanced search by enabling agents to search for interactions based on the attributes listed in the '''Searchable Attributes''' table. You specify these criteria by using the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}} option.
+
The following table summarizes the attributes that you can use to configure Quick Search and Advanced Search of the '''Contact History''', '''My History''', and '''Interactions Search''' views. System and custom attributes are supported as noted.
 +
* System date attributes: '''On''', '''OnOrAfter''', '''Before''', and '''Between''' search types are configured by using the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-date-search-types}} option.
 +
* System text attributes: These can be searched by using the '''Matches''' search type which, for each word typed into the query, returns at least one word that starts with this word. Text search does not support queries containing double quotes. Interaction Search enables agents to search for the content of email and chat interactions. Content for these interactions is stored in '''Text''' and/or '''StructuredText''' attributes. '''Text''' includes the content of the plain-text email interactions. '''StructuredText''' includes the content of HTML-formatted email interactions and chat transcripts, as well as SMS interactions handled in '''session mode''' and Facebook Private Message sessions.
 +
* Custom History Search Attributes: A custom interaction search attribute is an interaction attribute that is not part of the default Genesys UCS data design. A custom interaction search attribute is typically defined during the Business Process design and is implemented by the addition of key-value pairs to the attached data of the interactions which are then stored in UCS.
 +
*: Configure Workspace to use custom interaction search attributes as search criteria for both the quick search and advanced search modes of the '''Interaction Search''', '''Contact History''', and '''My History''' views. Use the following options:
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-quick-search-attributes}}
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-myhistory-quick-search-attributes}}
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-all-interactions-quick-search-attributes}}
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-search-attributes}}
 +
*: '''Limitation:''' JOINT searches of the interaction list with the contact list are not possible unless you create a business process that copies attributes from the contact records into the corresponding interaction records.
 +
 
  
 
{|
 
{|
|+ '''Searchable attributes'''
+
|+ '''Interaction History Search System Attributes'''
 
|-
 
|-
 
! Attribute Name
 
! Attribute Name
! Attribute Display Name
+
! Advanced Search
! Comments
+
! Quick Search
|-
+
! Contact/My History (grid)
| BccAddresses
+
! Contact/My History (tree)
| Bcc Address
+
! All Interactions Search (grid)
| All types of email addresses
+
! Description
 
|-
 
|-
 
| CcAddresses
 
| CcAddresses
| Cc Address
+
| Yes
| All types of email addresses
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The email Cc address.
 
|-
 
|-
 
| ContactId
 
| ContactId
| Contact
+
| Yes
| Name of a contact (Team Communicator is presented to select the contact)
+
| No
 +
| Yes
 +
| Yes
 +
| Yes
 +
| The Contact of the interaction. Searchable by Team Communicator.
 
|-
 
|-
 
| EndDate
 
| EndDate
| End Date
+
| Yes
| Date
+
| No
 +
| Yes
 +
| Yes
 +
| Yes
 +
| The date when the interaction was marked completed in the Genesys system.
 
|-
 
|-
 
| EstablishedDate
 
| EstablishedDate
| Established Date
+
| Yes
| Date
+
| No
 +
| No
 +
| No
 +
| No
 +
| The date when the Chat session was established.
 
|-
 
|-
 
| FromAddress
 
| FromAddress
| From Address
+
| Yes
|  
+
| Yes
 +
| Yes
 +
| Yes
 +
| Yes
 +
| The email From address.
 
|-
 
|-
 
| FromPersonal
 
| FromPersonal
| From Personal Part
+
| Yes
|
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The Personal Part of the email From address.
 
|-
 
|-
 
| Id
 
| Id
| Interaction ID
+
| Yes
|  
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The unique ID of the Interaction.
 
|-
 
|-
 
| Mailbox
 
| Mailbox
| Source mailbox
+
| Yes
|  
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The Mailbox from which the email was received.
 
|-
 
|-
 
| OwnerId
 
| OwnerId
| Processed By
+
| Yes
| Name of the agent. Team communicator is presented to select the agent
+
| No
 +
| Yes
 +
| Yes
 +
| Yes
 +
| The person who processed the interaction. Searchable by Team Communicator.
 
|-
 
|-
 
| PhoneNumber
 
| PhoneNumber
| Phone Number
+
| Yes
|
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The Phone Number from which the contact called or was used to call the contact.
 
|-
 
|-
 
| ReleasedDate
 
| ReleasedDate
| Released Date
+
| Yes
|  
+
| No
 +
| No
 +
| No
 +
| No
 +
| The date when the Chat session was ended.
 
|-
 
|-
 
| ReplyToAddress
 
| ReplyToAddress
| Reply-To Address
+
| No
|  
+
| No
 +
| No
 +
| No
 +
| No
 +
| The email Reply-To address.
 +
|-
 +
| ReviewerId
 +
| No
 +
| No
 +
| No
 +
| No
 +
| No
 +
| The person who reviewed the interaction (typically an email). Searchable by Team Communicator.
 
|-
 
|-
 
| SentDate
 
| SentDate
| Sent Date
+
| Yes
|  
+
| No
 +
| No
 +
| No
 +
| No
 +
| The date when the outbound email was sent to the destination.
 
|-
 
|-
 
| StartDate
 
| StartDate
| Start Date
+
| Yes
|  
+
| No
 +
| Yes
 +
| Yes
 +
| Yes
 +
| The date when the interaction was created in the Genesys system.
 
|-
 
|-
 
| Status
 
| Status
| Status
+
| Yes
| To be selected among: All, InProgress, Done
+
| No
 +
| Yes
 +
| Yes
 +
| Yes
 +
| The Status of the interaction in Universal Contact Server (UCS): In Progress or Done.
 +
|-
 +
| StructuredText
 +
| Yes
 +
| Yes
 +
| No
 +
| No
 +
| No
 +
| The Transcript of the Chat, SMS Session, or FacebookPrivateMessage session, or the Email Rich Text Content.
 
|-
 
|-
 
| Subject
 
| Subject
| Subject
+
| Yes
|  
+
| Yes
 +
| Yes
 +
| Yes
 +
| Yes
 +
| The Subject of the interaction.
 
|-
 
|-
 
| SubtypeId
 
| SubtypeId
| Interaction Sub-Type
+
| Yes
|
+
| No
 +
| No
 +
| No
 +
| No
 +
| The Sub-Type of the eServices interaction; for example, InboundNew or OutboundReply.
 
|-
 
|-
|Text
+
| Text
| Interaction Text
+
| Yes
| Search in the body of the interaction (email (PlainText or HTML), chat (transcript)).
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The text received from or sent to the contact (typically the email plain-text content).
 
|-
 
|-
 
| TheComment
 
| TheComment
| Notes
+
| Yes
| Contains the note associated with the interaction
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The Notes attached to the interaction by the person who handled it.
 
|-
 
|-
 
| ToAddresses
 
| ToAddresses
| To Address
+
| Yes
|  
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| The email To address.
 
|-
 
|-
 
| TypeId
 
| TypeId
| Interaction Type
+
| Yes
|  
+
| No
 +
| No
 +
| No
 +
| No
 +
| The Type of the eServices interaction; for example, Inbound or Outbound.
 
|-
 
|-
 
|}
 
|}
Line 293: Line 562:
 
Search is case insensitive. TEST, tESt, test, and teST are all considered identical.
 
Search is case insensitive. TEST, tESt, test, and teST are all considered identical.
 
====Phrase Search====
 
====Phrase Search====
Searches are ''Starts With'' searches unless quotation marks are used. When quotation marks are used, Workspace Agent Desktop employs an ''Exact'' search.
+
Searches are ''Starts With'' searches unless quotation marks are used. When quotation marks are used, Agent Workspace employs an ''Exact'' search.
  
 
If an agent encloses a phrase in quotation marks, search results return only matches for the exact phrase.
 
If an agent encloses a phrase in quotation marks, search results return only matches for the exact phrase.
Line 299: Line 568:
 
Without quotation marks around a phrase, each word is searched for independently, and results are returned for all interactions that contain ''all the strings'' that start with the specified words. If not all of the phrase strings are found in an interaction, it will not be included in the search results.
 
Without quotation marks around a phrase, each word is searched for independently, and results are returned for all interactions that contain ''all the strings'' that start with the specified words. If not all of the phrase strings are found in an interaction, it will not be included in the search results.
 
====Custom Attributes====
 
====Custom Attributes====
You can define a search based on custom attributes. Custom attribute search employs an ''Exact Match'' strategy. Workspace Agent Desktop can search on either the Display name or the Attribute name.
+
You can define a search based on custom attributes. Custom attribute search employs an ''Exact Match'' strategy. Agent Workspace can search on either the Display name or the Attribute name.
  
 
To use a custom attribute, in the Interaction Attributes business attribute, define a new business attribute value where:
 
To use a custom attribute, in the Interaction Attributes business attribute, define a new business attribute value where:
Line 330: Line 599:
 
</li>
 
</li>
 
</ol>
 
</ol>
 +
{{AnchorDiv|Related}}
 +
==Enabling the Related interaction tab==
 +
The '''Related''' tab enables agents to access all the interactions that are related to a single conversation. Sometimes multiple interactions are created in the handling of a single case. Multiple individuals, both within and outside your organization, might also contribute to a single conversation.
 +
 +
The '''Related''' tab is displayed in the interaction view. It displays all the interactions related to the current interaction as cards containing information about each related interaction, including custom attributes. You can enable the '''Related''' tab at the cloud cluster, agent group, or agent level by assigning the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use-related-interactions}} privilege.
 +
 +
To enable agents to mark interactions in the '''Related''' tab as '''Done''', assign the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-mark-done-related-interactions}} privilege.
 +
 +
To enable agents to delete interactions by using the '''Related''' tab, assign the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-delete-related-interactions}} privilege.
 +
 +
{{NoteFormat|The '''Related''' tab is currently supported only for email interactions.|1}}
 +
 +
Agents can open single or multiple interactions simultaneously. Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-related-interactions-open-max-number}} option to specify the number of related interactions that may be opened simultaneously.
 +
 +
The '''Related''' tab includes a '''Quick Search''' field that enables agents to search for specific text or other interaction attributes within the related interactions. Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-history-quick-search-attributes}} option to specify which attributes may be searched. The maximum number of search results is 100.
 +
 +
Interaction cards in the '''Related''' tab are sortable. Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-related-interactions-sort-by-attributes}} option to specify which interaction attributes and custom attributes may be used for sorting related interactions.
 +
 +
The '''Related''' tab supports tagging of interaction cards with up to two custom attributes. Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-related-interactions-custom-attributes}} option to specify which two custom attributes to display. If you specify more than two attributes, the others are ignored.
 +
 +
If you have enabled agents to mark interactions as Done from the '''Related''' tab, you can specify the list of attribute values that can be set as disposition codes for the interactions by using the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-related-disposition-value-business-attribute}} option. To specify the key-value pairs that are submitted to the Genesys backend as attached data or a user event, configure the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-related-disposition-key-name}} option.
 +
 +
Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:views-CaseSideRegion-order}} option to specify the position of the '''Related''' tab in the interaction view. To specify that the '''Related''' tab is automatically the active tab, use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:views-CaseSideRegion-activate-order}} option.
 +
{{AnchorDiv|UCSX}}
 +
==Troubleshooting UCSX environments==
 +
In environments using UCSX server, if you experience trouble with the validation of phone numbers on the client side when records are created or updated, set the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-phone-number-validation-enable}} option to <tt>false</tt> to disable phone number validation.
 
[[Category:V:HTCC:9.0.0]]
 
[[Category:V:HTCC:9.0.0]]

Latest revision as of 14:11, September 23, 2022

Enabling agents to manage contacts and interactions

Procedure: Enabling Automatic Contact Lookup

Purpose: To enable Universal Contact Server to lookup and create contacts when a new interaction is routed to an agent or when an agent dials a call.

Prerequisites

  • The GWS Application Server object application object exists in the Configuration Database.
  • The GWS Application Server object application has a connection to Universal Contact Server.

Start

  1. Enable the Workspace features that rely on Universal Contact Server (UCS) for contact lookup when an interaction of the given media type is presented to an agent:
  2. If the value of the contact.lookup.enable (or contact.lookup.<media-type>.enable) options is true, you can use the contact.lookup.auto-assign-mode (or contact.lookup.<media-type>.auto-assign-mode) option to enable contact look up to either assign the first contact that matches the search criteria (for example, the phone number) or to allow an agent to review multiple matches and select the correct match. For example, multiple people could be using the same phone to make calls into your contact center. Each of these contacts has a unique record in UCS that have the same phone number.
    To enable agents to select from a list of multiple contacts that match contact lookup criteria, set the value of the contact.lookup.auto-assign-mode option to false. If the value of the option is false, and multiple contacts match the search criteria, the Suggested Contacts view containing all the contacts that match the search criteria is displayed in the interaction window.
    If the value of the contact.lookup.auto-assign-mode option is true, the first contact that matches the search criteria is assigned to the interaction automatically and the Suggested Contacts view is not displayed.
    Important
    The maximum number of suggested contacts that can be displayed is limited to 50.
  3. If an inbound call is not already assigned to a contact by using a strategy, you can preprocess the inbound phone number prior to performing contact lookup in Universal Contact Server (UCS) to avoid potential duplicate contact creation.
    1. Set the value of the contact.lookup.enable-create-contact option to true.
    2. Remove unsupported characters by using the expression.phone-number.supported-characters option.
    3. Set the value of the contact.lookup.voice.use-formatted-number option to true to specify that the phone number of an inbound voice interaction is subject to processing by the expression.phone-number.supported-characters option prior to contact lookup. This option can be overridden by a routing strategy.
  4. Enable Workspace to create a new contact in UCS if the contact is not found:
  5. Specify which contact attributes an agent must complete when a contact is created by configuring the contact.mandatory-attributes option.
  6. Specify which contact attributes can have more than one value, for example multiple phone numbers, by configuring the contact.multiple-value-attributes option.
  7. To alert agents who try to create a contact that potentially already exists in the UCS contact database, set the value of the contact.create-contact.check-duplicate option to true. If an agent tries to create a contact that potentially matches one or more in the contact database, Workspace displays the list of potential matches, then allows an agent to either create the new contact or select an existing contact instead.
    Use the following options to control what UCS attributes are searched to determine whether a new contact is a potential duplicate. These options can be configured individually or together to allow "AND" and "OR" searches.
  8. To enable Contact Search, follow the Enabling the Interactions Search view procedure.

End

Triggering contact look-up and populating History

Interactions can be assigned to a contact in the contact database automatically or manually. Automatic assignment is handled by contact look-up when an inbound interaction is received.

Use the following configurations to specify how automatic contact assignment and creation is handled.

Automatic contact look-up and interaction storage

Workspace can be configured to automatically assign a new inbound interaction to an existing contact in the contact database, or to create a new contact if the contact is not found. This behavior can be specified for all channels or for individual channels. To enable this capability, configure the following options:

  • contact.lookup.enable: Specifies that the Universal Contact Server (UCS) identify service is to be used for contact lookup.
  • contact.lookup.enable-create-contact: Specifies that the Universal Contact Server (UCS) creates a contact service to be used if the identify service fails to find the contact.
  • contact.lookup.auto-assign-mode: When there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches that he or she can manually choose the contact.
  • contact.lookup.<media-type>.enable: Activates the Workspace features that rely on the Universal Contact Server (UCS) IdentifyService for contact lookup when an interaction is presented to the Agent.
  • contact.lookup.<media-type>.auto-assign-mode: For the specified media type, when there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches that he or she can manually choose the contact.
  • contact.lookup.<media-type>.enable-create-contact: 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.
  • contact.ucs-interaction.<media-type>.enable-create: 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>.

Directly dialed calls

If you want to record calls in your Contact Database that were directly dialed by agents so the the calls can be tracked in the agent's history, ensure that the following two options are set to true:

To enable agents to manually create a contact when they have an active interaction, set the value of the contact.lookup.enable-create-contact option to true.

Improving automatic contact assignment

If you implement the default contact look-up configuration, Workspace selects the first contact from the list of matching contacts returned by UCS, based on interaction attributes. However, if more than one contact matches the information available for a new inbound interaction, the subsequent matches are not considered. To improve automatic contact assignment when multiple matches are found, use the following configuration options to enable agents to choose a contact from the list of matches returned by UCS:

  • contact.lookup.auto-assign-mode: When there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches from which he or she can manually choose the contact.
  • contact.lookup.<media-type>.auto-assign-mode: For the specified media type, when there are multiple contact matches, specify whether the first found contact is assigned automatically (default behavior) or the agent is presented with a list of matches from which he or she can manually choose the contact.
Example: Preventing automatic contact creation in case of no UCS match and automatic contact assignment in case of multiple UCS matches

This example is for the voice channel, but it can be applied to all channels or to other specific channels. Normally, if there is a single contact in the Universal Contact Server (UCS) database, Workspace automatically assigns the contact. In these scenarios:

  • If you want to enable your agents to assign a contact to an interaction based on a look-up in the UCS database in scenarios where no match is found for the inbound interaction, but you do not want a new contact to be created automatically without your agent searching the contact database first,
  • If you want to enable an agent to review the possible contact matches and choose the appropriate one in scenarios where there are multiple contacts that match an incoming interaction,
Use the following configuration:

Contact Management: Last Routed Agent

The Last Routed Agent Feature enables you to save in the Contact Profile, information about the last agent who handled interactions from that contact. The agent handling information can then be used during the routing of subsequent interactions from this contact. When an agent actively handles an interaction of a given media type from a contact, the following keys are set in the Contact Profile:

  • LastCalledAgent_EmployeeID
  • LastCalledAgent_TimeStamp
  • LCA_EmplID_<MediaType>
  • LCA_TimeStamp_<MediaType>

Where <MediaType> corresponds to the media of the interaction.

Refer to the eServices and Routing documentation for more information about this feature.

You can activate this option globally by setting to true the contact.last-called-agent.enable option in the Contact section. Or you can activate it by media type by setting the contact.last-called-agent.<media-type>.enable option to true in the Contact section.

Disabling Automatic Contact Look-up

To disable automatic contact lookup and contact creation when Genesys handles a new interaction, configure these options with the following values:

Overriding Contact Look-up

You can override automatic contact look-up and contact creation by including the IdentifyCreateContact option in the interaction attached data. If present, this option overrides the following contact look-up options. Refer to the Supported value for the IdentifyCreateContact option table to see how different values for the IdentifyCreateContact option override contact look-up and creation:

Supported value for the IdentifyCreateContact option
Value Override
1
  • Disable contact lookup (overrides contact.lookup.enable = true and contact.lookup.<media-type>.enable = true)
  • Disable contact creation on unsuccessful lookup (overrides contact.lookup.enable-create-contact = true and contact.lookup.<media-type>.enable-create-contact = true)
2
  • Enables contact lookup (overrides contact.lookup.enable = false and contact.lookup.<media-type>.enable = false)
  • Disable contact creation on unsuccessful lookup (overrides contact.lookup.enable-create-contact = true and contact.lookup.<media-type>.enable-create-contact = true)
3
  • Enables contact lookup (overrides contact.lookup.enable = false and contact.lookup.<media-type>.enable = false)
  • Enables contact creation on unsuccessful lookup (overrides contact.lookup.enable-create-contact = false and contact.lookup.<media-type>.enable-create-contact = false)
Any other value or an invalid value. The options are not overridden.

Procedure: Enabling agents to handle voice interactions without an assigned contact

Purpose: To create voice interactions in the Universal Contact Server (UCS) database without an associated contactId. This feature also enables the Note view for interactions without an assigned contact.

By default, Workspace does not create a voice interaction in the UCS database if a contactId is not assigned to a voice call. An interaction might not have an assigned ContactId if the contact lookup request returns no matching contact and the agent does not assign a contact to the interaction. In some environments, agent configuration might prevent the association of a contactId with an interaction. For example:

  • The value of contact.lookup.voice.enable is false. In this scenario, contact lookup is not performed and no contactId is assigned.
  • The value of contact.lookup.voice.enable is true, but the value of contact.lookup.voice.enable-create-contact is set to false. In this scenario, contact lookup is performed, but when no matching contact is found, the interaction history is not created in the UCS database.
  • The value of privilege.contact.can-use-assign-contact is set to false. In this scenario, when a contactId cannot be assigned automatically to a voice interaction, it is not possible for the agent to manually create a contact or assign an interaction to a known contact.

Prerequisites

  • A working knowledge of Genesys Administrator Extension.
  • Procedure: Enabling agents to manage contacts

Start

  1. Configure the value of the contact.ucs-interaction.voice.enable-create-without-contact option to true.
  2. Configure the value of the contact.ucs-interaction.voice-campaign.create-without-contact option to true to enable this feature for Outbound campaigns.

End

Procedure: Enabling the Contact Directory, Contact History, and My History

Purpose: To enable an agent to use the Contact Directory, Contact History, and My History views.

This functionality enables agents to search the contact data base, create new contacts, and delete existing contacts.

The Contact Directory supports one view, a grid.

Prerequisites

  • The GWS Application Server object application object exists in the Configuration Database.
  • The GWS Application Server object application has a connection to Universal Contact Server.
  • The GWS Application Server object application has a connection to Interaction Server.
  • The agent object is configured to use one or more of the following media channels:

Start

  1. Enable an index search on contacts to enable searches on contact interactions. For more information about enabling index searches, refer to the eServices Administrator's Guide.
  2. To search on custom interaction attributes (such as searching on an attached data attribute of an interaction), in Genesys Administrator, create or update a Business Attribute in the tenant that contain(s) your agents.
    • The Type of the Business Attribute is Interaction Operation Attributes.
    • The Attribute values are the codes that are available for the agent:
      • name—Used in attached data.
      • annex—Used in the Agent interface. Include a settings section with these options:
        • is-sortable = true
        • is-searchable = true
  3. Grant the Contact - Can Use privilege: privilege.contact.can-use
  4. To create interactions in Universal Contact Server (UCS), configure the following Interaction options in the interaction-workspace section of the GWS Application Server object object:
  5. For the Contact Directory view, grant the following privileges:

    then configure the Contact options in the interaction-workspace section:

  6. For the Contact History view, grant the following privileges:

    then configure the Contact options in the interaction-workspace section:

  7. To enable the display of chat transcripts for Open Media channels that are handled as chat interactions, such as Facebook public and Twitter public, configure the openmedia.chat-history-channels in the workspace-service section.
  8. Enable Contact History search. You can enable basic and advanced searching in the History view in the Contact Directory and in the Interaction window for agents in your contact center and configure which advanced search options are displayed in the Agent Workspace. With advanced searching enabled, agents can search contact history by date range, interaction type, and specific default and custom attributes. The search returns a maximum of 100 results.
    1. Activate the basic search privilege. See privilege.contact.can-search-contact-history.
    2. Enable advanced searching. See privilege.contact.can-advanced-search-contact-history.
    3. Enable the filtering of interactions in the Contact History view. See privilege.contact.can-filter-contact-history.
    4. Define the list of attributes displayed on the Advanced Search window. See contact.history-search-attributes.
    5. Define the list of date search options on the Advanced Search window. See contact.date-search-types.
    6. Specify which interaction types (channels) are included in the Contact History view list of interactions. See contact.history.media-filters.
  9. For the My History view, grant the following privileges:

    then configure the Contact options in the interaction-workspace section:

  10. Enable My History Search. You can enable basic and advanced searching in the My History tab in the Connect group for agents in your contact center and specify which advanced search options are displayed in Agent Workspace. With advanced searching enabled, agents can search their own interaction history by date range, interaction type, and specific default and custom attributes. The search returns a maximum of 100 results.
    1. Activate the basic search privilege. See privilege.contact.can-search-my-history.
    2. Enable advanced searching. See privilege.contact.can-advanced-search-my-history.
    3. Enable the filtering of interactions in the My History view. See privilege.contact.can-filter-my-history.
    4. Enable chronological filtering by configuring the contact.myhistory-default-time-filter-main option.
    5. Specify which attribute columns are displayed in the My History view by configuring the contact.myhistory-displayed-columns option.
    6. Specify the interaction attributes that are used to search interactions in the quick search mode of the My History view by configuring the contact.myhistory-quick-search-attributes option.
    7. Specify the maximum number of words that can be used for a quick search phrase by configuring the contact.history.quick-search.max-input-length option. Genesys recommends using the default value of 10 to avoid impact on your system resources.
    8. Define the list of attributes displayed on the Advanced Search window. See contact.history-search-attributes.
    9. Define the list of date search options on the Advanced Search window. See contact.date-search-types.
    10. Specify which interaction types (channels) are included in the My History view list of interactions. See contact.history.media-filters.
  11. Enable Click to dial and click to search. Agents can be enabled to make calls or to open the contact information in the Contact Directory from the Details tab of a History view.
    1. privilege.voice-history.can-click-to-dial: Enables an agent to use Click-to-dial a voice call from the Details tab of the history of a voice interaction in any History view.
    2. privilege.voice-history.can-click-to-search: Enables an agent to use Click-to-search to open the Contact Directory by clicking a Contact name in the Details tab of the My History or Interaction Search views.

End

Procedure: Enabling Last Routed Agent

Purpose: To enable the last routed agent feature, which saves information about the last agent who handled interactions from that contact in the Contact Profile. That information can then be used during the routing of subsequent interactions from this contact. When an agent actively handles an interaction of a given media type from a contact, the following keys are set in the Contact Profile:

  • LastCalledAgent_EmployeeID
  • LastCalledAgent_TimeStamp
  • LCA_EmplID_<MediaType>
  • LCA_TimeStamp_<MediaType>

Where <MediaType> corresponds to the media of the interaction.

Refer to the eServices and Routing documentation for more information about this feature.

Start

  1. You can activate this feature by setting the following options in the interaction-workspace section:

End

Procedure: Enabling the Interactions Search view

In Agent Workspace you can enable the Interactions Search view. When enabled, agents can select the Interactions Search tab from theConnect group and then use a variety of advanced search controls to locate the interactions that they want to view. The search returns a maximum of 100 results.

Start

  1. Activate the Interaction Search view. See privilege.contact.can-search-all-interactions.
  2. Enable advanced searching. See privilege.contact.can-advanced-search-all-interactions.
  3. Enable the filtering of interactions. See privilege.contact.can-filter-all-interactions.
  4. Define the list of attributes that the agent can select in the Quick Search view. See contact.all-interactions-quick-search-attributes.
  5. Specify the maximum number of words that can be used for a quick search phrase by configuring the contact.history.quick-search.max-input-length option. Genesys recommends using the default value of 10 to avoid impact on your system resources.
  6. Define the list of attributes that the agent can select in the Advanced Search view. See contact.history-search-attributes.
  7. Define the list of search types that the agent can use to define a date range for the search. See contact.date-search-types.
  8. Define the columns displayed in the returned search results. See contact.all-interactions-displayed-columns.
  9. Specify which interaction types (channels) are included in the Interaction Search view list of interactions. See contact.history.media-filters.
  10. Enable agents to open interactions from the History and control which interactions can be opened. Refer to Granting basic Interaction History privileges.

End

Advanced Search

The following table summarizes the attributes that you can use to configure Quick Search and Advanced Search of the Contact History, My History, and Interactions Search views. System and custom attributes are supported as noted.

  • System date attributes: On, OnOrAfter, Before, and Between search types are configured by using the contact.date-search-types option.
  • System text attributes: These can be searched by using the Matches search type which, for each word typed into the query, returns at least one word that starts with this word. Text search does not support queries containing double quotes. Interaction Search enables agents to search for the content of email and chat interactions. Content for these interactions is stored in Text and/or StructuredText attributes. Text includes the content of the plain-text email interactions. StructuredText includes the content of HTML-formatted email interactions and chat transcripts, as well as SMS interactions handled in session mode and Facebook Private Message sessions.
  • Custom History Search Attributes: A custom interaction search attribute is an interaction attribute that is not part of the default Genesys UCS data design. A custom interaction search attribute is typically defined during the Business Process design and is implemented by the addition of key-value pairs to the attached data of the interactions which are then stored in UCS.
    Configure Workspace to use custom interaction search attributes as search criteria for both the quick search and advanced search modes of the Interaction Search, Contact History, and My History views. Use the following options:
    Limitation: JOINT searches of the interaction list with the contact list are not possible unless you create a business process that copies attributes from the contact records into the corresponding interaction records.


Interaction History Search System Attributes
Attribute Name Advanced Search Quick Search Contact/My History (grid) Contact/My History (tree) All Interactions Search (grid) Description
CcAddresses Yes Yes No No No The email Cc address.
ContactId Yes No Yes Yes Yes The Contact of the interaction. Searchable by Team Communicator.
EndDate Yes No Yes Yes Yes The date when the interaction was marked completed in the Genesys system.
EstablishedDate Yes No No No No The date when the Chat session was established.
FromAddress Yes Yes Yes Yes Yes The email From address.
FromPersonal Yes Yes No No No The Personal Part of the email From address.
Id Yes Yes No No No The unique ID of the Interaction.
Mailbox Yes Yes No No No The Mailbox from which the email was received.
OwnerId Yes No Yes Yes Yes The person who processed the interaction. Searchable by Team Communicator.
PhoneNumber Yes Yes No No No The Phone Number from which the contact called or was used to call the contact.
ReleasedDate Yes No No No No The date when the Chat session was ended.
ReplyToAddress No No No No No The email Reply-To address.
ReviewerId No No No No No The person who reviewed the interaction (typically an email). Searchable by Team Communicator.
SentDate Yes No No No No The date when the outbound email was sent to the destination.
StartDate Yes No Yes Yes Yes The date when the interaction was created in the Genesys system.
Status Yes No Yes Yes Yes The Status of the interaction in Universal Contact Server (UCS): In Progress or Done.
StructuredText Yes Yes No No No The Transcript of the Chat, SMS Session, or FacebookPrivateMessage session, or the Email Rich Text Content.
Subject Yes Yes Yes Yes Yes The Subject of the interaction.
SubtypeId Yes No No No No The Sub-Type of the eServices interaction; for example, InboundNew or OutboundReply.
Text Yes Yes No No No The text received from or sent to the contact (typically the email plain-text content).
TheComment Yes Yes No No No The Notes attached to the interaction by the person who handled it.
ToAddresses Yes Yes No No No The email To address.
TypeId Yes No No No No The Type of the eServices interaction; for example, Inbound or Outbound.

Case Sensitivity

Search is case insensitive. TEST, tESt, test, and teST are all considered identical.

Phrase Search

Searches are Starts With searches unless quotation marks are used. When quotation marks are used, Agent Workspace employs an Exact search.

If an agent encloses a phrase in quotation marks, search results return only matches for the exact phrase.

Without quotation marks around a phrase, each word is searched for independently, and results are returned for all interactions that contain all the strings that start with the specified words. If not all of the phrase strings are found in an interaction, it will not be included in the search results.

Custom Attributes

You can define a search based on custom attributes. Custom attribute search employs an Exact Match strategy. Agent Workspace can search on either the Display name or the Attribute name.

To use a custom attribute, in the Interaction Attributes business attribute, define a new business attribute value where:

  • Name = <Name of the custom attribute>
  • Display Name = The name displayed in Workspace

Custom Attribute searches can either be presented as a text field where the agent must enter the exact search string to find a match, or you can configure Workspace to display a drop-down menu of search options so that agents do not have to type in the display name.

To do this:

  1. Define a business attribute with a name = <Name of the custom attribute> (for example, "hobby") that corresponds to an Interaction Attribute value
  2. Assign as the business attribute values the list of options and display names that will be displayed in the combo box for that attribute. For example:
    • Name = Baseball
      Display Name = Baseball
    • Name = Books
      Display Name = Books
    • Name = Cinema
      Display Name = Cinema
    • Name = DIY
      Display Name = Do It Yourself
    • Name = Sailing
      Display Name = Sailing
    • Name = Sports
      Display Name = Sports

Enabling the Related interaction tab

The Related tab enables agents to access all the interactions that are related to a single conversation. Sometimes multiple interactions are created in the handling of a single case. Multiple individuals, both within and outside your organization, might also contribute to a single conversation.

The Related tab is displayed in the interaction view. It displays all the interactions related to the current interaction as cards containing information about each related interaction, including custom attributes. You can enable the Related tab at the cloud cluster, agent group, or agent level by assigning the privilege.contact.can-use-related-interactions privilege.

To enable agents to mark interactions in the Related tab as Done, assign the privilege.contact.can-mark-done-related-interactions privilege.

To enable agents to delete interactions by using the Related tab, assign the privilege.contact.can-delete-related-interactions privilege.

Important
The Related tab is currently supported only for email interactions.

Agents can open single or multiple interactions simultaneously. Use the contact.related-interactions.open.max-number option to specify the number of related interactions that may be opened simultaneously.

The Related tab includes a Quick Search field that enables agents to search for specific text or other interaction attributes within the related interactions. Use the contact.history-quick-search-attributes option to specify which attributes may be searched. The maximum number of search results is 100.

Interaction cards in the Related tab are sortable. Use the contact.related-interactions.sort-by.attributes option to specify which interaction attributes and custom attributes may be used for sorting related interactions.

The Related tab supports tagging of interaction cards with up to two custom attributes. Use the contact.related-interactions.custom-attributes option to specify which two custom attributes to display. If you specify more than two attributes, the others are ignored.

If you have enabled agents to mark interactions as Done from the Related tab, you can specify the list of attribute values that can be set as disposition codes for the interactions by using the interaction.related.disposition.value-business-attribute option. To specify the key-value pairs that are submitted to the Genesys backend as attached data or a user event, configure the interaction.related.disposition.key-name option.

Use the views.CaseSideRegion.order option to specify the position of the Related tab in the interaction view. To specify that the Related tab is automatically the active tab, use the views.CaseSideRegion.activate-order option.

Troubleshooting UCSX environments

In environments using UCSX server, if you experience trouble with the validation of phone numbers on the client side when records are created or updated, set the value of the contact.phone-number-validation.enable option to false to disable phone number validation.

This page was last edited on September 23, 2022, at 14:11.
Comments or questions about this documentation? Contact us for support!