Changes between Version 1 and Version 2 of adeiService_control

Show
Ignore:
Author:
csa (IP: 141.52.232.84)
Timestamp:
09/11/09 01:29:09 (15 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • adeiService_control

    v1 v2  
    11= control =  
    22 
    3  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. 
    4  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. 
     3The 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. 
    54 
     5The 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. 
     6 
     7== Supported targets == 
     8 * ''get'' - Return the current values of specified controls 
     9 * ''set'' - Set the values of specified controls 
     10 * ''alarms'' -  Get a detailed list of alarms for the specified period (for each alarm type all intervals when it was registered are listed) 
     11 * ''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) 
     12 * ''alarms_current'' - Get a list of the existing special conditions (active alarms) 
     13 * ''status'' - Return the current values of the specified controls and all active alarms 
     14 
     15== Mandatory Properties == 
     16 * ''target'' - Control target (see section above) 
     17 * [wiki:adeiParam_db_server db_server ] - Data source  
     18 * [wiki:adeiParam_db_name db_name ] - Database name 
     19 * [wiki:adeiParam_control_group control_group ] - Control Group, the control groups can be and offten are different from the loggroups 
     20 
     21== Optional Properties == 
     22 * [wiki:adeiParam_control_mask control_mask ] - The comma-separated mask of items within the control group, if mask is not specified all group items are considered 
     23 * [wiki:adeiParam_control_values control_values ] 
     24 * [wiki:adeiParam_control_set control_set ] 
     25 * [wiki:adeiParam_control_check control_check ] 
     26 
     27== Returned Result == 
     28The 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: