Changes between Version 3 and Version 4 of adeiService_control
- Timestamp:
- 09/11/09 02:12:55 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
adeiService_control
v3 v4 1 1 = control = 2 2 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.3 The control service allows to control the behavior of the underlying systems. It provides read/write support for control channels and access to the list of alarms within the specified period. Basing on the current values of the channels (set-points) the system could adjust its behavior. Read/only channels 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 4 5 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.5 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 channels. All set-points are considered read-only and empty alarm list is returned upon the request. 6 6 7 7 == Supported targets == 15 15 == Mandatory Properties == 16 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 of ften are different from the loggroups17 * [wiki:adeiParam_db_server db_server ] - Data source / system 18 * [wiki:adeiParam_db_name db_name ] - Database name / subsystem 19 * [wiki:adeiParam_control_group control_group ] - Control Group, the control groups can be and often are different from the loggroups 20 20 21 21 == Optional Properties == 22 * [wiki:adeiParam_time_format time_format] - Specified in which format the timestamps should be returned, by default the UNIX timestamp (seconds since 1970-01-01) is returned (fractal numbers are allowed). 22 23 * [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 24 '''set target''': 23 25 * [wiki:adeiParam_control_values control_values ] 24 26 * [wiki:adeiParam_control_set control_set ] 25 27 * [wiki:adeiParam_control_check control_check ] 28 '''alaram targets''': 29 * [wiki:adeiParam_severity severity ] - the minimal severity of alarms to report 30 * [wiki:adeiParam_limit limit ] - Limits the list of alarms to the specified amount 31 * [wiki:adeiParam_alarm_mask ] - Limit the list of alarms to the specified ID's (comma-separated list of ID's) 32 26 33 27 34 == Returned Result == 28 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 values are returned within the ''data'' xml node and the alarms within ''alarms'' node. See following example for details.35 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 values are returned within the ''data'' xml node and the alarms within ''alarms'' node. See following example for details. 29 36 We are requesting the list of active alarms and current values of the ''control_group'' with id ''0''. 30 37 {{{ 49 56 {{{ 50 57 <result> 51 <Error>Unknown list target (wines) is specified</Error>58 <Error>Unknown control_group (0) is specified</Error> 52 59 </result> 53 60 }}} 61 62 The following properties are returned for each requested control channel: 63 * ''db_server'' - data source / system 64 * ''db_name'' - the database / subsystem 65 * ''control_group'' - control group 66 * ''id'' - the id of the control channel returned 67 * ''name'' - the textual description of the control channel 68 * ''value'' - the current value of the channel 69 * ''timestamp'' - the time when the current value was set 70 * ''verified'' - the time when the current value was last verified 71 * ''obtained'' - the time when ADEI get the value from the underlying system 72 73 The following properties are returned for each alarm: 74 * ''severity'' - importance of the alarm, the bigger number the more important it is 75 * ''in'' - the time when the special condition was first seen 76 * ''out'' - the time when the special condition has disappeared, empty value means the condition is still present 77 * ''id'' - the alarm ID 78 * ''name'' - the textual description of alarm 79 * ''description'' - the detailed description of the alarm (advice of actions to perform, etc.)
