In a server-managed environment, access to Widgets and Live Text functionality and the widgets catalog is set using an HCL Domino® Desktop Policy Settings document. Alternatively you can use equivalent Eclipse preferences in the plugin_customization.ini file.

If a setting resides in both the Domino policy and the plugin_customization.ini file, the Domino policy value takes precedence.

The following list corresponds to either a policy name from the Widgets desktop policy settings document in the Domino Administrator or a preference from the Widgets preferences panel with an equivalent Eclipse preference in the plugin_customization.ini file.

Note: The default plugin_customization.ini file is provided in the Notes® install kit in the deploy subdirectory. The file path of the installed plugin_customization.ini file is install_dir\framework\rcp\ plugin_customization.ini.

Refer to Default Widgets and Live Text behavior listed at the end of this topic for information on how Widgets and Live Text appears to the HCL Notes user when no policy or preference changes are made.

Note: If the following four parameters are set in the plugin_customization.ini file, the local catalog replica is created from the specified catalog shortly after client application startup.

• Catalog server

  This setting specifies the catalog server from which to provision at client application startup and periodically during replication from the catalog to the user's local replica (by default, replication occurs on whatever schedule is set for Normal priority applications).

  com.ibm.rcp.toolbox.admin/toolboxCatalogServer

  Example:

  com.ibm.rcp.toolbox.admin/toolboxCatalogServer=server_name/domain

  Note: Using this setting does not prevent the user from changing the catalog server name in the Widgets preferences panel. This corresponds to the Widget catalog server policy and the Catalog server preference on the Widgets preferences panel.

  The preference default is blank.

• Catalog name

  This setting specifies the catalog application name, on the catalog server, from which to provision at client application startup and periodically during replication from the catalog to the user's local replica. The catalog is created using the Domino server-supplied Widget Catalog template (toolbox.ntf).

  com.ibm.rcp.toolbox.admin/toolboxCatalogDBName=name.nsf

  Example:

  com.ibm.rcp.toolbox.admin/toolboxCatalogDBName=toolbox.nsf

  Using this setting does not prevent the user from changing the catalog name in the Widgets preferences panel. This corresponds to the Widget catalog application name policy and the Catalog name preference on the Widgets preferences panel.

  The preference default is blank.

• Local catalog replica name

  This setting specifies the local replica catalog name and enables creation of the required local catalog replica on the user's client system. The name specified should match that of the catalog application on the server, for example toolbox.nsf. The Widgets and Live Text functionality requires the local catalog replica.

  com.ibm.rcp.toolbox.admin/toolboxCatalogLocalDBName=name.nsf

  Example:

  com.ibm.rcp.toolbox.admin/toolboxCatalogLocalDBName=toolbox.nsf

  Note: If you are using a catalog and are not using Domino policy, you must specify a local catalog replica name using the setting.

  Note: There is no corresponding setting in the Widgets desktop policy settings document and there is no setting on the Widgets preferences panel that allows the user to control this value.

  The preference default is blank.

• Widget categories to install

  This setting enables you to list the widget categories from which to provision at client application startup and periodically during replication from the catalog to the user's local replica (by default, replication occurs on whatever schedule is set for Normal priority applications).

  com.ibm.rcp.toolbox.admin/catalogCategoriesToInstall

  Example:

  com.ibm.rcp.toolbox.admin/catalogCategoriesToInstall=ABXID,Team1

  Note: Using this setting does not prevent the user from adding or removing categories in the Widgets preferences panel. This corresponds to the Widget catalog categories to install policy and the Categories to install preference on the Widgets preferences panel.

  The preference default is blank, meaning no categories are selected in the Widgets preferences panel.

• Show Widget Toolbar and the My Widgets Sidebar panel

  This setting specifies whether the Show Widget Toolbar and the My Widgets Sidebar Panel preference is enabled by default. The preference default is false, such that the option is not checked on the Widgets preferences panel. If the user enables Show Widget Toolbar and the My Widgets Sidebar panel on the Widgets preferences panel, she can see the three Widgets toolbar buttons, the Tools -> Widgets menu options, and the My Widgets sidebar panel.

  com.ibm.rcp.toolbox.admin/toolboxvisibleChild

  Options are =true and =false.

  The preference default is true.

• Enable the display of Live Text in the Notes document

  This corresponds to the Enable Live Text policy setting.

  If this setting is disabled, then Live Text is disabled and the Enable Live Text option on the Live Text preference panel is not selected by default.

  com.ibm.rcp.toolbox.admin/toolboxenableRecognizers

  Options are =true and =false. The preference default is true.

• Enable Default Recognizers

  Specify if the supplied advanced Live Text recognizers such as person (name), place (address), and organization are enabled.

  If this setting is disabled, then the user cannot enable it.

  This corresponds to the Enable Default Recognizers policy setting.

  com.ibm.rcp.toolbox.admin/toolboxEnableDefaultRecognizers

  Options are =true and =false. The preference default is true.

• Restrict widget creation and edit to specific types (provider IDs)

  Restrict creation and edit of widgets to certain types (referred to as provider IDs). This corresponds to the Restrict the creation of widgets to specific types policy setting.

  If this setting is disabled, the user can create or edit widgets with no restriction on type.

  If this setting is enabled, the user can only create or edit widgets of a certain type. The administrator can then specify which widget types (provider IDs) are available using the following setting.

  com.ibm.rcp.toolbox.admin/createTool

  Options are =true and =false. The preference default is false.

  If enabled you can then specify which widget types (provider IDs) are available for creation or edit using the following setting, which corresponds to the Enable provider IDs for widget addition policy setting.

  com.ibm.rcp.toolbox.admin/createToolProviderIDs

  Specify the widget types available for creation and edit. Use a comma to separate types in the list. The available widget type/Provider ID entries include the following and correlate to the available widget types.

  com.ibm.notes.toolbox.provider.NotesViewPalleteProvider

  com.ibm.notes.toolbox.provider.NotesFormPalleteProvider

  com.ibm.rcp.toolbox.web.provider.WebServicesPalleteProvider

  com.ibm.rcp.toolbox.feeds.FeedPalleteProvider

  com.ibm.rcp.toolbox.google.provider.internal.GooglePalleteProvider

  com.ibm.rcp.toolbox.prov.provider.ToolboxProvisioning

  com.ibm.rcp.toolbox.search.provider.SearchPalleteProvider

  com.ibm.rcp.toolbox.ca.provider.internal.CAActionPalleteProvider

  com.ibm.notes.toolbox.provider.XPagesPalleteProvider

  com.ibm.rcp.toolbox.opensocial.provider.internal.OpenSocialPalleteProvider

  The following list is the default:

  com.ibm.rcp.toolbox.google.provider.internal.GooglePalleteProvider,com.ibm.rcp.toolbox.web.provider.WebServicesPalleteProvider,com.ibm.rcp.toolbox.feeds.FeedPalleteProvider,com.ibm.notes.toolbox.provider.NotesViewPalleteProvider,com.ibm.rcp.toolbox.prov.provider.ToolboxProvisioning,com.ibm.notes.toolbox.provider.NotesFormPalleteProvider,com.ibm.rcp.toolbox.search.provider.SearchPalleteProvider,com.ibm.rcp.toolbox.ca.provider.internal.CAActionPalleteProvider,com.ibm.notes.toolbox.provider.XPagesPalleteProvider,com.ibm.rcp.toolbox.opensocial.provider.internal.OpenSocialPalleteProvider

  For example, if the following setting is used, then the user could only create Google Gadget widget types:

  com.ibm.rcp.toolbox.google.provider.internal.GooglePalleteProvider

• Restrict the installation of widgets to specific widget types (provider IDs)

  Restrict installation and update of widgets to specific types (referred to as provider IDs). This corresponds to the Restrict provider IDs for installation/execution policy setting.

  Options are =true and =false. The preference default is false.

  If enabled, the administrator can then specify the widget types (provider IDs) available for install and update using the following setting, which corresponds to the Enable provider IDs for installation/execution policy setting. Use a comma to separate types in the list.

  com.ibm.rcp.toolbox.admin/toolboxinstallProviderIDs

  The available widget type/Provider ID entries include the following and correlate to the available widget types.

  com.ibm.notes.toolbox.provider.NotesViewPalleteProvider

  com.ibm.notes.toolbox.provider.NotesFormPalleteProvider

  com.ibm.rcp.toolbox.web.provider.WebServicesPalleteProvider

  com.ibm.rcp.toolbox.feeds.FeedPalleteProvider

  com.ibm.rcp.toolbox.google.provider.internal.GooglePalleteProvider

  com.ibm.rcp.toolbox.prov.provider.ToolboxProvisioning

  com.ibm.rcp.toolbox.search.provider.SearchPalleteProvider

  com.ibm.rcp.toolbox.ca.provider.internal.CAActionPalleteProvider

  com.ibm.notes.toolbox.provider.XPagesPalleteProvider

  com.ibm.rcp.toolbox.opensocial.provider.internal.OpenSocialPalleteProvider

  The following list is the default:

  com.ibm.rcp.toolbox.google.provider.internal.GooglePalleteProvider,com.ibm.rcp.toolbox.web.provider.WebServicesPalleteProvider,com.ibm.rcp.toolbox.feeds.FeedPalleteProvider,com.ibm.notes.toolbox.provider.NotesViewPalleteProvider,com.ibm.rcp.toolbox.prov.provider.ToolboxProvisioning,com.ibm.notes.toolbox.provider.NotesFormPalleteProvider,com.ibm.rcp.toolbox.search.provider.SearchPalleteProvider,com.ibm.rcp.toolbox.ca.provider.internal.CAActionPalleteProvider,com.ibm.notes.toolbox.provider.XPagesPalleteProvider,com.ibm.rcp.toolbox.opensocial.provider.internal.OpenSocialPalleteProvider

  For example, to restrict the user such that they can only install Notes view-type widgets (from a non-catalog source), add the following entries:

  com.ibm.rcp.toolbox.admin/toolboxrestrictProviderIDs=true

  com.ibm.rcp.toolbox.admin/toolboxinstallProviderIDs=com.ibm.notes.toolbox.provider.NotesViewPalleteProvider

• Enable create, remove, and edit actions

  Specify whether the user can create, edit, and remove actions while working in the My Widgets sidebar panel and the Widget Management view. This corresponds to the Create and manage an action policy setting. If enabled, the user can perform those tasks.

  com.ibm.rcp.toolbox.admin/toolboxcreateAction

  Options are =true and =false. The preference default is true.

• Enable create, remove, or edit recognizers and content types and can use the Manage Actions, Content, and Recognizers option

  Specify whether the user can create, edit, and remove recognizers and content types while working in the My Widgets sidebar panel. If enabled, the user can create, remove, or edit recognizers and content types and can use the Manage Widgets, Content, and Recognizers option. This also enables display of the Recognize All Content option in the My Widgets menu and the "Display type properties" action when right-clicking on a content type in a Notes document. This corresponds to the Create and manage recognizers and content types policy setting.

  This also enables display of the Recognize all Content in the My Widgets options menu and the "Display type properties" action when right-clicking in a Notes document.

  com.ibm.rcp.toolbox.admin/toolboxcreateRecognizer

  Options are =true and =false. The preference default is true.

• Enable the ability to send widgets using e-mail

  Specify whether the user can send widgets to others and output an XML file containing selected widgets from the My Widgets sidebar panel. This corresponds to the Send widgets using e-mail policy setting.

  If enabled, the user can send widgets to others as XML extension attachments using the "E-mail to" action and also output an XML extension containing selected widgets in the My Widgets sidebar panel using the Export menu option.

  com.ibm.rcp.toolbox.admin/toolboxsendAsEmail

  Options are =true and =false. The preference default is true.

• Enable the ability to install widgets from e-mail or other non-catalog means

  Specify whether a user can install widgets using an XML extension file obtained from e-mail or from the user's file system. If enabled, the user can use drag and drop to install widgets from e-mail (or any Notes document that contains an attached extension.xml file, not including the configured catalog) or an import action from the user's file system. This corresponds to the Install widgets from e-mail or other policy setting.

  If enabled, the user can drag and drop to add widgets from e-mail (or any Notes document that contains an attached extension.xml file, not including the catalog) or use the Import menu option.

  com.ibm.rcp.toolbox.admin/toolboxinstallFromOther

  Options are =true and =false. The preference default is true.

• Enable the ability to install widgets from the catalog and to browse the catalog from the My Widgets sidebar panel

  Specify whether a user can browse the configured catalog and select widgets to install to the My Widgets sidebar panel or sidebar. This corresponds to the Install widgets from catalog policy setting.

  If enabled, the user can select a widget from the catalog and drag and drop the widget's XML extension attachment to their My Widgets sidebar panel. They can also select additional categories to be provisioned with (in addition to those listed in the Widget catalog categories to install policy setting) using their Widgets preferences panel.

  com.ibm.rcp.toolbox.admin/toolboxinstallFromCatalog

  Options are =true and =false. The preference default is true.

• Enable ability to publish widgets from the My Widgets sidebar panel to the catalog

  Grant access to the user, typically the power user or application developer user, to publish widgets from their My Widgets sidebar panel to the catalog for use by others. This corresponds to the Publish to catalog so others can browse policy setting.

  You must have edit rights to the catalog to publish to it.

  com.ibm.rcp.toolbox.admin/toolboxpublishToCatalog

  Options are =true and =false. The preference default is true.

• Restrict installation to specific extension point types

  Restrict installation of widgets that contain certain extension points. This corresponds to the Restrict extension point IDs for installation/execution policy setting.

  com.ibm.rcp.toolbox.admin/toolboxspecifyExtPtIDs

  Options are =true and =false. The preference default is false.

  Note: Extension points are an Eclipse feature. They define new function points for the platform that other plug-ins can plug into. Eclipse provides many extension points with the core platform. The Widgets and Live Text feature also provides some extension points. For example:

  The Eclipse platform provides the following identifiers, and many others:

  org.eclipse.ui.popupMenus, org.eclipse.ui.viewActions, org.eclipse.ui.views

  Notes and Expeditor provide the following identifiers, and many others:

  com.ibm.rcp.ui.shelfViews,com.ibm.rcp.search.engines.searchEngines, com.ibm.rcp.search.ui.searchBarSets, com.ibm.rcp.content.contentTypes, com.ibm.rcp.annotation.regex.regexTypes

  If toolboxspecifyExtPtIDs is set to true, the administrator can then specify which extension point IDs are allowed using an additional entry in the INI file.

  com.ibm.rcp.toolbox.admin/toolboxdynamicExtPtIDs

  This corresponds to the Enable extension point IDs for installation/execution policy setting.

  By default, this setting is disabled.

  You can restrict this list or add to it. Use a comma to separate items in the list. The following list is the default:

  org.eclipse.ui.popupMenus,com.ibm.rcp.content.contentTypes,com.ibm.rcp.annotation.regex.regexTypes,com.ibm.rcp.ui.shelfViews,org.eclipse.ui.views,org.eclipse.ui.viewActions,com.ibm.rcp.search.engines.searchEngines,com.ibm.rcp.search.ui.searchBarSets

  For example, the following settings specify that widgets will be able to contribute content types but not any other extension point.

  com.ibm.rcp.toolbox.admin/toolboxdynamicExtPtIDs=com.ibm.rcp.content.contentTypes

Related tasks
Deploying client plug-ins with widgets and the widget catalog

Help on Help

All Help Contents

Help on Help