Creating the widget catalog

The widgets catalog centrally houses available widgets.The catalog is anHCLNotes® applicationthat can be used as an XPages application.

Before you begin

Ensure that you have appropriate access to enable agents onthe Server document,Security tab,ProgrammabilityRestrictions section. At minimum, enable theSignor run restricted LotusScript/Java agents option.

About this task

Administrators and power uses can use the supplied catalogtemplate to create a widgets catalog on a server. A local copy ofthe catalog is automatically created on the user's client system whenthe widget catalog server and widget catalog application preferenceis applied. The local replica is periodically updated based on whateverreplication schedule is set for Normal priority applications.

Procedure

  1. Obtain the widget catalog template (toolbox.ntf)installed with theHCLDomino® server.The application title is Widget Catalog (9).
  2. Create the widget catalog, for example namedtoolbox.nsf,using the suppliedtoolbox.ntf template.
  3. Assign ACLs to control access rights to the catalog applicationfor administrators, power users, and end users.

    Administrators and power users need read and write access to the catalog.

    Administrators must be granted the [Admins] role in the catalog Access Control List (ACL).Administrators also need one of the following access rights to the catalog:

    • Manager
    • Designer
    • Editor

    End users may not be set up to browse and access the catalog directly but rather to obtain widgetactions automatically by way of their membership in specific widget categories. End users, if theyare not allowed to create and configure widgets, need Reader access to the catalog; otherwise it isrecommended that end users are granted Author access to the catalog.

    All users that are allowed to create widgets in the widget catalog must be granted the[WidgetAuthor] role.

  4. Optional:Once you have created the catalog,you can create an initial set of categories for the catalog.

    There are two types of predefined categories in the catalog-- administrator categories and categories. Both of these categoriescan be defined in theAdministration/Keyword view.Administrator categories are namedADMIN-Categories,and only administrators can put widgets in these categories. The othercategories keyword is namedCategories, andany widget author can add a widget to these categories.

    Note: Youcan assign policies or preferences to designate user access to thecatalog.
  5. Optional:Enable the Toolbox Sweeper agent(ToolSweeper), a scheduled agent set to run against new and modifieddocuments. This agent ensures that widget documents are properly createdand populated. Each widget document requires a title and an xml fileattachment. If a problem is found, the offending document is removedfrom the user views, is placed in the Administration/Document Queue,and an e-mail is sent to the document author informing him of theproblem. Enable the Sweeper agent by selectingView >Agents, highlighting the ToolboxSweeper agent, and then selectingEnable. Whenprompted for which server to run the agent on, select the server whereyou have deployed the catalog.
  6. If you are using the Widget Catalog as an XPage application,configure the following roles in the Access Control List (ACL):
    • [TagAuthor] - allows user to add tags to widget documents
    • [CommentAuthor] - allows user to add comments to widget documents
    • [RatingAuthor] - allows users to rate a widget

    Then enable the agents listed in the following table. Specifythe server on which the widget catalog application is deployed; theagents should all run on the same server.

    Table 1.Agents
    AgentDescription
    CalcDownloadsEnsures that widget documents display the updatednumber of user downloads. By default, this agent runs every 5 minutes.
    CalcRatingsEnsures that widget documents display the updatedaverage user rating. By default, this agent runs every 5 minutes.
    CalcTagsEnsures that widget documents display the updatedlist of tags created by users. By default, this agent runs every 5minutes.
    CreateStatisticRDocEnsures that a statistic response document iscreated for each widget. By default, this agent runs daily.
    RmDupRatingR2REnsures any duplicate rating response-to-responsedocument from the same user is removed. By default, this agent runsdaily.
    Note: A-response-to-response document is created when a userrates a widget in the widget document XPages user interface. If thereis more than one such document for a given user - for example dueto a replication conflict - the agent removes one.
    Note: In a clustered environment, select only a single masterserver to run the scheduled agents.
  7. Set the widget catalog application launch options to theXPages user interface, which is the preferred interface for widgets.
    Note: If you do not want to use the XPages user interface, youcan open the catalog in the Notes client and setOpen designatedFrameset in the properties toToolbox-MainFrameset.
    1. Select the new database, right-click and selectProperties.
    2. Click the icon for launch options.
    3. UnderWhen opened in the Notes client,selectOpen designated Frameset and selecttheToolbox-MainFrameset-XPage frameset.
    4. UnderWhen opened in a browser,selecthome.xsp as the XPage.
    Note: There is no XPages user interface in the catalog applicationfor approving and signing widgets. However, after you change the launchoptions to those in the procedure, you and other administrators canstill see the classic user interface and have theReview buttonavailable for approving and signing widgets. To do so, open the catalogin theDomino® Administratorclient without theNotes® clientrunning.
After the agents are enabled, during the procedure for configuring the credential store, besure to give yourself the[Admins] role in the ACL of the credential storeapplication,credstore.nsf.