Configuring Actions Triggered by Events

The list of actions displayed in the drop down menu is configurable, and you can define actions to open or update trouble tickets, telnet or ssh to a remote host, or run any other script or command. Actions are defined in XML files located in the following directory of the DGE or DGE extension you want to configure: <TRAVERSE_HOME>/plugin/actions/.

After editing the files, you should reload the web application.

For on premise instances only: if the send-from is set to DGE, then you must reload the DGE also (you do not need to RESTART the components). See Reloading Configuration Files on how to reload configuration files.

Defining an Action

Change directories to the Traverse plugin actions directory.
For example, execute the following command from a UNIX shell prompt:
cd <TRAVERSE_HOME>/plugin/actions/
Create a new file with a name using the following format, where 'nn' is a number between 00 and 99, and `xyz' is a descriptive name for the action event: nn_action_xyz.xml.
Edit the file you just created, and add a new action-item definition using the following syntax:
<action-item enabled="true|false">

<name/>

<type/>

<target/>

<parameters/>

<timeout/>

<send-from>dge|bve</send-from>

<on-demand>true|false</on-demand>

<input>

<name/>

<caption/>

<type/>

<size/>

<default/>

<required/>

</input>

</action-item>

The following table describes the elements that can be used in an action-item definition.

Action-item Elements

Element	Value/Description
action-item	enabled="true\|false" If true, the action will be shown in the Event Manager, and the content of name appears in the drop-down list of actions.
name	ASCII text
type	regular-email \| compact-email \| script \| url
target	Depends on the action type.
parameters	All the variables for plugin actions can be used in action-item definitions (see Actions and Notifications and the Traverse Developer Guide & API Reference). The following variables are also available: ${login_user} ${represented_user} ${message_id}.
timeout	Value in seconds. A value of 0 means do not wait for completion.
send-from	dge \| bve
on-demand	true \| false Always set to true for now.
input	Contains the following elements to define the fields for an interactive pop-up form when the action is triggered: name: ASCII text caption: name on pop-up form type: text size: width of text box default: default value required: true \| false

Action Type Parameters

Type	Target	Parameter
script	relative path	cmd line args
url	url	none
email	to	none

The templates for emails that are sent out (regular_email.xml and compact_email.xml) are located in the <TRAVERSE_HOME>/etc/actions/ directory since these templates are also used by the action framework. See Actions and Notifications.