XML Actions Guide

Defining & Editing XML Action files 

Omniscope Enterprise Editions feature XML Actions process support and permit programmatic (or manual) creation of XML Action Descriptors. These are used to automate the steps involved in refreshing, manipulating and distributing/publishing Omniscope files.

Prerequisites are the same as for running the Scheduler and Generator (for example, you will need to be running an activated Enterprise Edition on a Windows server or PC).

Although you can author XML Actions Descriptors manually, at least initially the easiest way to discover the XML Actions syntax is to use the Enterprise Edition user interface to configure tasks, then inspect the files created. This ensures that each action is well-formed, and you can benefit from the hints given in the dialogs.

To create a new XML Action file:

From the Main Toolbar, go to

(2.4) Tools > Advanced Tools > Edit Enterprise Action Descriptor

(2.5) Settings > Enterprise > Edit Enterprise Action Descriptor

(2.6) Settings > Server > Edit Enterprise Action Descriptor

A file dialog will appear. Choose where you will want to save the new file:

The Create new Action dialog will appear. Choose the type of action you want:

Configure using the dialog that appears; then click OK to save the file in the location you chose.

For more help configuring actions, see Using the Scheduler

To edit an existing XML Action file:

From the Main Toolbar, go to:

(2.4) Tools > Advanced Tools > Edit Enterprise Action Descriptor

(2.5) Settings > Enterprise > Edit Enterprise Action Descriptor

(2.6) Settings > Server > Edit Enterprise Action Descriptor 

The action configuration dialog will appear. Make your changes and click OK. The existing file will be overwritten.

Action file syntax in depth:

(see XML Actions Specification for an in-depth guide to the XML structure with examples)

Invoking the process

Once you have created your XML Actions file(s), open command prompt and type cd to this location (C:\Program Files\Visokio Omnisope), execute the following system command (all on one line):

"C:\path\to\Omniscope\OmniscopeEnterprise.exe" -executeAction "C:\Path\To\My action file.xml"

For example in 2.6+ on 64-bit Windows with a system-wide installation:

"C:\Program Files (x86)\Visokio Omniscope\OmniscopeEnterprise.exe" -executeAction "C:\Path\To\My action file.xml"

For example in 2.6+ with a per-user installation:

"C:\Users\[username]\AppData\Local\Visokio Omniscope app\OmniscopeEnterprise.exe" -executeAction "C:\Path\To\My action file.xml"

We advise you upgrade if you have an older version.

Using this method, each action is executed in a separate Omniscope instance which is started before and closed after executing the action. This has a startup and shutdown overhead of 10 seconds on a moderately powered server. Alternatively you can use the watch folder function to avoid this overhead. 

Other options for OmniscopeEnterprise.exe:

...\OmniscopeEnterprise.exe -streamAction

(expects the XML on the process input stream, e.g. piped from another process)

...\OmniscopeEnterprise.exe -scheduler

(starts the scheduler)