User Manual. COBA Server Manager ID UM.L

Transcription

1 ID UM.L User Manual

2 User Manual 2 (15) Index 4 1. General Information Users & Permissions Users Roles Permissions Quick Create Users Services...14

3 User Manual 3 (15) Introduction This document describes the functionality of the, which is the application used to manage COBA Server installations. This document is meant primarily for system integrators and other automation system professionals.

4 User Manual 4 (15) Functionality Description General Information Users & Permissions Services

5 User Manual 5 (15) 1. General Information is the application used for adding and removing services or changing their properties, and management of users and their user rights in COBA Server installation. Typically is used to configure a local COBA Server installation. You can also access a COBA Server installation remotely, when the remote COBA Server computer is also running a SSH server. is used to start the COBA Server, to configure the COBA Server installation, to forward the COBA User Interface ports (to connect with UI Client) and to retrieve and check the log files. When you start the, the following dialog is opened: When connecting to a localhost, no passwords or usernames are needed. To initiate connection to a remote server, click on Servers.. button and define the remote server IP and name. You will also need to provide SSH user credentials for logging in. After successful login, the main screen of the is opened as shown in the following figure:

6 User Manual 6 (15) The includes two main sections, which can be accessed through the main screen or through the tree on the left. Users & Permissions part is used for configuring and setting up user rights. Services part is used for configuring, adding and removing services. The subsequent chapters in this document explain the functionality of these parts. The main screen includes also top level functions, which are located in the toolbar. The functions are described in the following table: Function Description Save configuration changes to COBA Server. Reload Server configurations from the server. This will cancel all unsaved changes. Make a recovery snapshot. This will save the current COBA Server configuration locally, to be used as a backup. Revert to a selected recovery snapshot.

7 User Manual 7 (15) Open a terminal session with the remote server (only available when using SSH connection). Enable UI Client port forwarding to remote server. View COBA Server log files. Start COBA Server with current configurations. Shortcuts to different views on.

8 User Manual 8 (15) 2. Users & Permissions COBA supports multiple users and user roles. Each role can be configured to have different rights for any Control System, Control Group, Information Point or a single Datapoint. Each user is assigned a role with the suitable control rights. A user can have as many roles as needed, and each role can be assigned to one or multiple users. The users and roles are created and configured through the Server Manager. The following figure shows the Users & Permissions view, which is opened by selecting Users & Permissions in the main page of. You can use the buttons in the Users & Permissions view to move to different subsections, or you can navigate using the tree on the left. 2.1 Users Users are added, removed and their properties are changed in the Users view. The view shows a table with all currently existing users. Server Administrators are marked with bold font in the list. Users shown with italic font are ones receiving system alarms. System alarms include alarms generated by the system or server itself, not originated from any point, e.g. communication alarms.

9 User Manual 9 (15) Users can be added or modified through the buttons in the Users toolbar. The functions are as follows: Button Description Add a new user View and edit the properties of a selected user Remove the selected user Export a CVS-file with the following info for each user: Username;Password;Rolemask;Fullname;ServerAdmin By selecting view and edit user properties, the following Edit User dialog is opened.

10 User Manual 10 (15) User credentials are defined in the General tab. Regardless of the role a user is assigned with, he can also be a server administrator. This means that the user is able to login to and make changes to COBA Server settings and configurations. A user is given server administration rights by ticking the Server administrator check box. Additionally, a user can be a receiver of system alarms. The user is given these rights by ticking the Receive system alarms check box. A user is given appropriate control rights over the system by assigning it with a role in the Roles tab. A user can have more than one role. 2.2 Roles User rights are a set of control rights, which are defined for certain user roles. These roles are managed through the. Individual users can have more than one role. Users are added, removed and their properties are changed in the Roles view. The view shows a table with all currently existing roles.

11 User Manual 11 (15) Usually it is enough to have only a few roles for a system. By default, there are three different roles: FullRights (system administrator), PowerUser (experienced COBA system user) and User (standard COBA user). User Roles are defined and modified with the following buttons: Button Description Add a new user role View and edit the properties of a selected role Remove the selected role By selecting view and edit user properties, the following Edit Role dialog is opened. Details of a Role, e.g. name and description, are defined on the General tab of the Edit Role dialog. You can also enable or disable a role. The Users tab shows the users which are assigned with a particular role.

12 User Manual 12 (15) 2.3 Permissions The permission tree is used to edit the control rights a role has. You can do this for any individual Control System, Control Group, Information Point, Datapoint, or you can select a bigger part of the tree and allow a user the same set of rights for all nodes that are part of that branch. For each node in the tree there is a set of four checkboxes per role to set up the control rights. The properties of a permission tree node are defined as follows: Rights Inherited Read Write Alarms Description Role has same control rights for the node as for its parent node Role is able to read the status of a node Role is able to change the status of a node Role receives alarm from the node By default, all nodes inherit the control rights from their parent node. For example, all changes done on the ROOT level are inherited throughout other levels. Thus it is enough to set the proper rights for each role only to the ROOT node and then apply any additional settings. Note that as the ROOT node does not have a parent node it cannot inherit the control rights. The following figure shows the details of the permission tree.

13 User Manual 13 (15) When the control rights of a role over a node are manually set instead of inherited from the parent node, it is marked with a blue exclamation mark and its parent nodes with blue. If a node is completely missing any control rights so that no role has any rights over it, the node is marked with a red exclamation mark. 2.4 Quick Create Users The Quick Create function is for creating multiple roles and users. This creates a desired number of users with a matching role and a random password. The random password is visible in Edit User dialog on the Full Name field. Note: Remember to change the default password and remove it from the Full Name field after changing it. The control rights for these roles can be defined manually through the permission tree. The Quick Create feature is useful in e.g. apartment buildings, where tenants should have control only over their apartment and thus many roles are needed.

14 User Manual 14 (15) 3. Services The services of COBA Server allow the system administrator to add different kinds of features to the server configuration. Some of the services are mandatory to run the COBA, others are used for additional features. The following services are mandatory for COBA Server to function properly: COBA Server COBA JMS Service COBA Database Service COBA Log Service COBA Alarm Service COBA Controls Service All mandatory and optional services are listed and described in the COBA Services Manual. Services are added, removed and their properties are changed in the Services view. The view shows a table with all currently existing services. Disabled services are shown with grey color font, active services with black color font.

15 User Manual 15 (15) You can manage the services with the following buttons in the Services toolbar. Icon Description Add a new service. This opens a list of available services. Access service properties. This opens a dialog for the selected service. Remove an existing service. To change the properties of a service you can double-click the appropriate service, which will open a dialog for easy configuration of a service. The dialog has three tabs: General ServiceProperties Dependencies General: General tab shows general information about a service. General tab is used to enable or disable a service. By disabling a service it will still remain as part of COBA configuration, but the service will not be started. This is useful when setting up COBA as you will not lose any service configurations by disabling it. ServiceProperties: This tab is used to add, remove and change the properties of a service. Properties are added or removed by right-clicking the table and selecting New or Remove. If the box in Required column is ticked, the service cannot be removed. Property value is changed by modifying the cell value of the Value column. When the box in Singleton column is ticked, the same service property cannot exist multiple times on the same service. Dependencies: This tab is used to define which other services should be up and running before a particular service is started. Please refer to COBA Services Manual for more details about COBA Services.