Creating a catalog widget

You can add the extension to the catalog so that users can select it by clicking it, which removed the need to remember the URL of the custom extension and manually add it. By creating a custom widget catalog, you can add extensions to the list. You can control the category that your extension is shown in and define new categories. An extension can be shown in more than one category.

1. Create a widget catalog XML file with your catalog entries. For a template that you can use to create your XML file, see the Template widget catalog XML file. Each catalog entry is contained by a catalog-entry element. The child elements that you can have are listed in the following table. For more information, see catalog-entry element table.

   Element name	Optional	Purpose
   (title)	No	The name of the extension, which is shown throughout the UI.
   (description)	No	A description of the extension.
   (creator)	Yes	The name of the author or authors of the extension. This information is shown in the large preview.
   (gadget)	No	The URL of the gadget XML. This URL can be either absolute or relative to the location of the widget catalog.
   (icon)	Yes	The URL of an image to use in the extension toolbar.
   (preview)	Yes	The URL of the image to use as a preview of the running extension. This image is rendered at 280 pixels wide.
   (thumbnail)	Yes	The URL of an image to use as the thumbnail. This size of the image must be 200 pixels x 95 pixels.
   (category)	Yes	You can use multiple categories. Categories control which subcategory the extension is shown in. If you do not specify a category, the extension is shown only in the All category.

   Note: For the text you include in the XML file, you must be aware of the rules about escaping certain characters. For instance, if you want the title R&D, you type R&D. For more information about the escaping rules, see http://www.w3.org/TR/xml/#syntax.
2. Host the catalog XML file on the server.
   A typical location for the file is the root directory where your extensions are served from.
3. Add the catalog as a user extension on the Engineering Requirements Management DOORS® Next server.
   1. Open https://your-server:port_number/rm/admin.
   2. From the menu, click Advanced Properties.
   3. In the list of properties, find the RM Client Component section.
   4. In the com.ibm.rdm.widgetcatalog.internal.WidgetCatalog list, find the User Extension Category URL property.
   5. Enter the URL that points to your widget catalog.
   6. Click Save to finalize your changes.
      The server tries to read the catalog, you do not need to restart the server.
4. Refresh the catalog.