Integrate with ALM (for the Defects Widget)

1. In UCMDB, go to Data Flow Management > Integration Studio.

2. Create a new integration point with the following settings:

   • Integration Name. Defects Adapter

   • Adapter. ALMAdapter

   • Protocol. must be http or https

   • HostnameIP. the name or IP address of the machine where ALM is installed

   • Port. the port number of the ALM server

   • Domain. the domain that is defined in ALM

   • Credentials ID. click the browse button and from the list that appears choose credentials for connecting to ALM, or create new credentials

3. Optional: Click Test Connection to ensure that a connection can be established with the ALM server.
4. Click OK.
5. Under the Supported and Selected CI Types panel, check the Defect CI type.
6. Click the Save Integration Point button.

There are two out-of-the-box mapping properties files, one for attributes and one for severities. The attributes mapping properties files map between names of defect fields in ALM to names of attributes of the class type Defect in UCMDB. The severities mapping properties file maps between severity levels in ALM to the five severity levels in UCMDB, as defined in the DefectSeverity typedef in UCMDB. These files can be accessed by means of the Defects Adapter, by going to Data Flow Management > Adapter Management > ALMAdapter > Configuration Files. The files are called sample.attribute.mappings.properties and sample.severity.mappings.properties.

You may want to create your own customized attributes or severity mapping properties files. This could be necessary if the names of the fields in the out-of-the-box mapping properties files do not match the names in your ALM system, or could be useful if you want to add additional fields that do not exist in the out-of-the-box mapping properties files.

To create a new attribute or severity mapping properties file:

1. If you are creating an attribute mapping properties file:

   1. To retrieve the ALM defect attribute field names that you need to create the mapping, go to the following URL:

      http://<ALM server>:8080/qcbin/rest/domains/<domain>
      /projects/<project>/customization/entities/defect/fields?login-form-required=y

   2. In the ALM login page, enter your user credentials.

   3. In the XML file that appears there is a list of the defect’s fields. Note the Name element in each field, you are going to map the value that appears for the Name element here to the names of attributes of the class type Defect in UCMDB.

2. In UCMDB, go to Data Flow Management > Adapter Management.
3. Click the New button and from the pop-up menu select New Configuration File.

4. Enter a name that starts with ALMAdapter/…, for example: ALMAdapter/attribute.mappings.properties.

   Note The custom attribute mappings file should be named attribute.mappings.properties, and the custom severity mappings file should be named severity.mappings.properties. If project-specific mappings files are required, they should be named <project-name>.attribute.mappings.properties and <project-name>.severity.mappings.properties for attributes or severities, accordingly.

5. Click the Browse button by the Package field, choose ALMAdapter from the list that appears, and click OK.

6. In the text editor, for attributes mapping each row should contain the name of the ALM field (attribute) on the left side and name of the equivalent CI attribute on the right side in the following manner:

   <ALM field name>=<CI attribute>

   For severities mapping, each row should contain the ALM severity on the left side and the equivalent UCMDB severity (as defined in the DefectSeverity typedef in UCMDB) on the right side, in the following manner:

   <ALM severity>=<UCMDB severity>

7. Click OK when you are finished editing the new mapping properties file.

The Defects Filter CI that is related to a specific business element represents the ALM filter that is used to retrieve the relevant defects for that business element.

To create the DefectsFilter CI and relate it to the business element:

1. Create a filter in ALM (if one has not already been created).
2. Copy the filter's text.
3. In UCMDB, go to Modeling > IT Universe Manager.
4. In the Browse Views tab, click the New CI button.
5. From the CI type tree, select the DefectsFilter CI type.

6. Paste the filter text from the ALM filter into the FilterText attribute value.

   Note Currently there is a limitation of maximum 885 characters in the FilterText attribute value.

7. In ProjectGroup attribute, enter the ALM project name.

8. Optional: Give the filter a custom name by setting the Name attribute value.

9. Click Save.
10. Relate the DefectsFilter CI to the business element using a containment relationship from the Defects filter to the business element.

Before connecting to the CMS UI, enable the Defects widget as follows:

1. Go to Administration > Infrastructure Settings Manager > UCMDB Browser settings.
2. Set the value of Enable the Defects Widget to True.