Adding to the Engineering Assistant widget to the widget catalog

Edit online

Configure the Engineering Assistant widget for use in the Jazz® environment by adding it to the widget catalog. Involves enabling widget extensions, updating server configuration settings, and registering the widget catalog in Jazz Team Server (JTS) and IBM Engineering Requirements Management DOORS® Next.

Before you begin

Note: If you prefer users to add the Engineering Assistant widget manually, you can skip adding it to the widget catalog. Instead, configure the Engineering Assistant widget and share the OpenSocial gadget URL with them. For more information, see Configuring DOORS Next for Engineering Assistant agent .

Ensure that you have administrative access to the Jazz® Team Server and DOORS Next.

Procedure

Enable the 'Engineering Assistant' extensions widget on the catalog:

Before you start the server, you must edit the configuration file. To update the server configuration, complete the following steps:
1. From the root installation directory, go to: InstallPath\server\liberty\servers\clm, and open the server.xml file in a text editor.
2. In the server.xml file, locate the following line:
```
<applicationMonitor dropinsEnabled='false' pollingRate='10s' updateTrigger='mbean'/>
```
3. Change dropinsEnabled='false' to dropinsEnabled='true' and save the file.

Create the widget directory structure:

Go to the installpath\server\liberty\servers\clm directory.
In the same clm directory, create the following folder structure: dropins\war\extensions .
Your directory structure should now look like this: Installpath\server\liberty\servers\clm\dropins\war\extensions .

Place the WidgetCatalog.xml file in the extensions directory.

If a WidgetCatalog.xml file exists, edit it to include the 'Engineering Assistant' section from the following code:


<?xml version='1.0' encoding='UTF-8'?>
<rdf:RDF
    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:ju="http://jazz.net/ns/ui#"
    xmlns:dc="http://purl.org/dc/terms/"
>
    <ju:catalog-entry>
        <dc:title>Requirements quality analysis</dc:title>
        <dc:description>Requirements quality analysis description.</dc:description>
        <ju:gadget rdf:resource="<my-ai-hub-instance>/quality/ext.xml" />
        <ju:icon rdf:resource="<my-ai-hub-instance>/quality/report-data.gif" />
        <ju:category>AI</ju:category> 
    </ju:catalog-entry>
    <ju:catalog-entry>
        <dc:title>Engineering Assistant</dc:title>
        <dc:description>Engineering Assistant description.</dc:description>
        <ju:gadget rdf:resource="<my-ai-hub-instance>/conversation/ext.xml" />
        <ju:icon rdf:resource="<my-ai-hub-instance>/conversation/conversation-chat.gif" />
        <ju:category>AI</ju:category> 
    </ju:catalog-entry>
</rdf:RDF>

Start the Requirements Management (RM) server and log in to the Requirement Management application.

Note: If you see a warning about a suspicious certificate when logging in, accept or make an exception for the certificate.
Configure the Jazz Team Server, and Requirements Management administration settings:
1. Start the Jazz Team Server, and open the JTS Administrator page: https://myserver:9443/jts/admin
2. In the left pane, click Advanced Properties.
3. Locate the External Resources Allowlist property.
4. Add the URL of your IBM® Engineering AI Hub instance (for example, https://your-ai-hub-instance) and click Save.
5. Open the RM Administrator page: https://your-server:9443/rm/admin
6. In the left pane, click Advanced Properties.
7. Locate the com.ibm.rdm.widgetcatalog.internal.WidgetCatalog property.
8. Enter the following value: https://your-server:9443/extensions/WidgetCatalog.xml
9. Click Save.
  The server automatically reads the updated catalog. You do not need to restart the server.

What to do next

After adding the Engineering Assistant widget to the widget catalog, add it to the DOORS Next mini dashboard. For more information, see Adding Engineering Assistant widget to the mini-dashboard.