Specifying Widget settings for a desktop policy

Use the Widgets tab of the Desktop Settings document to control access to Widgets and Live Text for users of the policy.

About this task

Some policy settings include a How to apply this setting column that you can use to establish one of the following conditions for that setting.

  • Don't set value

    The value set is not applied to the client's Widgets preferences panel. The user can specify a preference value and this policy setting will not overwrite that value.

  • Set initial value

    The value is applied once to the client but the user can change the setting on the Widgets or Live Text preferences panel. If the administrator changes the policy value later, the user's setting is not overwritten.

  • Set value whenever modified

    The value is applied to the client and is reapplied (overwriting a user-set change) whenever the policy setting is modified.

  • Set value and prevent changes

    The value is applied to the client and the preference is then disabled on the Widgets or Live Text preferences panel, such that the user cannot change the value.

Note: If you are not using a server-managed environment, you can use the plugin_customization.ini file either before or after install to control user access to Widgets and Live Text functionality. You can also use the Widgets preferences panel to set the catalog server, catalog name, and categories to install values, as well as the Show Widgets Toolbar and the My Widgets Sidebar panel preference. Policy settings take precedent over Eclipse preferences.

See the related topic on Default Widgets and Live Text behavior for details on Widgets and Live Text behavior when no policy or preference changes have been made.

For information on the policy settings supported by IBM® iNotes® see the IBM® iNotes® administration product documentation in the related information links.

Procedure

Complete the following fields on the Widgets tab:
Table 1. Widgets tab fields
Field Action
Widget catalog server

Specify the catalog server from which to provision at 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). Use server/domain format or a fully qualified name. If you use a server/domain format, server failover is supported.

If this policy's How to apply this setting column is set to Set value and prevent changes, users will not be able to change the value on the Widgets preferences panel.

By default, this value is not set.

Widget catalog application name

Specify the Widget catalog application name, for example toolbox.nsf, 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 (by default, replication occurs on whatever schedule is set for Normal priority applications). Use the Widget Catalog template (toolbox.ntf) to create the catalog application.

If this policy's How to apply this setting column is set to Set value and prevent changes, the end user will not be able to change the value on the Widgets preferences panel.

The default catalog name is toolbox.nsf.

Widget catalog categories to install

Specify the widget categories to install and update for this user. These categories will appear in the Categories to install list box on the Widgets preferences panel. Use this setting to limit user access to specific widget categories. If this field is blank, no widgets are installed in the user's My Widgets sidebar panel. Categories typically equate to a user grouping, such as a specific project team or job type.

The categories listed in this policy cause the equivalent category names in the Widgets preferences panel to be selected. If How to apply this setting is set to Set value and prevent changes, the categories are disabled, and end users cannot deselect them.

By default, this value is not set.

Enable Live Text

Specify if auto-recognized Live Text appears as dash-underlined text in the user's Notes® document. Live Text display can be toggled on and off when working in a session.

If this setting is disabled and if How to apply this setting is set to Set value and prevent changes, then the Live Text preference panel is hidden from the user.

By default, this setting is enabled.

Show the My Widgets panel in the sidebar

Specify if the My Widgets sidebar panel is visible in the Notes® sidebar and if the Widgets menus and toolbar are visible.

If this setting is enabled and its How to apply this setting column is set to Set value and prevent changes, the end user will not be able to change the Show Widgets Toolbar and the My Widgets Sidebar panel value on the Widgets preferences panel.

If this setting is disabled and its How to apply this setting column is set to Set value and prevent changes, the Widgets preferences panel will not be visible to the end user.

By default, this setting is enabled.

Restrict the creation of widgets to specific types

Restrict creation and edit of widgets to certain types (referred to as provider IDs).

The Widgets and Live Text feature includes an extension point for widget providers. The supplied providers include Notes® view, Feeds, Web page or service, and Google Gadget.

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 next setting.

By default, this setting is enabled.

Enable provider IDs for widget addition
Note: This field appears in the form only when Restrict the addition of widgets to specific types is enabled.

Specify the widget types available for creation. Use a comma (,) to separate types in the list. The available widget types are:

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 default is ’.’ (period).

Note: If you retain the default setting ( '.' ), users will be unable to create any widgets.

For example, if the policy setting Restrict the addition of widgets to specific types is set to Enabled and Enable provider IDs for widget addition is set to the following value, the user could only create Google Gadget widget types:

com.ibm.rcp.toolbox.google.provider.internal.GooglePalleteProvider
Restrict provider IDs for installation/execution

Restrict installation and update of widgets to specific types (referred to as provider IDs). If enabled, the administrator can then specify which widget types (provider IDs) are available using the next setting. Note that if you restrict what widget types are available for installation, you should also restrict creation of those same widget types using the Restrict the addition of widgets to specific types and Enable provider IDs for widget addition policies.

By default, this setting is disabled.

Enable provider IDs for installation/execution
Note: This field appears in the form only when Restrict provider IDs for installation/execution is enabled.

Specify the widget types available for install and update. 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 default is as follows:

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 policy setting Restrict provider IDs for installation/execution is set to Enabled and Enable provider IDs for installation/execution is set to the following value, the user could only install or provision Google Gadget widget types:

com.ibm.rcp.toolbox.google.provider.internal.GooglePalleteProvider
Restrict extension point IDs for installation/execution

Restrict installation of widgets that contain certain extension points. If enabled, the administrator can then specify which extension point IDs are allowed using the next setting.

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.

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

By default, this setting is disabled.

Enable extension point IDs for installation/execution
Note: This field appears in the form only when Restrict extension point IDs for installation/execution is enabled.

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

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

Create and manage an action

Specify whether the user can create, edit, and remove actions while working in the My Widgets sidebar panel and the Widget Management view.

By default, this option is disabled.

Create and manage recognizers and content types

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 My Widgets 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.

By default, this setting is disabled.

Enable default recognizers

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

For Notes clients, if this setting is disabled, then the user cannot enable it.

By default, this setting is enabled.

Send widgets using e-mail

Specify whether the user can send widgets to others as XML extension attachments using the E-mail to action and also whether the user can output an XML file containing selected widgets from the My Widgets sidebar panel using the Export option.

By default, this setting is disabled.

Install widgets from e-mail or other

Specify whether a user can install widgets using an XML extension file obtained from email or from the user's file system. If enabled, the user can use drag and drop to install widgets from email (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.

By default, this setting is disabled.

Install widgets from catalog

Specify whether a user can browse the configured catalog and select widgets to install to the My Widgets sidebar panel or sidebar. 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. In Notes® clients, users can also select additional categories to be provisioned with (in addition to those listed in the Widget catalog categories to install setting) using their Widgets preferences panel.

By default, this setting is disabled.

Publish to catalog so others can browse (subject to catalog ACLs)

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. Note that this option applies to widgets, content types, and recognizers.

When you publish a widget to the catalog, you should assign widget categories to it.

By default, this setting is disabled.

Gadget Server URL URL for the Domino server running Shindig, for example, http://shindig.renovations.com.
Gadget Cache URL URL for the Domino server running Shindig; same as the URL for Gadget Server URL.