User manual

From Siwenoid Wiki
Jump to navigation Jump to search

Welcome to SIWENOID online User Manual.

This documentation mainly targets operators who has to handle the system. But it is useful for engineers who has to know the terminology of user interface.

Naming of user interface

Entire documentation use the following terms of the different part of user interface.


Event category buttons

Event category buttons correspond to the existence of any non-normal event in its own category. Indicator lamp is blinking if any non-acknowledged event is in the event-queue. It is continuously on if only acknowledged events are in the category queue, and OFF (grey) if there is no any event in its category. Numbers indicate the non-acknowledged/acknowledged events in its own category. Collective acknowledge button allows acknowledging all events in its own category by a single action. Colors correspond to the categories and are reflected throughout the application.


Date/Time and user login

System date and time is synchronized with the server time (server time is gained from that PC on which it is running). It’s not possible to set this time in the application. It should be set through the server OS system date/time tool. Click on the "user" button for user-logout. In the user login window, fill in the new user name and password. User rights are assigned to the different users. User permissions can be set in the application permission menu (mainly by admin rights).


Bottom menu


Bottom menu contains the following buttons:

  • Event log opens the history.
  • Tree opens the datapoint hierarchy.
  • Search opens the search window which allows to find a datapoint by its minimum 3 letters.
  • Note allows you to add a record to the end of Event log (History).
  • Close windows closes all floating windows.


EventView

Click on the header of event category buttons, to filter the records of the queue by its categories. Header buttons ON-OFF state indicate if the corresponding category is shown or hidden in the EventView.


Using the „ON LINE” button, you can freeze temporary the incoming events in the EventView. This is useful when mass of events raise in a very same time and the incoming events make difficult to analyze or handle the most important pending events. EventView is unfreezed in 2 minutes automatically without any user interaction.

Use TIME/CAT buttons to sort the EventView. Choosing the „CAT” button the events are sorted by category. While choosing the „TIME” button events are sorted by the time-stamp (when event occurred in the system). In case of a subsystem that uses timestamps in its communication protocol, this time comes from the subsystem (real-time occurrence). Some subsystem doesn’t use timestamp in its protocol. In this case the management system assigns the time information to the events when it was captured.


At the left side of a record the blinking or continuous status of button indicate the non-acknowledged/acknowledged status of an event. Click on this button to open the intervention text window of the associated datapoint.

At the right side of an event record several buttons reside. Click on the first button to send the default command to the datapoint. Click on the second to open the map that is assigned to the datapoint. Click on the third to open the intervention text if exist. Click on the fourth button to open treatment table. Click on the fifth button to comment an event. Drag&drop the comment to other record too. Click on the last button to open a popup menu to reach more functions.

Datapoint Hierarchy

Use bottom menu to open Datapoint Hierarchy. This contains all datapoint in a tree structure.

Double click on any item to call the corresponding ListView.

Right click on any datapoint, and use popup menu to send a command to a datapoint. In datapoint hierarchy the nodes are extended by icons that indicate special features. These are:

  • Open treatment Datapoint is assigned to a map.
  • Open treatment Datapoint was moved from its original location (engineering).
  • Open treatment Datapoint was renamed on management system level (engineering).
  • Open treatment Datapoint is participant of a permission.
  • Open treatment Datapoint has a script assignment.


Treatment table

Treatment table lists the possible status of a certain datapoint (control unit, area, section, zone,...), and lists the commands that can be sent to a certain datapoint. Lamps indicate the active status and category. Datapoints are multi-state. Blinking or ON lamp correspond to the acknowledged and non-acknowledged status. Click on the lamp Event ack to acknowledge the corresponding event on behalf of management system. This action doesn’t send acknowledge command to the subsystem, it simply stops blinking the lamp and register in history that operator got notification on the event. To acknowledge the subsystem itself you have to click on the appropriate command button Ack command send. In most case datapoint status will be changed after sending a command to subsystem. (ACK-ALARM, EXCLUDE, NORMAL...).

Click on Open map button to open the map that is primary associated with the datapoint. Click on Open listview button to open the ListView that is associated with the datapoint. Click on Open treeview to open the tree. Datapoint will be highlighted for 3 second in the tree.

Treatment Table call possibilities:

  • Click on the second button at the end of a certain event in the EventView Open treatment
  • Click on the Open treatment button on List View, if the datapoint description has a green background Open treatment (it has no child datapoint).
  • Click on the dynamic symbol of a certain datapoint on the map Open treatment.


List View

A ListView is a tool to navigate in the datapoint hierarchy (areas, sections, zones...) in text mode. Their colors and lamps indicate the status of certain datapoints. Possible way to call ListView:

  • Click on any dedicated-container Open ListView to open the associated ListView.
  • On the TreatmentTable click on the Open ListView button to open the associated ListView.
  • On the maps click on the Open ListView button. Now this datapoint-list contains brother nodes of the original one that are normally on the same map.


Click on the button of upmost grey line Open previous ListView to open the parent ListView.
Click on any text button Open map Open map to open the associated map.
If a text button is grey Open ListView if grey then click on its button Open children ListView to go down in the hierarchy and to open its child ListView.
If a text button is green Open ListView if green then click on its button Open children ListView to open its Treatment Table.
Color of a buttons Open children ListView, Open children ListView, Open children ListView and blinking or ON status indicates the status of the corresponding datapoint, or the highest priority status of its children nodes (propagated status).


Maps

Different methods to open a map:

  • In EventView click on Open map button to open the map that is primary associated with the datapoint.
  • On a Treatment Table click on Open map button to open the map that is primary associated with the datapoint.
  • On a ListView click on any text button to open the associated map.

Maps are organized in hierarchy. User can navigate in the hierarchy using the brown button next to a datapoint icon. These navigation buttons normally link those maps that contain the children datapoint of a certain datapoint.

Click on the datapoint icon to open the treatment table of a certain datapoint.

At the left-top corner of a map click on the Open children ListView printer icon to printout the current map by the default printer. Printer settings cannot be changed in application before printing. They have to be predefined in the OS’s printer panel.

At the right-top corner of a map, click on the button to open the ListView window. Normally it contains all datapoint that are linked to this map, or in other words that are brothers of the selected datapoint.

Right-click on an icon and use the popup menu to send a command to the selected datapoint.

A térképen is lehetőség van több adatpont kijelölésére. A kijelölést a Ctrl gomb használatával lehet elvégezni. Jobb gombbal kattintva az adatpont ikonra, a legördülő menüből parancsot lehet küldeni a kiválasztott adatpontoknak.

Event log

Use bottom menu to open EventLog. Records of event log contains all subsystem-events and user-actions that occure in the system. Beside it is possible to add a note to the end of EventLog.

Colors of records corresponds to the category of events (ALARM, PRE-ALARM, WARNING...). Additional colors are used for user-actions (command->lightblue) and user-note (brown).

At the bottom of window a filter section reside. Type in the required date/time or words/letters in the appropriate fields to filter the log. Press ENTER or click on "Accept" button to validate your criteria Open children ListView or click on "Clear" to unfilter your log. Click on Open children ListView button to export the selection in csv format. It can be postprocessed by any Table-processor application then.