control

The control service allows to control the behavior of the underlying systems. It provides read/write support for control set-points and access to the list of alarms within the specified period. Basing on the current values of the set-points the system could adjust its behavior. Read/only set-points can be used to report various system information before it would be logged into the database, and the alarms are used to report the special conditions in the system operation.

The control interface should be provided by the READER abstraction. If the control interface is not provided directly, the default behavior is to associate the most recent logged data with the control set-points. All set-points are considered read-only and empty alarm list is returned upon the request.

Supported targets

• get - Return the current values of specified controls
• set - Set the values of specified controls
• alarms - Get a detailed list of alarms for the specified period (for each alarm type all intervals when it was registered are listed)
• alarms_summary - Get a brief list of alarms for the specified period (for each alarm only information how often it have been seen is presented)
• alarms_current - Get a list of the existing special conditions (active alarms)
• status - Return the current values of the specified controls and all active alarms

Mandatory Properties

• target - Control target (see section above)
• db_server ? - Data source
• db_name ? - Database name
• control_group ? - Control Group, the control groups can be and offten are different from the loggroups

Optional Properties

• control_mask ? - The comma-separated mask of items within the control group, if mask is not specified all group items are considered
• control_values ?
• control_set ?
• control_check ?

Returned Result

The XML document with the values of current set-points (get, set, and status targets) and the list of alarms (alarms_* and status targets) is returned. The following examples are illustrating the format: