Develop > Web Service Interfaces > Event Synchronization Web Service Interface

Event Synchronization Web Service Interface

The Event Synchronization Web Service interface can be used to integrate with external (third-party) event processes, such as an incident manager like HPE Service Manager. The interface is used to forward events and event changes from the OMi OPR client to the third-party application, and to synchronize back from the third-party client events and event changes that the external application makes to the events.

An external event process may integrate directly with OMi event processing, through the implementation of an OPR-compliant Event Synchronization Web Service, as opposed to implementing a Groovy script. The external application would need to implement a web service endpoint to receive OPR events and event changes, and, if synchronization is supported by the external application, a REST web service client to submit events and synchronize back event changes to the Event Synchronization Web Service.

(prerequisite) Configure a Connected Server

To use this web service, the following steps must first be performed:

  1. Configure a Connected Server of type External Event Processing in the Connected Servers manager. The name of the server is the name that must be used when authenticating at the Event Synchronization Web Service. You also specify a password for this user during configuration of the connected server.
  2. Forward an event to the target connected server. This can be done by using the Event Browser context menu to manually forward an event, or by configuring a forwarding rule and then triggering that rule.
  3. Until an event is forwarded to the target connected server, the server cannot synchronize back any changes. In contrast to the Event Web Service (see Event Web Service reference), which allows the authenticated OMi user to view and update any event that the OMi user has access to, the connected server is only allowed to synchronize back changes for events that have been first forwarded to it.
  4. The connected server synchronizes back changes to the event.

For details of how to configure connected servers, see OMi Help.