Integrate external event processes using Groovy scripts

A sample Groovy script is provided out-of-the-box for use as a template. It is called sample:LogfileAdapter and can be found at:

Administration > Setup and Maintenance > Connected Servers

Alternatively, click Connected Servers.

Click Manage Scripts.

You can configure a target connected server in the Connected Servers manager by using the Logfile Adapter as the Groovy script adapter. You can use any hostname and port number for the configuration when using the LogfileAdapter, but note that you cannot use the DNS name of the Operations Manager i server. You must use another name, for example, localhost. Events and event changes forwarded to this adapter are logged to this log file:

<OMi_HOME>/log/opr/integration/LogfileAdapter.log

Developers and integrators can use this adapter for testing, and as a template to create other adapters.

A template groovy script for use as a starting point when developing new groovy scripts for external event integration on OMi is available from the following location:

<OMi_HOME>/opr/examples/external-event-adapter

There are clearly marked sections with "TODO" and steps to take when developing a new integration.

Synchronizing events and event changes between an OMi instance and a third-party event process depends on OMi forwarding events to the external event processing application, with these events and event changes being sent back from the external application.

To configure a target connected server by using the Logfile Adapter as a Groovy script adapter, perform the following steps:

1. Navigate to the Connected Servers manager:

   Administration > Setup and Maintenance > Connected Servers

   Alternatively, click Connected Servers.

2. In the central Connected Servers pane, click New and select External Event Processing. Alternatively, you can click New in the External Event Processing area in the right pane.

   The Create External Event Processing Server panel opens.

3. In the General section, enter a display label (a name for the target connected server), an identifier (a unique internal name if you want to replace the automatically generated one), and, optionally, a description of the connection being specified.

   Note The Identifier field is filled in automatically. For example, if you enter Logger Example as the display label for the target server, Logger_Example is automatically inserted in the Identifier field.

   Make a note of the name of the new target server (in this example, Logger_Example). You need to provide it later as the user name when configuring the server to communicate with the server hosting OMi.

4. In the Server Properties section, complete the following information:

   1. Enter the fully qualified domain name of the target server (for example, localhost).

   2. From the drop-down list, select the CI type of the CI that will represent the external event processing server in the RTSM.

   3. Optional. Customize the way events and change notifications are delivered to this server by using Advanced Delivery Options:

      • Serial: Events and change notifications are delivered serially in the order in which they were received.

      • Serial per source: Default. Each originating server is provided with a dedicated outgoing request delivery path. For each individual outgoing request delivery path, events and change notifications are delivered serially in the order in which they were received. This can increase the throughput for delivery of events and change notifications when many events are received from multiple originating servers, while maintaining the incoming order.

      • Parallel: The configured number of outgoing request delivery paths is used when forwarding events and change notifications. This can further increase the throughput for delivery of events and change notifications. However, because the source of the event is not considered, maintenance of the incoming order cannot be guaranteed.

5. In the Integration Type section, complete the following information:

   1. Select an integration type used to establish the connection. In this example, select the Call script adapter integration type, and then, from the Script name drop-down list, select sample:LogfileAdapter.

   2. Specify a maximum transaction time value (the time limit for the execution of the script). The default value is 60 seconds.

6. In the Outgoing Connection section, provide the following information:

   • Usually you must enter the user credentials (user name and password) and the port number required to access the external server, as well as to choose the HTTP setting. However, in this example, you do not need to provide this information and you can leave these fields blank.

   • Select the Enable synchronize and transfer control check box.

     When the Synchronize and Transfer Control flag is set, an OMi operator is able to transfer ownership of the event to the target connected server. If the flag is not set, the Synchronize and Transfer Control option does not appear in the list of forwarding types when configuring forwarding rules.

7. In the Incoming Connection section, enter a password that the external application requires to connect to the server hosting OMi (for example, HPEpasswd1_).

   Note This user and password are only valid for event synchronization web service access and cannot be used to log in to OMi.

8. In the Event Drilldown section, complete the following information:

   1. Enter the fully qualified domain name of the host system of the external event processing server (for example, test.host.com) and the port number (80) used for drilldown.

      Note The default port value is automatically inserted and can be restored by clicking Set default port.

   2. Optional. Select the Use secure HTTP check box for secure communication.

9. In the Test connection section, click Run Test to check that the specified connection attributes are correct. If an error message is displayed, correct the connection information, and retest the connection.

10. Make sure that the Activate after save check box is selected if you want to enable the server connection immediately.

11. Click Create. The target Logger Example server appears in the list of connected servers.

The next step is to configure an event forwarding rule that determines which events are forwarded to the Logger Example server.

To configure a forwarding rule, do the following:

1. Navigate to the Event Forwarding manager:

   Administration > Event Processing > Automation > Event Forwarding

   Alternatively, click Event Forwarding.

2. Click New to open the Create New Forwarding Rule dialog box.

3. In the Display Name field, enter a name for the forwarding rule, in this example Forward Major (Sync and Transfer Control).

   Optional. Enter a description for the forwarding rule you are creating.

   Make sure the Active check box is selected. A rule must be active in order for its status to be available in the target connected server.

4. Click the browse button next to the Event Filter field. The Select an Event Filter dialog opens.

5. In the Event Filters dialog, click New to open the Create Filter dialog.

6. In the Name field, enter a name for the new filter, in this example, FilterMajor. Click Add condition and then select Severity from the list of conditions. Select all severity levels except Major. Save your filter.

7. You should see your new filter in the Event Filter dialog. Select it and click  Close.

8. Under Target Servers, select the connected target server you configured in the section Sample Groovy Script: Logfile Adapter. In this example, this is Logger Example.

   Click the Add () button next to the target servers selection field. You can now see the connected server’s details.

   Click OK.

The new forwarding rule is now available.