GT 3.9.4 Component Guide to Public Interfaces: WS MDS Trigger

Semantics and syntax of APIs

Programming Model Overview

The trigger service fits into the aggregator programming model, and can receive data from any aggregator source. Consult the aggregator documentation for further information.

Semantics and syntax of the WSDL

Protocol overview

The trigger service inherits its WSDL interface from the aggregator module.

Operations

The Add operation for the trigger service (detailed in the aggregator documentation) has restriction that the Aggregator Config element must contain an element of xsi:type TriggerRuleType, defining the conditions upon which this trigger registration will fire. This element is documented further in the admin guide.

Resource properties

In addition to the resource properties documented in the aggregator documentation, the trigger service exposes an ActionsFiredCount resource property which counts the total number and average rate of rule firings.

Schema Definition

The TriggerRuleType is defined in trigger-types.xsd in trigger/source

The ActionsFiredCount resource property is an accumulator resource property, which is defined in the usefulrp/schema module.

Command-line tools

Click here to see a nice example of content describing a command-line tool
If there is more than one command-line tool, put bullets up top and copy these topics for each tool

[tool name] for WS MDS Trigger Service

Tool description

[Description of the command-line tool here. ]

Command syntax

[list and describe command-line args here]

Limitations

[describe limitations of the tool here]

Overview of Graphical User Interface

There is no GUI specifically for the Trigger Service. The release contains a tech preview of WebMDS which can be used to display the status of resources registered to a Trigger Service in a normal web browser.

Semantics and syntax of domain-specific interface

Interface introduction

The trigger service provides an API to action scripts, which are executed when trigger rules fire. These take the form of fork-exec executables (written in any language) which are supplied with rule information on stdin and must output status information on stdout.

Syntax of the interface

The syntax of this interface is documented in the Trigger Service Developer's Guide.

Configuration interface

Configuration overview

[high-level characterization of the configuration options for the component here]

Syntax of the interface

[list and describe detailed config info here]

Environment variable interface

There are no trigger service specific environment variables.