Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
Line 4: Line 4:
  
 
====contact.available-directory-page-sizes====
 
====contact.available-directory-page-sizes====
* Default Value: 5,10,25,50
+
* Default Value: <tt>5,10,25,50</tt>
 
* Valid Values: A comma-separated list of numbers that define the number of rows per result page from which the agent can make selections.
 
* Valid Values: A comma-separated list of numbers that define the number of rows per result page from which the agent can make selections.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
Line 10: Line 10:
  
 
====contact.cache-timeout-delay====
 
====contact.cache-timeout-delay====
* Default Value: 600
+
* Default Value: <tt>600</tt>
* Valid Values: An integer from 1 through 3600.
+
* Valid Values: An integer from <tt>1</tt> through <tt>3600</tt>.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
 
* Description: Specifies the delay, in seconds, before the cache of the result of a Universal Contact Server request is cleared.
 
* Description: Specifies the delay, in seconds, before the cache of the result of a Universal Contact Server request is cleared.
  
 
====contact.default-directory-page-size====
 
====contact.default-directory-page-size====
* Default Value: 10
+
* Default Value: <tt>10</tt>
* Valid Values: An integer from 1 through 50.
+
* Valid Values: An integer from <tt>1</tt> through <tt>50</tt>.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
 
* Description: 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 <tt>contact.available-directory-page-size</tt>.
 
* Description: 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 <tt>contact.available-directory-page-size</tt>.
  
 
====contact.directory-default-mode====
 
====contact.directory-default-mode====
* Default Value: ListView
+
* Default Value: <tt>ListView</tt>
* Valid Values: ListView, GridView
+
* Valid Values: <tt>ListView</tt>, <tt>GridView</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
* Description: Specifies which view of the Contact Directory is displayed by default. ListView: Quicker search performance and tokenized search items, but no sort on the result. GridView: Results are sortable result, but the search is less powerful, and the search items are non-tokenized.
+
* Description: Specifies which view of the Contact Directory is displayed by default.
 +
** ListView: Quicker search performance and tokenized search items, but no sort on the result.  
 +
** GridView: Results are sortable result, but the search is less powerful, and the search items are non-tokenized.
  
 
====contact.directory-displayed-columns====
 
====contact.directory-displayed-columns====
* Default Value: LastName,FirstName,PhoneNumber,EmailAddress
+
* Default Value: <tt>LastName,FirstName,PhoneNumber,EmailAddress</tt>
* Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names -- for example: LastName,FirstName,PhoneNumber,EmailAddress.
+
* Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.
 +
For example: <tt>LastName,FirstName,PhoneNumber,EmailAddress</tt>.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
 
* Description: The list of contact fields that are displayed when the results of a contact search are displayed.
 
* Description: The list of contact fields that are displayed when the results of a contact search are displayed.
  
 
====contact.directory-search-attributes====
 
====contact.directory-search-attributes====
* Default Value: LastName,FirstName,PhoneNumber,EmailAddress
+
* Default Value: <tt>LastName,FirstName,PhoneNumber,EmailAddress</tt>
 
* Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names that can be used as search parameters.
 
* 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: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
Line 40: Line 43:
  
 
====contact.displayed-attributes====
 
====contact.displayed-attributes====
* Default Value: Title,FirstName,LastName,PhoneNumber,EmailAddress
+
* Default Value: <tt>Title,FirstName,LastName,PhoneNumber,EmailAddress</tt>
 
* Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.
 
* Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
 
* Description: The list of contact fields that are displayed when a Contact record is displayed.
 
* Description: The list of contact fields that are displayed when a Contact record is displayed.
 +
 +
====contact.lookup.enable====
 +
* Default Value: <tt>true</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Description: Activates ''Universal Contact Server'' (UCS) lookup for contacts when an interaction is presented to an Agent. This option can be overridden by a routing strategy, as described in [[OverridingInteractionWorkspaceOptions|Overriding Options by Using a Routing Strategy]].
 +
{{NoteFormat|This option is overridden by the attached data <tt>IdentifyCreateContac</tt>t and the option contact.lookup.<media-type>.enable}}
 +
 +
====contact.lookup.enable-create-contact====
 +
* Default Value: <tt>true</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Description: When this option is <tt>true</tt> and [[Contact#contact.lookup.enable|contact.lookup.enable]] is set to <tt>true</tt>, the ''Universal Contact Server'' (UCS) will create 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 [[OverridingInteractionWorkspaceOptions|Overriding Options by Using a Routing Strategy]].
 +
{{NoteFormat|This option is overridden by the attached data <tt>IdentifyCreateContact</tt> and the [[Contact#contact.lookup..3Cmedia-type.3E.enable-create-contact|contact.lookup.<media-type>.enable-create-contact]] option.}}
 +
 +
====contact.lookup.<media-type>.enable====
 +
* Default Value: <tt>true</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Description: Activates ''Universal Contact Server'' (UCS) lookup for contacts when an interaction is presented to an Agent. This option can be overridden by a routing strategy, as described in [[OverridingInteractionWorkspaceOptions|Overriding Options by Using a Routing Strategy]].
 +
{{NoteFormat|This option overwrites the [[Contact#contact.lookup.enable|contact.lookup.enable]] option. It is not taken into account when the attached data <tt>IdentifyCreateContact</tt> is set in the interaction.}}
 +
 +
====contact.lookup.<media-type>.enable-create-contact====
 +
* Default Value: <tt>true</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Description: When this option is <tt>true</tt>, the ''Universal Contact Server'' (UCS) will create 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 [[OverridingInteractionWorkspaceOptions|Overriding Options by Using a Routing Strategy]].
 +
{{NoteFormat|This option overwrites the [[Contact#contact.lookup.enable-create-contact|contact.lookup.enable-create-contact]] option. It is not taken into account when the attached data <tt>IdentifyCreateContact</tt> is set in the interaction.}}
  
 
====contact.mandatory-attributes====
 
====contact.mandatory-attributes====
* Default Value: FirstName,LastName
+
* Default Value: <tt>FirstName,LastName</tt>
* Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names--for example: LastName,FirstName,PhoneNumber,EmailAddress.
+
* Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names--for example: <tt>LastName,FirstName,PhoneNumber,EmailAddress</tt>.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
 
* Description: Specifies the list of Contact fields that must be completed for a contact.
 
* Description: Specifies the list of Contact fields that must be completed for a contact.
  
 
====contact.multiple-value-attributes====
 
====contact.multiple-value-attributes====
* Default Value: PhoneNumber,EmailAddress
+
* Default Value: <tt>PhoneNumber,EmailAddress</tt>
 
* Valid Values: A comma separated value list of Attribute Value names that correspond to contact field names.
 
* Valid Values: A comma separated value list of Attribute Value names that correspond to contact field names.
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.

Revision as of 18:05, October 17, 2014

Contact

Workspace Web Edition provides the following options for managing Contacts:

contact.available-directory-page-sizes

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

contact.cache-timeout-delay

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

contact.default-directory-page-size

  • Default Value: 10
  • Valid Values: An integer from 1 through 50.
  • Changes take effect: When the session is started or restarted.
  • Description: 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.directory-default-mode

  • Default Value: ListView
  • Valid Values: ListView, GridView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies which view of the Contact Directory is displayed by default.
    • ListView: Quicker search performance and tokenized search items, but no sort on the result.
    • GridView: Results are sortable result, but the search is less powerful, and the search items are non-tokenized.

contact.directory-displayed-columns

  • Default Value: LastName,FirstName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.

For example: LastName,FirstName,PhoneNumber,EmailAddress.

  • Changes take effect: When the session is started or restarted.
  • Description: The list of contact fields that are displayed when the results of a contact search are displayed.

contact.directory-search-attributes

  • 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: When the session is started or restarted.
  • Description: The list of Contact fields that can be used as search parameters.

contact.displayed-attributes

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

contact.lookup.enable

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

contact.lookup.enable-create-contact

  • Default Value: true
  • Valid Values: true, false
  • Description: When this option is true and contact.lookup.enable is set to true, the Universal Contact Server (UCS) will create 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 Overriding Options by Using a Routing Strategy.
Important
This option is overridden by the attached data IdentifyCreateContact and the contact.lookup.<media-type>.enable-create-contact option.

contact.lookup.<media-type>.enable

  • Default Value: true
  • Valid Values: true, false
  • Description: Activates Universal Contact Server (UCS) lookup for contacts when an interaction is presented to an Agent. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.
Important
This option overwrites the contact.lookup.enable option. It is not taken into account when the attached data IdentifyCreateContact is set in the interaction.

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

  • Default Value: true
  • Valid Values: true, false
  • Description: When this option is true, the Universal Contact Server (UCS) will create 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 Overriding Options by Using a Routing Strategy.
Important
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.

contact.mandatory-attributes

  • 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: When the session is started or restarted.
  • Description: Specifies the list of Contact fields that must be completed for a contact.

contact.multiple-value-attributes

  • Default Value: PhoneNumber,EmailAddress
  • Valid Values: A comma separated value list of Attribute Value names that correspond to contact field names.
  • Changes take effect: When the session is started or restarted.
  • Description: A list of contact attributes that can support multiple values.
Comments or questions about this documentation? Contact us for support!