UI Manual

Objective

This manual helps users of BioUptime when it comes to initial setup, management setup and day-to-day operations.

Creating Super Admin

  1. Browse: open your browser and navigate to http://<ipadress of localhost>:8080/opsa
  2. Login: login with the predefined username and password. If you have not been given other information, use email: victor@optimumbiometrics.com with password: (ask Victor Adolfsson or Babak Goudarzi Pour)
  3. Add Organization: click on “Setup” and enter details for your company (that is the company which will operate the BioUptime server and be logging in to the server)
  4. Add Super Admin: enter information about the first user (Super Admin).
  5. Email sent out: The user you specified should have received an email with an automatically generated password

Site Setup

As the Super Admin account your tasks when logging in for the first time are to verify the installation types and to create other BioUptime users.

Creating other BioUptime users

As the Super Admin you should create more BioUptime users. These users can be of the types “Super Admin”, “General Manager” or “Operator”, learn more about User Roles and Acces Rights here below.
  1. Click on Organization/Administration to get into the listing of organizations
  2. Click on your organization name
  3. Click on “Add BioUptime User”. Input the information necessary and press submit
  4. The user will be created and an email will be sent to the user with an automatically created password so that the user may login and start using BioUptime. By default all BioUptime users will receive any alerts that are triggered to ensure that alerts are taken care of swiftly.
  5. The BioUptime user can after logging in change their password by navigating to http://<ip address>:8080/opsa/jsp/saveChangePassword.do

User Roles and Access Rights:

BioUptime supports three level of user roles and access rights:
  • Super Admin: has the highest access rights and can perform all BioUptime functions. This is the first account that needs to be created and needs to be handled with care
  • General Manager: manager level account that can create new users of same level and create organizations and installations
  • Operator: has the lowest access rights and suited for day to day management and maintenance. operator is able to input data and receive alerts

Creating organization

You should create an organization of type End-customer for each customer that you want to use BioUptime for. If you have in-house installations that you want to monitor you also have to create an organization of type End-customer for those. For example if you have a couple of biometric matching servers then you could create an End-customer organization called “Biometric Matching Business Unit”. When creating an organization you can either set the type to End-customer or to Manufacturer. Please note: the only organization type that can contain/be associated with an installation is End-customer. Manufacturer organizations are those organizations that produces software, devices, etc that you want to monitor.

Creating contacts at organization

To be able to provide the best possible support to your customers it is important that your operators are able to find out who to contact at their site and how they can contact them. You do this by clicking on an organization and then clicking on “Add Contact Person”. There you are able to input the details needed to maintain ways of communicating with them.

Verifying predefined installation types and unit types

As the Super Admin you should verify that the installation types available are according to your requirements.
  1. Select an organization of type End-customer
  2. Click “Add installation”
  3. Check if any of the available (predefined) installation types meets your requirement by clicking on them.

Creating new installation types and unit types and connecting them

We think you most probably want to create new installation and unit types other than those predefined and listed to meet your specific requirement. Here is how you create and associate them:

  1. Add a new installation type and select it
  2. Add already created unit types to your selected installation or first create new unit types and then add them. This is how you connect/associate an installation type with one or several unit types.

Creating an installation and downloading config (XML) file

BioUptime is all about monitoring units in an installation. To create an installation, you click on the organization that you want to create an installation for and click on “Add Installation”. On that BioUptime UI you are asked about details for the installation, such as the name and the type of installation. Upon submitting the information you are offered to download a config file. You should download this and name it appropriately, for example <organizationname>_<installationname>_<installationtype>. That configfile will be used by the technicians responsible for installing the systems which is to be monitored. See “Installing BioUptime agents at an installation”.

Installing BioUptime agents at an installation (a short version)

(Please see BioUptime Agent (API) documentation for more detailed information about this part.)

Installing BioUptime agents (enable monitoring) is about bringing three entities together:
  • Configfile (see “Creating an installation and downloading config (XML) file”)
  • BioUptime client side code
  • Unit to be monitored (e.g. biometric scanning device, server, web service, website, usb module etc.)
The BioUptime client side code could be a standalone application responsible for doing the actual monitoring of the entity or it could be integrated into your existing software, for example a management software. This BioUptime client side code will use the configfile to find out how it should identify itself to the BioUptime server and also where the BioUptime server is located.
Before turning on the BioUptime client the technician should go through the config file and make appropriate updates, all depending on what is being monitored:
  • For each unit type section you may alter the content of
    • <name></name>
    • <location></location>
    • <comment></comment>
  • You may also update your system event time intervall to a value that better suits your needs. This is how many seconds that the BioUptime client will wait before sending a new status message to the BioUptime server.

When the BioUptime client is turned on then it will start being monitored. If you have any questions about this, please don’t hesitate to contact your support contact.

Day to day monitoring operations

Now you are ready to fully use BioUptime. In the day to day operations you will come across and conduct various activities, these include:
  • Receiving alert trigger email
  • Viewing active alerts
  • Analyzing an alert using the event log
  • Contacting a person at the installation having a problem
  • Receiving alert resolved email

Receiving alert trigger email

Whenever a problem occurs at your monitored installations you will get an email about it as soon as the BioUptime server detects that something is wrong. BioUptime classifies different types of alerts and if you need more alert types then contact your support. The email you receive will include information about which unit (that is; which device, server etc has a problem), in which installation and in which organization the problem was detected on. Also included is the type of the alert. Some alerttypes are more critical than others. When the alert was detected is also included. Two times are included in the email; one is the client side time and one is the BioUptime server side time. The reason for this is to help you out when it comes to managing the alert. If you live in Sweden and get an alert from Australia and the BioUptime server is in Sweden then you will be shown both the Australian time of the error and the Swedish time of the error. Then you will, with the help of the swedish time of the error see how recent the alert is, and the australian time tells you whether this happened on office hours or off-office hours. If it is 3.00 AM at the client then perhaps you will have a hard time in finding a contact there who may help you in restoring the unit to an operational state.

Viewing active alerts

Whenever you receive an alert trigger email you should look at the active alerts. Log in to the BioUptime and by default, you will be taken to the Alerts view (if not, then click on Alerts in the menu). There you will see the currently active alerts. Your job is to make sure this list is empty. The alerts list shows you the type of the alert, which unit and unittype that has a probelm and which organization it belongs to. The time shown is the time the alert happened based on the client time. Click on the alerttype or the unit or the organization to find out more information.

Analyzing an alert using the event log

By clicking on the alerttype or the unit you are shown the event log of the unit. This shows you what has been sent from the unit to the BioUptime server. This may hold some extra clues to the reason the alert occured which wasn’t visible in the email. Hence this information is useful for you when it comes to trouble-shooting and analyzing the alert.

Contacting a person at the installation having a problem

When you have analyzed the alert and the event log you might want to call up a contact at the site, especially if the problem persists. It is better that you call them before they are forced to call you. Sometimes you need to physically be at the installation to be able to resolve the problem and the contacts can help you out here. After clicking on the unit in the alert list you click on the organization name. There you will find the list of contacts that may help you out. Click on one of them and find out about the contacts details so you can call or email the contact.

Receiving alert resolved email

When the alert gets resolved you will receive an email about this. This email tells you the unit, the unittype, the organization and installation details, the client and serverside time the problem was triggered and resolved and how long the downtime was. This information is also available after logging in. Just click Resolved Alerts in the Alerts view.

Leave a Reply

Fill in your details below or click an icon to log in:

Gravatar
WordPress.com Logo

You are commenting using your WordPress.com account. ( Log Out / Change )

Twitter picture

You are commenting using your Twitter account. ( Log Out / Change )

Facebook photo

You are commenting using your Facebook account. ( Log Out / Change )

Cancel

Connecting to %s