Jump to: navigation, search

interaction.web-content

Section: interaction-workspace
Default Value:
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: When the session is started or restarted.


Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to the Enabling integration of web applications in the agent interface for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

interaction.web-content

Section: interaction-workspace
Default Value:
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: When the session is started or restarted.


Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to the Enabling integration of web applications in the agent interface for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

interaction.web-content

Section: interaction-workspace
Default Value:
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: When the session is started or restarted.


Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to the Enabling integration of web applications in the agent interface for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

interaction.web-content

Section: interaction-workspace
Default Value:
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: When the session is started or restarted.


Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to the Enabling integration of web applications in the agent interface for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

interaction.web-content

Section: interaction-workspace
Default Value:
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: When the session is started or restarted.


Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to the Enabling integration of web applications in the agent interface for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
−
= Configuring Views=
+
= Configuring the User Interface=
−
You can set the Workspace [[Views|Views]] options to configure the sorting order and the default tab selection of tabbed views within each window.
+
You can set the Workspace Views options to configure the sorting order and the default tab selection of tabbed views within each window.
  
−
The sort order can be customized by using the <tt>views.<RegionName>.order</tt> options.  
+
The sort order can be customized by using the <tt>views.<RegionName>.order</tt> options.
  
 
The default tab selection can be configured by using the <tt>views.<RegionName>.activate-order</tt> options.
 
The default tab selection can be configured by using the <tt>views.<RegionName>.activate-order</tt> options.
 
The first in the list, if present, is selected by default. If the first in the list is absent, the second in the list is presented by default, and so on. Both options support out-of-the-box view names and names of custom views added to tab areas.
 
The first in the list, if present, is selected by default. If the first in the list is absent, the second in the list is presented by default, and so on. Both options support out-of-the-box view names and names of custom views added to tab areas.
 +
 +
Workspace Web Edition provides the following options to configure the default tab and tab display order in regions where there are multiple tabs:
 +
__TOC__
 +
====views.CaseSideRegion.activate-order====
 +
*Default Value: <tt>ContactView,SRLView,KnowledgeView,CoBrowseView,WebActivityView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:interaction-web-content}} option): <tt>ContactView,SRLView,KnowledgeView,CoBrowseView,WebActivityView,...</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: 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====
 +
*Default Value: <tt>KnowledgeView,CoBrowseView,WebActivityView,ContactView,SRLView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:interaction-web-content}} option): <tt>KnowledgeView,CoBrowseView,WebActivityView,ContactView,SRLView,...</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: 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.
 +
 +
====views.ContactRegion.activate-order====
 +
*Default Value: <tt>ContactInformationView,ContactHistoryView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list: <tt>ContactInformationView,ContactHistoryView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies, in order of precedence, the view selected by default view in the Contact 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.ContactRegion.order====
 +
*Default Value: <tt>ContactInformationView,ContactHistoryView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list: <tt>ContactInformationView,ContactHistoryView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the Contact 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.
 +
 +
====views.HistoryInteractionDetailsRegion.activate-order====
 +
*Default Value: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies, in order of precedence, the view selected by default view in the History Interaction Details 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.HistoryInteractionDetailsRegion.order====
 +
*Default Value: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the History Interaction Details 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.
 +
 +
====views.InteractionDetailsRegion.activate-order====
 +
*Default Value: <tt>ContactInteractionNotePadView,DispositionView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list: <tt>ContactInteractionNotePadView,DispositionView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies, in order of precedence, the view selected by default view in the Interaction Details 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.InteractionDetailsRegion.order====
 +
*Default Value: <tt>DispositionView,ContactInteractionNotePadView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list: <tt>DispositionView,ContactInteractionNotePadView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the Interaction Details 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.
 +
 +
====views.MyWorkspaceRegion.activate-order====
 +
*Default Value: <tt>MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:interaction-web-content}} option): <tt>MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView,...</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies, in order of precedence, the view selected by default view in the My Workspace 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.MyWorkspaceRegion.order====
 +
* Default Value: <tt>MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView</tt>
 +
* Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:interaction-web-content}} option): <tt>MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView,...</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the My Workspace 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.
 +
 +
====views.WorkbinInteractionDetailsRegion.activate-order====
 +
*Default Value: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies, in order of precedence, the view selected by default view in the Workbin Interaction Details 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.WorkbinInteractionDetailsRegion.order====
 +
*Default Value: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Valid Values: A comma-separated list of valid view names from the following list: <tt>ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView</tt>
 +
*Changes take effect: When the session is started or restarted.
 +
*Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the Workbin Interaction Details 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.
 +
 +
 +
  
 
For custom views, use the section names specified in the {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:interaction-web-content}} option.
 
For custom views, use the section names specified in the {{Optionslink|link=Options:Web_Services_and_Applications:interaction-workspace:interaction-web-content}} option.
 +
 +
==Rebranding==
 +
Workspace Web Edition provides the following options for rebranding:
 +
__TOC__
 +
 +
====rebranding.company-logo====
 +
* Default Value:
 +
* Valid Values: A valid URL
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the URL of the company logo to be displayed at the right top corner of the application. The maximum size for the logo is 100 x 24 pixels.
 +
 +
====rebranding.login.company-logo====
 +
* Default Value:
 +
* Valid Values: A valid URL
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the URL of the company logo used on the '''Login''' page. The maximum size for the logo is 320 x 32 pixels.
 +
 +
====rebranding.about.company-logo====
 +
* Default Value:
 +
* Valid Values: A valid URL
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the URL of the company logo used in the '''About''' page. The maximum size for the logo is 320 x 32 pixels.
 +
 +
====rebranding.product-major-name====
 +
* Default Value:
 +
* Valid Values: A valid string
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the major name of the product.
 +
 +
====rebranding.product-minor-name====
 +
* Default Value:
 +
* Valid Values: A valid string
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the minor name of the product.
 +
 +
====rebranding.product-version====
 +
* Default Value:
 +
* Valid Values: A valid string
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the product version.
 +
 +
====rebranding.company-favicon====
 +
* Default Value:
 +
* Valid Values: A valid URL
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the favicon used for the address bar or in tab related to Workspace Web Edition. The maximum size for the favicon is 100 x 24 pixels.
  
 
[[Category:V:HTCC:9.0.0DRAFT]]
 
[[Category:V:HTCC:9.0.0DRAFT]]

Revision as of 19:46, December 31, 2018

Configuring the User Interface

You can set the Workspace Views options to configure the sorting order and the default tab selection of tabbed views within each window.

The sort order can be customized by using the views.<RegionName>.order options.

The default tab selection can be configured by using the views.<RegionName>.activate-order options. The first in the list, if present, is selected by default. If the first in the list is absent, the second in the list is presented by default, and so on. Both options support out-of-the-box view names and names of custom views added to tab areas.

Workspace Web Edition provides the following options to configure the default tab and tab display order in regions where there are multiple tabs:

views.CaseSideRegion.activate-order

  • Default Value: ContactView,SRLView,KnowledgeView,CoBrowseView,WebActivityView
  • Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the interaction.web-content option): ContactView,SRLView,KnowledgeView,CoBrowseView,WebActivityView,...
  • Changes take effect: When the session is started or restarted.
  • Description: 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

  • Default Value: KnowledgeView,CoBrowseView,WebActivityView,ContactView,SRLView
  • Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the interaction.web-content option): KnowledgeView,CoBrowseView,WebActivityView,ContactView,SRLView,...
  • Changes take effect: When the session is started or restarted.
  • Description: 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.

views.ContactRegion.activate-order

  • Default Value: ContactInformationView,ContactHistoryView
  • Valid Values: A comma-separated list of valid view names from the following list: ContactInformationView,ContactHistoryView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies, in order of precedence, the view selected by default view in the Contact 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.ContactRegion.order

  • Default Value: ContactInformationView,ContactHistoryView
  • Valid Values: A comma-separated list of valid view names from the following list: ContactInformationView,ContactHistoryView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the Contact 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.

views.HistoryInteractionDetailsRegion.activate-order

  • Default Value: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Valid Values: A comma-separated list of valid view names from the following list: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies, in order of precedence, the view selected by default view in the History Interaction Details 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.HistoryInteractionDetailsRegion.order

  • Default Value: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the History Interaction Details 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.

views.InteractionDetailsRegion.activate-order

  • Default Value: ContactInteractionNotePadView,DispositionView
  • Valid Values: A comma-separated list of valid view names from the following list: ContactInteractionNotePadView,DispositionView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies, in order of precedence, the view selected by default view in the Interaction Details 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.InteractionDetailsRegion.order

  • Default Value: DispositionView,ContactInteractionNotePadView
  • Valid Values: A comma-separated list of valid view names from the following list: DispositionView,ContactInteractionNotePadView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the Interaction Details 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.

views.MyWorkspaceRegion.activate-order

  • Default Value: MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView
  • Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the interaction.web-content option): MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView,...
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies, in order of precedence, the view selected by default view in the My Workspace 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.MyWorkspaceRegion.order

  • Default Value: MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView
  • Valid Values: A comma-separated list of valid view names from the following list (plus the custom views specified with the section names in the interaction.web-content option): MyChannelsView,MyCampaignsView,MyHistoryView,CustomMyStatReportView,CustomCcReportView,...
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the My Workspace 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.

views.WorkbinInteractionDetailsRegion.activate-order

  • Default Value: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Valid Values: A comma-separated list of valid view names from the following list: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies, in order of precedence, the view selected by default view in the Workbin Interaction Details 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.WorkbinInteractionDetailsRegion.order

  • Default Value: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Valid Values: A comma-separated list of valid view names from the following list: ContactInteractionDetailView,ContactInteractionNotePadView,StaticCaseDataView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the order (left to right, top to bottom) in which the views are displayed in the Workbin Interaction Details 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.



For custom views, use the section names specified in the interaction.web-content option.

Rebranding

Workspace Web Edition provides the following options for rebranding:


  • Default Value:
  • Valid Values: A valid URL
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the URL of the company logo to be displayed at the right top corner of the application. The maximum size for the logo is 100 x 24 pixels.

  • Default Value:
  • Valid Values: A valid URL
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the URL of the company logo used on the Login page. The maximum size for the logo is 320 x 32 pixels.

  • Default Value:
  • Valid Values: A valid URL
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the URL of the company logo used in the About page. The maximum size for the logo is 320 x 32 pixels.

rebranding.product-major-name

  • Default Value:
  • Valid Values: A valid string
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the major name of the product.

rebranding.product-minor-name

  • Default Value:
  • Valid Values: A valid string
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the minor name of the product.

rebranding.product-version

  • Default Value:
  • Valid Values: A valid string
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the product version.

rebranding.company-favicon

  • Default Value:
  • Valid Values: A valid URL
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the favicon used for the address bar or in tab related to Workspace Web Edition. The maximum size for the favicon is 100 x 24 pixels.
Comments or questions about this documentation? Contact us for support!