The purpose of this guide is to provide the procedures required to configure the integration of Business Service Management Service Health, Service Level Management, or Alerts components with HP Service Manager.
Notes:
Guide release date: May 2012.
Select the BSM capability you want to use:
Submit an incident through Business Service Management alerts. Incidents are automatically opened incidents in HP Service Manager when a CI Status alert is triggered in BSM.
If you select the Submit an incident through Business Service Management alerts capability, when integrating SM 9.30/9.20/9.21 and BSM 9.1x, you can use either one of the following processes:
The following steps are customized according to your selections. Check that your selections are correct.
If any selections are not correct, click Change.
HP Service Manager software is a comprehensive and fully integrated IT service management suite that helps you decrease the time it takes to resolve problems. ITIL-based best practices and a highly scalable service-oriented architecture let you deploy consistent, integrated processes throughout your IT organization. HP Service Manager provides the following capabilities:
You can configure specific CI Status alerts, SLA alerts, or EUM alerts to automatically open a corresponding incident in HP Service Manager. The alerts are mapped to the events using the Event Template. The triggered alert forwards a corresponding event to OMi, where (using the Incident exchange between Service Manager and Operations Manager I integration) the event is changed into an incident and sent, using the Event Forwarding Service, to HP Service Manager to proactively alert the operator about a problem in the system.
Note: If you are migrating from earlier versions of Service Manager and Business Service Management and already have configured alerts integration (based on the CI Alert Retrieval Service), you can continue to use this integration as is - for details, select 7.11 as the version of Service Manager in this document.
The scenario is as follows: a CI Status alert is triggered in BSM, and at the scheduled time HP Service Manager retrieves the alert information from BSM and creates an incident. The alert is then updated and closed in BSM. You can view what happens in HP Service Manager as follows:
This section describes the rule and the field mapping used in the integration of HP Service Manager with BSM.
Note: This section is for advanced users.
The CI Alert Retrieval Service can be used to retrieve information from the Alerts feed where CI Status alerts are stored after they are triggered. You access the service using URLs. The alert information is displayed in HTML, XML, or JSON format.
For details on how to open an incident in HP Service Manager, see "How to Open Incidents Using the CI Alert Retrieval Service".
The Service Manager Adapter supports the retrieval of data from HP Service Manager. This adapter connects to, and receives data from, Service Manager using the Web Service API. Every request to Service Manager to calculate a federated query is made through this adapter. For details on how to perform this task, see "Federate BSM and HP Service Manager Data".
This section provides a scenario for the complete integration of HP Service Manager with Alerts, Service Health, and Universal CMDB.
This section provides a scenario for the complete integration of HP Service Manager with Alerts, Service Health, and Universal CMDB.
You can collect data from an existing HP Service Manager Server and view the data in Service Health and Service Level Management applications.
Note: Complete each step before beginning the next step.
HP Service Manager data is integrated into BSM. This enables the display of the Planned Changes and Incidents tab in the 360° View page in Service Health. For details, click 360° View in Using Service Health.
This step enables the display of incidents and changes in the 360° View page. For details, click Changes and Incidents Tab in Using Service Health .
It is recommended to back up the following files before performing the upgrade procedure. For details on the upgrade see HP Service Manager documentation.
To automatically forward an event when an alert is triggered, follow the steps described in this section.
For concept details, see "Generating Incidents in HP Service Manager when a BSM Alert is Triggered - Overview".
You can automatically manage (open, update, or close) an incident in HP Service Manager when a CI Status alert is triggered in BSM.
HP Service Manager retrieves the information about the alert from BSM using the CI Alert Retrieval Service. For details, see "Incidents Opened in HP Service Manager by CI Status Alerts Using the CI Alert Retrieval Service".
For details on the mechanism used to open an incident in HP Service Manager when a CI Status alert is triggered, see "CI Alert Retrieval Service API Overview".
Uninstall the legacy HP Service Manager Integration
In BSM, select Admin > Platform > Setup and Maintenance > Infrastructure Settings, choose Foundations, select Integrations with other applications, and locate the Enable Legacy Integration in Service Manager entry in the Integrations with other applications - Alerts - Service Manager Integration table. Make sure the value is false.
To automatically open an incident in HP Service Manager using the legacy URL, when a CI Status is triggered in BSM, follow the steps described in this section.
For details about the mechanism used to open an incident in HP Service Manager when a CI Status alert is triggered, see "Submitting Incidents when BSM Alerts are Triggered (Incident Submission) Using the CI Alert Retrieval Service"
This task describes how to configure the HP Service Manager - BSM federated integration in order to allow both products to share information and data.
This section describes how to deploy the Service Manager adapter.
The following sections describe the reference information.
The following sections describe the data included in the out-of-box unload file used for the customization.
This section provides troubleshooting and limitations information for the integration of HP Service Manager with Service Health and Service Level Management.
The following sections describe how to troubleshoot HP Service Manager deployment.
All the configurations listed below are provided by the out-of-box unload (see "Perform the Automatic Default Configuration" in "How to Open Incidents Using the CI Alert Retrieval Service") and typically require no modifications.
The sections below represent steps that serve as a reference and are only required if the Out-of-box unload is not used or requires modification.
Synchronizing events and event changes between Operations Management and HP Service Manager depends on a server hosting Operations Management forwarding events to HP Service Manager, with these events and event changes being synchronized back from Service Manager. The first step to achieve this is to configure HP Service Manager as a target connected server in the Connected Servers manager.
For full details about how to configure a connected server, see the Connecting Servers section of the Operations Management online help.
To configure the HP Service Manager server as a target connected server, perform the following steps:
Navigate to the Connected Servers manager in the Operations Management user interface:
Admin→Operations Management→Tune Operations Management→Connected Servers
Click the New () button to open the Create New Server Connection dialog.
In the Display Name field, enter a name for the target HP Service Manager server. By default, the Name field is filled automatically. For example, if you enter Service Manager 1 as the Display Name for the target HP Service Manager server, Service_Manager_1 is automatically inserted in the Name field. Of course, you can specify your own name in the Name field, if you want to change it from the one suggested automatically.
Note: Make a note of the name of the new target server (in this example, Service_Manager_1). You need to provide it later on as the username when configuring the HP Service Manager server to communicate with the server hosting Operations Management.
Optional: Enter a description for the new target server.
Make sure that you check the Active checkbox.
Click Next.
Select External Event Processing to choose the server type suitable for an external incident manager like HP Service Manager.
Click Next.
Enter the Fully Qualified DNS Name of the HP Service Manager target server.
Click Next.
Next, you need to establish the type of integration. In the Integration Type dialog, you can choose between using a Groovy script adapter, or the Event Synchronization Web Service.
As a Service Manager Groovy script adapter is provided for integrating with HP Service Manager, select Call Groovy Script Adapter.
In the External Event Processing Type field, select sm.
In the Groovy Script File Name field, select ServiceManagerAdapter.groovy.
(Leave the Groovy Classpath field blank, as in this case, no external resources are required.)
Click Next.
In HP Service Manager, set up an Integration User with user name and password. This is the user name and password needed to access the HP Service Manager target server.
In the Operations Management user interface, the next step is to provide the credentials (user name, password, and port number) to connect to the HP Service Manager target server and to forward events to that server. In the Outgoing Connection dialog, enter the following values:
In the User Name field, enter the user name for the Integration User you set up in HP Service Manager.
In the Password field, enter the password for the user you just specified. Repeat the password entry in the Password (Repeat) field.
In the Port field, specify the port configured on the HP Service Manager side for the integration with Operations Management. To find the port number to enter:
Go to the following file:
<HP Service Manager root directory>/HP/Service Manager <version>/Server/RUN/sm.ini
In the sm.ini file, you will find two port entries, depending on whether you want to use a secure HTTP connection: the httpPort, with default port number 13080, and httpsPort, with default port number 13443. The actual values for the ports can differ from these default values depending on how they are configured. Enter the appropriate value in the Port field.
If you do not want to use secure HTTP, make sure that the Use secure HTTP checkbox is not checked.
Make sure that the Supports Synchronize and Transfer Control checkbox is checked. When the Supports Synchronize and Transfer Control flag is set, an Operations Management operator is then able to transfer ownership of the event to the target connected server. If the flag is not set, then the option Synchronize and Transfer Control does not appear in the list of forwarding types when configuring forwarding rules.
Also, note that if the Supports Synchronize and Transfer Control flag is not set for any target connected server, the Transfer Control to option does not appear at all in the Event Browser context menu.
If a specific server is configured without the Supports Synchronize and Transfer Control flag set, then that server is not available in the Event Browser context menu as a server to which you can transfer ownership.
Test the connection.
Click Next.
If, in addition to purely forwarding events to HP Service Manager, you want to also be able to drill-down into HP Service Manager, you need to specify the fully qualified DNS name, and port of the HP Service Manager system where you want to perform event drill-down.
Note: To enable event drill-down to HP Service Manager, you must install a web tier client for your HP Service Manager server according to your HP Service Manager server install/configuration instructions.
In the Event Drilldown dialog of the Connected Servers manager, configure the server where you installed the web tier client along with the configured port used.
If you do not specify a server in the Event Drilldown dialog of the Connected Servers manager, it is assumed that the web tier client is installed on the server used for forwarding events and event changes to HP Service Manager, and receiving event changes back from HP Service Manager.
If nothing is configured in the Event Drilldown dialog, and the web tier client is not installed on the HP Service Manager server machine, the web browser will not be able to find the requested URL.
Click Next.
The next thing to do is to enable event changes to be synchronized back from HP Service Manager to Operations Management. For this you need to provide credentials for the HP Service Manager server to access the server hosting Operations Management.
In the Incoming Connection dialog, select the Support Event BackSync checkbox, and then enter a password that the HP Service Manager server requires to connect to the server hosting Operations Management, Myqwer1_ in this example.
Note: Make a note of this password (in this example, Myqwer1_). You need to provide it later on when configuring the HP Service Manager server to communicate with the server hosting Operations Management. This password goes with the server name (Service_Manager_1) you configured in step 3.
Click Finish. The target HP Service Manager server appears in the list of Connected Servers.
The next step is to configure an event forwarding rule that determines which events are forwarded automatically to HP Service Manager.
Refer to the Operations Management online help for full details about configuring filters.
To configure a forwarding rule, carry out the following steps:
Navigate to the Forwarding Rules manager in the Operations Management user interface:
Admin→Operations Management→Tune Operations Management→Forwarding Rules
Click the New () button to open the Create New Forwarding Rule dialog.
In the Display Name field, enter a name for the forwarding rule, in this example Forward Critical (Sync and Transfer Control).
Optional. Enter a description for the forwarding rule you are creating.
Make sure the Active checkbox is checked. A rule must be active in order for its status to be available in HP Service Manager.
Click the browse button next to the Event Filter field. The Select an Event Filter dialog opens.
In the Select an Event Filter dialog box, do one of the following:
Select an existing filter
Create a new filter as follows:
Click the New () button to open the Filter Configuration dialog.
In the Filter Display Name field, enter a name for the new filter, in this example, FilterCritical.
Uncheck the checkboxes for all severity levels except for the severity Critical.
Click OK.
You should see your new filter in the Select an Event Filter dialog (select it, if it is not already highlighted).
Click OK.
Under Target Servers, select the target connected server you configured in the previous section. In this example, this is Service Manager 1.
Click the Add () button next to the target servers selection field. You can now see the connected server’s details. In the Forwarding Type field, select the forwarding type.
Click OK.
Before operators are able to perform event drill-down from HP Service Manager into the Operations Management user interface using a URL launch of the Event Browser, the operators must be set up as valid users in BSM with appropriate permissions in Operations Manager i:
User account requirements
If Single Sign-On (SSO) authentication is configured, set up each user in BSM with the same user name that is used by the HP Service Manager operator to log onto HP Service Manager and to perform the URL call. (The password of each BSM user can be empty or any string.) After successfully logging into HP Service Manager, the BSM users can launch the Operations Management Event Browser without further authentication.
If HP Service Manager is not configured to use SSO authentication, set up each user with the same user name that is used by the HP Service Manager operator and specify a valid password. The users are required to enter their user name and password when launching the Operations Management Event Browser.
Required user permissions
You must grant the permission Events assigned to user including the required actions to each BSM user. You can optionally grant the permission to view events not assigned to each user.
Note: Without valid user names, or if a user does not have the required viewing permissions, any attempt to perform a URL launch of the Operations Management Event Browser from HP Service Manager results in an empty browser window.
To be able to perform a URL launch of HP Service Manager from the Operations Management Event Browser using the web tier client, do the following:
Navigate to the Groovy script ServiceManagerAdapter.groovy in following location:
<HPBSM root directory>/conf/opr/integration/sm/ServiceManagerAdapter.groovy
Open the ServiceManagerAdapter.groovy Groovy script.
Locate the following text in the Groovy script:
private static final String DRILLDOWN_ROOT_PATH = '/webtier-9.20/index.do?ctx=docEngine&file=probsummary&query=number%3D';
Change the value of webtier-9.20 to the value required to access the HP Service Manager web tier client.
The full drill-down URL is made up like this:
http://<FQDNS of HP Service Manager web tier server>/<web path to HP Service Manager>/<URL query parameters>
where <FQDNS of HP Service Manager web tier server> is the fully qualified DNS name of the HP Service Manager server where the web tier client is installed. This part of the URL is added automatically (together with http://) according to the values that you provided when you configured the HP Service Manager as a target connected server in the Connected Servers manager.
Here is an example of how the drill-down URL looks:
http://smserver.example.com/SM920/index.do?ctx=docEngine&file=
probsummary&query=number%3D
So in this example, the you must replace webtier-9.20 with SM920. All the other parts of the URL are configured automatically.
In the HP Service Manager web tier configuration file web.xml, set the value of the querySecurity parameter from the default value (true) to false.
For more details, see the section Web parameter: querySecurity in the HP Service Manager online help.
The next step is to configure HP Service Manager server to integrate with Operations Management.
To configure the HP Service Manager server, complete the following steps in the HP Service Manager:
From the left hand pane of the HP Service Manager user interface, navigate to:
Tailoring→Integration Manager
Click Add to add a new configuration.
Select the SMOMi integration template from the Integration Template field. Click Next.
Optional. Change the log level to the desired value.
Optional. Change the description, for example, to This is for SMOMi integration.
Click Next.
In the General Parameters tab, replace the existing entries with the following values:
| Name | Value | Category |
|---|---|---|
|
|
|
General |
|
|
(This is the name of the HP Service Manager target server you configured previously). |
Header |
|
omi.eventdetail.baseurl |
|
General |
In the Secure Parameters tab, set the password to the one you specified in the Incoming Connection dialog when configuring the target connected server. In our example, this is HPqwer1_.
Click Next.
In the Integration Instance Fields dialog, click Next.
In the Integration Instance Mapping dialog, click Finish.
Note: Ensure that the rule is active. To make the rule active, select the rule and click Enable.
You can add your own custom attributes in a Groovy script and then map these custom attributes to HP Service Manager to the appropriate field in HP Service Manager. You can also change how attributes are mapped from Operations Management to HP Service Manager. The mapping is done in the BDM Mapping Manager in HP Service Manager:
System Administration→Ongoing Maintenance →BDM Mapping Management
For full details about mapping attributes, see the HP Service Manager online help.
To test the connection, send an event to the server hosting Operations Management that matches the filter you defined (in our example filter, the severity value is Critical), and then verify that the event is forwarded to HP Service Manager as expected.
To test the connection, do the following:
On the system running Operations Management, open an Event Browser.
On the system running Operations Management, open a command prompt and change to the following directory:
<HPBSM root directory>\opr\support
Send an event using the following command:
sendevent -s critical -t test111-1
Verify that the event appears in the Operations Management Event Browser.
Select the External Info tab.
In the External Id field, you should see a valid HP Service Manager incident ID.
Next, verify that the incident appears in the Incident Details in HP Service Manager:
If the event drill-down connection is configured correctly, click the Edit button. A browser window opens, which takes you directly to the incident in the Incident Details in HP Service Manager.
If the event drill-down connection is not configured, do the following:
In the External Info tab in the Operations Management Event Browser, copy or note the incident ID from the External Id field.
In the HP Service Manager user interface, navigate to:
Incident Management→Search Incidents
Paste or enter the incident ID in the Incident Id field.
Click the Search button. This takes you to the incident in the Incident Details.
Close the incident in HP Service Manager.
Verify that the change in the state of the incident (it is now closed) is synchronized back to Operations Management. You should not be able to see the event that was closed in HP Service Manager in the active Event Browser, but it should now be in the History Browser.
Not all attributes are synchronized back from HP Service Manager to Operations Management by default. There are some attributes that are subject to a one-time, uni-directional update from Operations Management to HP Service Manager, and there are some that are subject to bi-directional synchronization.
The following attributes are transferred to HP Service Manager from Operations Management one a one-time basis, that is, when the event was initially created, and the transfer of control of the event was configured in the Connected Servers manager.
For these attributes, there is no back synchronization from HP Service Manager to Operations Management.
Attributes that support bi-directional synchronization between Operations Management and HP Service Manager are:
If you want to change the out-of-the-box behavior regarding which attributes are updated, you can specify this in a Groovy script. In the Groovy script, you would specify which fields are updated in HP Service Manager, and which fields are updated in Operations Management. You can also specify custom attributes in the Groovy script.
Note: In multi-server environments, make sure that the Groovy script files are updated on all gateway servers.
This section provides some tips about customizing Groovy scripts. Below we show just a few selected examples of what you can customize. You can look at the configuration section of a Groovy script to see further items that can be modified.
In the configuration section of a Groovy script, you can define and modify the attributes that are to be synchronized between Operations Management and HP Service Manager. The configuration section of a Groovy script also contains the default value mappings for lifecycle state, severity, and priority. You can also modify these, and it is possible to define the mappings for in-going and out-going requests differently.
More advanced configuration can be done in other parts of the Groovy script if required.
The beginning and the end of the configuration section of a Groovy script is marked as follows:
//
// configuration section to customize the Groovy script
// BEGIN
...
...
//
// configuration section to customize the Groovy script
// END
Before you modify a Groovy script, make a copy of the original (out-of-the-box) script. This is because a patch, service pack or hotfix may be delivered with a new version of the Groovy script that may overwrite the original script. Make sure that you copy your customized Groovy script to a safe location. It may be necessary to merge your changes with the new Groovy script delivered with the patch, service pack or hotfix.
The mapping from Operations Management to HP Service Manager is compliant to BDM 1.1 incident web service specifications. The mapping of the BDM 1.1 incident web service to HP Service Manager is specified in HP Service Manager in the BDM Mapping Manager. For more information about the BDM Mapping Manager, see the BDM Mapping Manager section of the HP Service Manager online help.
You can control how updates to certain attributes are synchronized between Operations Management and HP Service Manager by setting some Boolean variables to true or false.
Here are two examples:
private static final SyncTitleToSMOnUpdate = false;
This line of the Groovy script disables the synchronization of changes to the title made in Operations Management to HP Service Manager.
private static final Boolean SyncTitleToOPROnUpdate = false;
This line of the Groovy script disables the synchronization changes to the title made in HP Service Manager to Operations Management.
The title is a required attribute in HP Service Manager, and is set, independently of the flags above, using the title given in Operations Management during the creation of the incident.
You can map the Operations Management (OPR) lifecycle state to a (BDM) lifecycle state in HP Service Manager by modifying the Groovy script.
Here are two examples:
private static final Map OPR2BDMLifecycleState = ["open": null, "in_progress": null, "resolved": null, "closed": "closed"];
In this example, only the OPR lifecycle state “closed” is mapped to the BDM lifecycle state “closed”. A null is an instruction not to change the state in HP Service Manager.
private static final Map OPR2BDMLifecycleState = ["open": null, "in_progress": null, "resolved":"resolved", "closed": "closed"];
In this example, the OPR state resolved sets the BDM state to resolved.
It is not required to map OPR lifecycle state open to SM lifecycle state open, because the initial lifecycle of an incident is set during the creation of the incident.
You can specify the mapping from BDM lifecycle states to the known OPR states with the following configuration line:
private static final Map BDM2OPRLifecycleState = ["open": null, "work-in-progress": null, "resolved": null, "closed": "closed"];
In this example the (OPR) event is closed when the (BDM) incident is closed. A null is an instruction not to change the event state if the incident state was changed in HP Service Manager.
If you map the BDM lifecycle state open to OPR lifecycle state open, the following would happen. If an incident is closed and then is reopened again in HP Service Manager, corresponding event in Operations Management would be reopened.
If you get a syntax error when customizing your Groovy scripts, look at the log file opr-event-sync-adapter.log for information about how to resolve the error. You can find the log file here:
<HPBSM root directory>/log/opr-event-sync-adapter.log