How do I create an XPages widget?

You can create a widget to search HCL Notes® XPages using a default value, selected Live Text, or other selected text. You can also use this wizard to open the target XPage.

About this task

You can start the configuration wizard to create a new Notes widget from an XPages application running in the Notes client as follows.
Note: For an XPages application running through a Web browser, use a Web Page widget.
Note: If you are using Notes, use the embedded Web browser.


  1. Open the target XPages application from which to base your widget.
    Note: To search the XPages application from a default value or Live Text, perform a search inside the application and configure the widget from the search results page.
  2. Click the Configure a Widget from Current Context toolbar button to start the wizard.
    Note: If you use a local XPages application as the widget source, the widget will not be functional in a Notes roaming user context nor will it be functional for other users you share it with through either email or by publishing to a widget catalog.
  3. Select a configuration option.
    • Perform a full text search on this XPage – This creates a widget, based on the search that was performed, that opens the XPages application and either defaults to a preset search value or accepts a Live Text search value for which to query. This only appears when configuring a widget from a search results page.
    • Open this XPage – This creates a widget that opens the specific XPage currently being viewed. This provides a simple way to add an XPages application to the Notes Sidebar, in addition to a new tab or window.
    • Open Notes object – Use the default Notes URL, for example notes://mydominoserver/XPagesDiscussion1.nsf/allDocuments.xsp?OpenXPage or optionally specify another value.
  4. Click Next.
  5. Specify a widget name or accept the default.
  6. Specify what you want to do with the widget and click Next.
    • Wire as an action – This is available if you selected Perform a full text search on this XPage.
      Note: Clicking this option opens a list of available widget properties that you can configure to be wireable from the Advanced tab.
      • Configure – Enable to make the property wireable.
      • Require – Enable to require that the field must be used in the action.
      • Default value – Specify a default value.
    • Display as a Panel – This adds the widget in its current form as its own sidebar panel and as a widget in the My Widgets sidebar panel.
    • Just configure a widget for now – This adds the widget in its current form to the My Widgets sidebar panel, where you can then publish it to the catalog.
    Note: The "Wire an action to configure a widget" dialog prompts you to specify whether to use recognized content or other content, specify the content (type) and then wire a Content type property to a Widget property. Entries in the Content type property field are derived from the selected content (type), which is the field next to the New Recognizer button. Entries in the Widget property field are derived from the fields you selected on the previous "Configure a widget" dialog. See "How do I wire a widget action" for related information.
  7. Click Next to view the Test and Publish panel instructions and then Finish to create the widget and close the wizard.