Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Operations Manager i10.62

Develop > Integrate external event processes > Integrate external event processes using Groovy scripts > Groovy script methods

Groovy script methods

If you are using a Groovy script to integrate external event processes, that Groovy script must implement the methods defined by the ExternalProcessAdapter interface.

The methods that must be implemented by the Groovy script are listed in this section.

init, destroy, and ping Methods

The methods for initializing and closing the Groovy script, and verifying the Groovy script parameters are listed in this section.

init

The init(def args) method is called when the Groovy script is first loaded. The loaded script is cached and called many times. It is only reloaded at startup and whenever the script or the configuration is changed in the Connected Servers manager. A separate instance is created for each connected server that uses this script.

The init(def args) method has one argument, and the properties listed in Properties for init() Method.

Properties for init() Method

Property	Description
Read Properties
`installDir`	OMi root directory.
`logger`	Type `org.apache.commons.logging.Log.` Used to access the logs.
`connectedServerId`	ID of the target connected server.
`connectedServerName`	Name of the target connected server.
`connectedServerDisplayName`	Display Name of the target connected server.
`node`	DNS name of the target connected server.
`port`	Type Integer. Port number of the web service, if any, for the target connected server.
`nodeSsl`	Type Boolean. Indicates if the target connected server web service requires TLS.
`drilldownNode`	DNS name of the target connected server where drill-down may be done.
`drilldownPort`	Type Integer. Drill-down port, if any, for the drilldown service on the target connected server drill-down node.
`drilldownNodeSsl`	Type Boolean. Indicates if the drill-down service requires TLS.
`maxTimeout`	Number of milliseconds to use for timeout on connections. You configure this in the Connected Servers manager.
Write Properties
None	There are no write properties for this method.

ping

The ping(def args)method is called by the Connected Servers manager to determine whether the configuration parameters are correct. If the connected server is reachable using the specified read properties, the ping method returns true, otherwise it returns false.

Properties for ping() Method lists the properties for the ping()method:

Properties for ping() Method

Property	Description
Read Properties
`installDir`	OMi root directory.
`logger`	Type `org.apache.commons.logging.Log.` Used to access the logs.
`connectedServerName`	Name of the target connected server.
`connectedServerDisplayName`	Display Name of the target connected server.
`node`	DNS name of the target connected server.
`port`	Type Integer. Port number of the web service, if any, for the target connected server.
`nodeSsl`	Type Boolean. Indicates if the target connected server web service requires TLS.
`credentials`	Type `java.net.PasswordAuthentication` Credentials, if any, for the target connected server.
`locale`	Type: Locale The desired locale of the properties that are set.
Write Properties
`outputDetail`	Detailed results of the ping operation. This is displayed in the Connected Servers configuration dialog box, and should be in the desired locale.

Methods for Forwarding Events to a Connected Server

The methods for forwarding events to an external event processing application, configured as a target connected server, are listed in this section.

forwardEvent

The forwardEvent(def args) method is called to forward the event to the target connected server. This method has one argument, with the properties listed in Properties for forwardEvent() Method:

Properties for forwardEvent() Method

Property	Description
Read Properties
`credentials`	Type: `java.net.PasswordAuthentication` Credentials, if any, for the target connected server.
`event`	Type: `com.hp.opr.api.ws.model.event.OprEvent` This is the event to be forwarded.
`info`	Type: `com.hp.opr.api.ws.model.event.ci.OprForwardingInfo` Holds information regarding the type of forwarding, that is: `Notify`, `Notify and Update`, `Synchronize`, or `Synchronize and Transfer Control`.
`causeExternalRefId`	If this is a symptom, the cause is set, and the cause has been forwarded to the target server, this property holds the external reference ID of the cause, otherwise null is returned.
Read Methods
`credentials`	Type: `java.net.PasswordAuthentication` Credentials, if any, for the target connected server.
`getEvent(id, includeRefs)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events.
`getEvent(id, includeRefs, includeAnnotations, includeCis)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events. Set the `includeAnnotations` flag to false to exclude annotations. Set the `includeCis` flag to false to avoid pulling related CI information from the RTSM. This will also help to improve forwarding performance.
`getCi(id)`	Obtains details of a configuration item, including all properties. Arguments are of type String. The method returns the specified configuration item, including all properties. Return value is of type `OprConfigurationItem`.
Write Properties
`drilldownUrlPath`	Optional. If set, enables drill-down into the external application in the Event Browser. This is the base path of the URL, and does not include node or port
`externalRefId`	Must be set if forward is successful. Can be any string value.

forwardEvents

The forwardEvents(def args) method is called to forward a list of events to the target connected server. This method is passed a single argument, that contains a list of events to forward, as well as some utility methods. There is also a method to set the forward result of each event in the list. If the forward result is not set for one of the events it will remain in the forwarding queue and will be retried on the next call to the groovy script. The result for each individual event may be set to success or failed. This method is optional.

The method forwardEvent() has utility methods to enable the groovy script to easily obtain the OprForwardingInfo. BulkForwardEventArgs does not directly provide this utility method. To obtain the OprForwardingInfo for each event, the you can call the method getForwardingInfo(final String serverId) on each event. The serverId is the ID of this connected server and was passed to the groovy script in the InitArgs.

This method has one argument (BulkForwardEventArgs), with the properties listed in Properties for forwardEvents() Method:

Properties for forwardEvents() Method

Property	Description
Read Properties
`credentials`	Type: `java.net.PasswordAuthentication` Credentials, if any, for the target connected server.
`events`	Type: `com.hp.opr.api.ws.model.event.OprEventList` This is the list of events to be forwarded.
Read Methods
`getEvent(id, includeRefs)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events.
`getEvent(id, includeRefs, includeAnnotations, includeCis)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events. Set the `includeAnnotations` flag to false to exclude annotations. Set the `includeCis` flag to false to avoid pulling related CI information from the RTSM. This will also help to improve forwarding performance.
`getCi(id)`	Obtains details of a configuration item, including all properties. Arguments are of type String. The method returns the specified configuration item, including all properties. Return value is of type `OprConfigurationItem`.
`getCauseExternalRefId(symptomId)`	Obtains an external reference ID. Arguments are of type String.The method returns the `cause external reference ID`, if any exists for the specified symptom.
Write Methods
`setForwardSuccess(eventId, externalRefId, crossLaunchUrlPath`)	This method enables setting the success for each individual event, along with the external reference ID and any cross launch URL for that external event.
`setForwardFailed(reason)`	If the bulk forward fails, this method can be called, passing a `Throwable` which describes the reason for the failure to deliver. The reason may be null. The entire list is marked as failed and not retried.
`setForwardFailed(eventId, reason)`	Sets an individual event in the list to failed. This event is not retried. An optional reason may be specified or set to null. If neither `setSuccess()` or `setFailed()` is called for a particular event, the event is retried later.

forwardChange

The forwardChange(def args)method is called to forward the event changes to the target connected server. This method has one argument, with the properties listed in Properties for forwardChange() Method:

Properties for forwardChange() Method

Property	Description
Read Properties
`changes`	Type: `com.hp.opr.api.ws.model.event.OprEventChange` The event changes to be forwarded.
`credentials`	Type: `java.net.PasswordAuthentication` Credentials, if any, for the target connected server.
`externalRefId`	Type: String The ID of the external event that should be updated.
`info`	Type: `com.hp.opr.api.ws.model.event.ci.OprForwardingInfo` Holds information regarding the type of forwarding, that is: `Notify`, `Notify and Update`, `Synchronize`, or `Synchronize and Transfer Control`.
`event`	Returns a copy of the event in its current state. The attributes of the event reflect the current state of the event at the time this call was made, and not the state when the change occurred.
`causeExternalRefId`	If this is a symptom, the cause is set, and the cause has been forwarded to the target server, this property holds the external reference ID of the cause, otherwise null is returned.
Read Methods
`getEvent(id, includeRefs)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events.
`getEvent(id, includeRefs, includeAnnotations, includeCis)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events. Set the `includeAnnotations` flag to false to exclude annotations. Set the `includeCis` flag to false to avoid pulling related CI information from the RTSM. This will also help to improve forwarding performance.
`getCi(id)`	Obtains details of a configuration item, including all properties. Arguments are of type String. The method returns the specified configuration item, including all properties. Return value is of type `OprConfigurationItem`.
Write Properties
None	There are no write properties for this method.

forwardChanges

The forwardChanges(def args)method is called to forward the event changes to the target connected server. This method is passed a single argument, that contains a list of event changes to forward, as well as some utility methods. There is also a set of methods to set the forward result of each event change item in the list. If the forward result is not set for one of the event changes it will remain in the forwarding queue and will be retried on the next call. The result for each individual event change may be set to success or failed. This method is optional.

This method has one argument (BulkForwardChangeArgs), with the properties listed in Properties for forwardChanges() Method:

Properties for forwardChanges() Method

Property	Description
Read Properties
`changes`	Type: `com.hp.opr.api.ws.model.event.OprEventChangeList` The event changes to be forwarded.
`credentials`	Type: `java.net.PasswordAuthentication` Credentials, if any, for the target connected server.
Read Methods
`getCi(id)`	Obtains details of a configuration item, including all properties. Arguments are of type String. The method returns the specified configuration item, including all properties. Return value is of type `OprForwardingInfo`.
`getEvent(id, includeRefs)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events.
`getEvent(id, includeRefs, includeAnnotations, includeCis)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events. Set the `includeAnnotations` flag to false to exclude annotations. Set the `includeCis` flag to false to avoid pulling related CI information from the RTSM. This will also help to improve forwarding performance.
`getCauseExternalRefId(symptomId)`	Obtains an external reference ID. Arguments are of type String.The method returns the `cause external reference ID`, if any exists for the specified symptom.
`OprForwardingInfo getForwardingInfo(change)`	Obtains details of the forwarding information, including all properties. Arguments are of type String. This method gets the `OprForwardingInfo` for the specified event change. The external reference ID can be obtained from this forwarding info.
Write Methods
`setForwardSuccess()`	Sets success for all changes in the list.
`setForwardSuccess(changesId)`	Sets success for the specified change in the list.
`setForwardFailed(reason)`	Sets all changes in the list to failed. A reason may be specified in the form of an Exception, or null may be specified. If set to failed, the changes are not retried.
`setForwardFailed(changeId, reason)`	Set the specified change to failed. This change is not retried. If neither `setSuccess()` or `setFailed()` is called for a particular change, the change is retried later.

Methods for Receiving Synchronization Data from a Connected Server

The methods for receiving synchronization data from an external event processing application, configured as a target connected server, are listed in this section.

Note These methods are only needed if the connected server supports the synchronizing back of event changes from the connected server.

receiveChange

The receiveChange(def args) method is called when the connected server sends an event change to the Event Synchronization Web Service. This method has one argument with the properties listed in Properties for receiveChange() Method:

Properties for receiveChange() Method

Property	Description
Read Properties
`event`	Type: OprEvent A read only copy of the event in its current state, before any changes are applied. This is for read-only. To update the event set one of the writable properties of the arguments.
`externalEventChange`	Type: String The payload of the web service call (PUT or POST) received from the connected server when a change is synchronized back from the connected server.
`info`	Type: `com.hp.opr.api.ws.model.event.ci.OprForwardingInfo` Holds information regarding the type of forwarding, that is: `Notify`, `Notify and Update`, `Synchronize`, or `Synchronize and Transfer Control`.
`locale`	Type: Locale The desired locale of the web service caller.
`externalRefId`	Type: String The ID of the external event that should be updated.
`causeExternalRefId`	If this is a symptom, the cause is set, and the cause has been forwarded to the target server, this property holds the external reference ID of the cause, otherwise null is returned.
Read Methods
`getEvent(id, includeRefs)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events.
`getEvent(id, includeRefs, includeAnnotations, includeCis)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events. Set the `includeAnnotations` flag to false to exclude annotations. Set the `includeCis` flag to false to avoid pulling related CI information from the RTSM. This will also help to improve forwarding performance.
`getCi(id)`	Obtains details of a configuration item, including all properties. Arguments are of type String. The method returns the specified configuration item, including all properties. Return value is of type `OprConfigurationItem`.
Write Properties
`eventId`	ID of the event.
`title`	Title of the event.
`description`	Description of the event.
`solution`	Solution of the event.
`severity`	Severity of the event.
`priority`	Priority of the event.
`state`	State of the event. If set to `closed` or `resolved`, the state of the event is set to `closed`. Setting the event to any other value sets the state of the event to `open`.
`cause`	ID of the cause event.
`assignedUser`	Type: `com.hp.opr.api.ws.model.event.OprUser` Name of the user who is responsible for solving the event's underlying problem.
`assignedGroup`	Type: `com.hp.opr.api.ws.model.event.OprGroup` Name of the group to which the event's assigned user belongs.

Additional Methods

Additional methods are provided for transferring the control of an event, annotations, custom attributes, configuration items, and for accessing the HTTP requests and responses.

receiveChanges

The receiveChanges(def args) method is called when the connected server sends multiple event changes to the Event Synchronization Web Service. This method is passed a single argument, that contains the payload sent by the external processing server to the Event Synchronization WS endpoint /opr-gateway/rest/9.10/event_change, as well as some utility methods. It is expected the payload contains a list of changes. It is up to the groovy script method to interpret the list of changes and apply them to an event. This is done through a utility method to create a ReceiveChangeArgs object for each event that is to be changed and setting the changes in that object.

This method has one argument (BulkReceiveChangeArgs) with the properties listed in Properties for receiveChanges() Method:

Properties for receiveChanges() Method

Property	Description
Read Properties
`externalEventChanges`	Type: String The payload of the web service call (PUT or POST) received from the connected server when one or more changes are synchronized back from the connected server.
`locale`	Type: Locale The desired locale of the web service caller.
Read Methods
`getEvent(id, includeRefs)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events.
`getEvent(id, includeRefs, includeAnnotations, includeCis)`	Enables getting a specified event. If the event exists and the application has access to it, it is returned, otherwise null is returned. If the caller wishes the references to be resolved, set `includeRefs` to true, otherwise false. These references include history lines, all properties of related CI, and event relations such as symptom events. Set the `includeAnnotations` flag to false to exclude annotations. Set the `includeCis` flag to false to avoid pulling related CI information from the RTSM. This will also help to improve forwarding performance.
`getCi(id)`	Obtains details of a configuration item, including all properties. Arguments are of type String. The method returns the specified configuration item, including all properties. Return value is of type `OprConfigurationItem`.
`getHttpRequestHeader(name)`	Obtains the specified header. Header may be specified more than once. All instances specified are returned.
`getReceiveChangeArgs(id)`	Gets the `ReceiveChangeArgs` object for the specified event. It is automatically added to the list of events to be changed. The methods provided by `ReceiveChangeArgs` can be called to apply the appropriate changes to the specified event.

Methods for Retrieving Data from a Connected Server

The methods for retrieving data from a connected server are listed in this section.

getExternalEvent

The getExternalEvent() method is called when the operator requests the current representation of the external event. When the operator opens the Event Details in the Event Browser and selects the External Info tab, or uses the context menu in the Event Browser, the getExternalEvent() method is called to get the latest copy of the external event, and display selected fields in the Event Browser. This method has one argument with the properties listed in Properties for getExternalEvent() Method:

Properties for getExternalEvent() Method

Property	Description
Read Properties
`externalRefId`	The external reference ID, identifying the external event to get.
`credentials`	Type: `java.net.PasswordAuthentication` Credentials, if any, for the target connected server.
`locale`	Type: Locale The desired locale of the properties that are set.
Write Properties (All are of type String)
`title`	Optional. Title of the external event.
`description`	Optional. Description of the external event.
`assignedUser`	Optional. User assigned to the external event.
`assignedGroup`	Optional. User group assigned to the external event.
`severity`	Optional. Severity of the event.
`priority`	Optional. Priority of the event.
`state`	Optional. State of the event.

Method for Supplying Data to a Connected Server

There is also a method for supplying data to a target connected server.

Management of Groovy Script Methods

The Groovy script methods run under a separate Java Security Manager. The following permissions are denied by the Java Security Manager:

access to the System.exit()call
java.lang.RuntimePermission only for target exitVM:

http://java.sun.com/javase/6/docs/api/java/lang/RuntimePermission.html

Send Help Center feedback