HP BSM Operations Manager i (OMi)

This integration requires a user who can authenticate REST web service calls when working with alerts. These permissions are provided by the "REST Web Service User" role in xMatters. See Create an integration user for more information.

Keep the user ID and password of this user handy — you'll need them when configuring other parts of this integration.

This integration requires a web service user with specific permissions in xMatters to receive user responses and notifications about alert status changes for the Integration Agent.

"Web service users" are a specific type of user in xMattersthat can work with the SOAP web services used by the Integration Agent; this means you can't just use a regular user and assign them a specific role or permission, you have to create a dedicated user.

1. In xMatters, click the Users tab, and select Add Web Service User .
2. On the Add Web Service User page, enter a User ID and Password for the new web service user.
3. In the Denied Web Services list, locate and select the following web services, and then click Add:
   • Query User
   • Receive APXML
   • Register Integration Agent
   • Submit APXML
4. Click Save.

The next step is to import the workflow. You can find the workflow .zip file in the extracted archive you downloaded.

1. In xMatters, click the Workflows tab, and then click Import.
2. Browse to the .zip file you downloaded, or drag it onto the Import Workflow dialog box.
3. Click Import Workflow.
   • Once the import is finished, the workflow should be automatically enabled. If it isn't, click the Disabled toggle to enable it.
4. Click the gear icon beside the workflow, and select Editor Permissions.

5. Add the integration user, and then click Save.
6. Click the workflow name to open the Forms tab.
7. For the first form in the list (Spectrum Incidents), click the Web Service drop-down, and then select Sender Permissions.

8. Add the integration user, and then click Save Changes.
9. Repeat steps 7-8 for each of the other forms.

Some configuration fields require a UUID (Universal Unique Identifier) for a specific component or property in a workflow — usually the responses. To retrieve the identifier for an element, look for the API icon in the xMatters user interface:

Clicking this button displays the identifier for the component in a dialog box; you can copy and paste the string to the appropriate location in the Integration Agent configuration file.

As an example, the following instructions describe how to retrieve the UUID for a specific response choice; the process is similar for any identifier you want to determine.

To retrieve the identifier for a response choice:

1. In xMatters, open the HP OMi workflow.
2. On the Spectrum Incidents form, click Edit > Responses.
3. Beside the Acknowledged response, click the API icon.

The installation package contains all that you need to configure the integration.

1. Within the extracted integration archive, navigate to components/integration-agent/integrationservices, and copy the entire contents of the folder to the <IAHOME>/integrationservices directory.
2. Open the <IAHOME>/conf/IAConfig.xml file and add the following line to the "service-configs" section:
   <path>hpomi-3-0/hpomi.xml</path>
3. Save and close the file.
4. Open the <IAHOME>/integrationservices/hpomi-3-0/configuration.js file and add or set the values for the following variables:

5. Save and close the file.
6. Restart the Integration Agent

This integration includes encrypted files, located in the <IAHOME>\conf folder, that store the passwords for the integration user and the HP OMi API user. You will need to update the file with the correct password for the SERVICE_DESK_USER variable specified in the hpomi-3-0\configuration.js file.

1. Open a command prompt and navigate to <IAHOME>\bin.
2. Run the following command, where <new_password> is the password for the web services user specified in the configuration.js file and <old_password> is the existing password (the default password for a newly installed integration is "password"):
   iapassword.bat --new <new_password> --old <old_password> --file conf/.pwd
3. Now run the command again, but where <new_password> is the password for the INITIATOR user specified in the configuration.js file and <old_password> is the existing password (the default password for a newly installed integration is "password"):
   iapassword.bat --new <new_password> --old <old_password> --file conf/.initiatorpasswd

For more information about working with the iapassword command, and creating password files, refer to the xMatters Integration Agent Guide.

The integration package includes a file that engages the Integration Agent filtering and suppression module to suppress duplicate alerts (also know as deduplication). This can help to avoid disruption of traffic due to alert floods (a potential hazard with improperly configured management systems).

The deduplicator is installed into the <IAHOME>\conf folder, and is configured by default to suppress up to 100 duplicate alerts for two minutes. You can configure the filter to extend the time period in which an alert is considered to be a duplicate, the number of alerts within that period, and the tokens or properties that xMatters uses to determine what makes the alert unique.

To enable deduplication:

1. Navigate to the <IAHOME>/conf directory.
2. If you have an existing deduplicator-filter.xml file in this folder, create a backup version in a separate location.
3. Copy the deduplicator-filter.xml file from the integration-agent/conf folder in the extracted integration archive into the <IAHOME>/conf directory.
4. Restart the Integration Agent.

For more information about the deduplication filter and the available settings, refer to the "Filtering and Suppression" section in the xMatters Integration Agent Guide.

Configuring a connected server allows notification responses to update alerts appropriately.

To create a connected server:

1. In the HP OMi interface, on the Administration tab, in the Setup and Maintenance area, click Connected Servers.
2. Click the New Item icon, and then select the External Event Processing server type. HP OMi displays the Create New Server Connection dialog box.
3. On the General page, in the Display Name field, type xMatters, and then click Next.
4. On the Server Properties page, type the fully qualified DNS name of the server on which the xMatters Integration Agent is installed, select Management System as the CI Type, and then click Next.
5. On the Integration Type page, select Call External Event Web Service.
6. In the Root URL Path field, type /http/applications_hpomi-3-0, and then click Next.
7. On the Outgoing Connection page, ensure that the value in the Port field (default for the integration is 8081) matches the service-gateway port defined in the IAConfig.xml file.
8. If the Integration Agent and xMatters have not been configured for SSL, clear the Use Secure HTTP check box.
9. Select the Supports Synchronize and Transfer Control check box, and then click Next.
10. On the Event Drill-down page, click Next.
11. On the Incoming Connection page, enter the password specified in the configuration.js.
12. Click Finish.

Each deployment of the integration requires a unique event forwarding rule, specific to each deployment, based on the organization's assessment of which events are appropriate to be sent to xMatters. An organization can choose to have more than one event forwarding rule, but for the integration to function correctly, an Event Forwarding rule must exist and be associated with the xMatters connected server.

The following steps provide an example of how to create a forwarding rule; the rule required for your integration will be a variation of this rule.

To create an event forwarding rule:

1. In the HP OMi interface, click the Administration tab drop-down list, and then click Event Forwarding in the Automation section.
2. On the Event Forwarding page, click the New Item icon. HP OMi displays the Create New Event Forwarding Rule dialog box.
3. In the General section, in the Display Name field, type xMatters Event Forwarding Rule.
4. In the Condition section, click the Browse button beside the Event Filter drop-down list.

   

5. In the Select an Event Filter dialog box, click New, and then select New Simple Filter.
6. In the Filter Configuration dialog box, in the Filter Display Name field, type xMatters Minor Severity Filter.
7. Select the Minor Severity check box, and then clear the check box for all other severities.
8. In the Correlation area, select All top level events, and then click OK.
9. Once HP OMi returns you to the Select an Event Filter dialog box, with the xMatters Minor Severity Filter selected, click OK.
10. In the Target Servers drop-down list, select xMatters, and then click Add target server (the plus symbol beside the drop-down list).
11. In the Forwarding Type drop-down list, select Synchronize.
12. Click OK.

When the response is received, the Lifecycle state is changed to In Progress and a message is logged in the Annotations tab of the event.

To view the notification results:

1. Open the HP OMi Web Console.
2. On the Event Perspective tab, under Event Browser, locate the event used for testing notifications.
   • The Life Cycle State has changed to In Progress, indicating that the event was acknowledged from xMatters:
3. To display the messages annotated to the event, click the Annotations tab.
   • An annotation indicates that the event was changed to "In Progress" by the responder. For In Progress, Resolved, and Closed responses, the Assigned User is set to the person who responded.