Class Input

Defined in: action.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Input() The Input object represents the source events that caused the Action to be executed.

Method Summary
Method Attributes	Method Name and Description
	doAction() In the doAction() method, you will take the normalized input to the Action and use it to perform whatever type of action is necessary.
	get() The get() method is used to fetch data from the input, which will depend on what type of Action is being created.
	getEvents() The getEvents() method fetches the set of events associated with this action??
	getIncident() The getIncident() method fetches the set of events associated with this action.
	normalize() The normalize() method is used to take the raw input data and normalize it into whatever format will be necessary to perform the action.

Class Detail

Input()

The Input object represents the source events that caused the Action to be executed.

See:: Action

Method Detail

doAction()

In the doAction() method, you will take the normalized input to the Action and use it to perform whatever type of action is necessary. If this Action is using an integrator, it will be available as instance.integrator.handle. or instance.integrator.api.
Defined in: release.js.

get()

The get() method is used to fetch data from the input, which will depend on what type of Action is being created. In general the loaded data should just be added as attributes on the current object (this.inputstring = ...). There are several places where JS Actions can be called: 1) Attached to a correlation rule - in this case, the input available to the Action is: - The associated correlated event - The raw events associated with the correlated event - The associated incident (IF CREATED) - All the associated incident data 2) Attached to a right-click menu tool - in this case, the input available to the Action is: - The set of events selected when the menu tool was called - The specific meta-tags selected for passing as arguments to the Action 3) As part of an iTrac workflow - in this case, the input available to the Action is: - ??
Defined in: release.js.

getEvents()

The getEvents() method fetches the set of events associated with this action??

getIncident()

The getIncident() method fetches the set of events associated with this action.

normalize()

The normalize() method is used to take the raw input data and normalize it into whatever format will be necessary to perform the action. This may include complex processing to locate referential data. In general, the normalized data can just be stored as additional attributes on the current object (this.normalstring = ...).
Defined in: release.js.

Classes

Class Input