How do I create a Notes widget from a view or frameset?

You can create a widget to search an IBM® Notes® view using a default value, selected Live Text, or other selected text. You can also use this wizard to open the target Notes view or frameset.

About this task

For widgets samples, see the public catalog and the Notes and Domino wiki.

Procedure

  1. Open the target Notes view or frameset on which to base your widget.
  2. Click the Configure a Widget from Current Context toolbar button to start the wizard.
    Note: If you use a local Notes 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 catalog.
  3. Select a configuration option.
    • Perform a full text search on this Notes view

      This option creates a widget, based on the current view context, that opens the view and either defaults to a preset search value or accepts a live search value for which to query.

      • Show Search Bar – This displays the view's Search bar in the widget's output view.
      • Show Navigator – This displays the view's navigator pane in the widget's output view.
      • Add as an engine to the Search Center – This specifies that the widget context be added as a search engine in the Notes toolbar Search list.
    • Open this view

      This creates a widget based on the current view context; wiring options are not available.

      • Show Navigator – This displays the view's navigator pane in the widget's output view.
    • Open this frameset

      This creates a widget based on the current frameset context; wiring options and an option for navigator display are not available.

      • Open view name – If enabled, the current view name appears and is opened as the widget's output view. If not enabled, a default view is opened as the widget's output view.
    • Open document by key in this view

      This allows you to open a specific document by its document ID using existing Domino URL rules. When you wire a recognized document ID to the key widget property, the first document found with that ID is opened.

      Notes returns the first document in the view whose column key matches the DocumentName. If there is more than one matching document, Notes returns the first match. The key must match completely but the match is not case-sensitive or accent-sensitive.

      As an example, www.acme.com/register.nsf/Registered+Users/Jay+Street?OpenDocument LDD Today uses a document key view named Lookup. Rules for using Domino URLs are available at www.ibm.com/developerworks/lotus/library/ls-Domino_URL_cheat_sheet.

    • Open Notes object

      Use the default Notes URL, for example Notes://<server_name>/85256055004781F8/MainFrameset?OpenFrameset. 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 option is available if you selected Perform a full text search on this Notes view.

      Note: Clicking this option opens a list of available widget properties that you can configure to be wireable. Because all Notes search widget settings are configured to be wireable, the list is disabled on the Basic tab and you are prompted to open the Advanced tab.
      • Configure – Enable to make the property wireable. All Notes widget properties must be wireable, so they are all selected by default.
      • Require – Enable to require that the field must be used in the action. All Notes widget properties are required so they are all selected by default.
      • 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.

  7. 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
  8. Click Next to view the Test and Publish panel instructions and then Finish to create the widget and close the wizard.