OnlineMonitoringSystemOMSTutorial < Main

Main Web>MyTopics>OnlineMonitoringSystemOMSTutorial (2020-06-23, AivarasSilale) (raw view)

----+ Online Monitoring System (OMS)
The CMS Online Monitoring system (OMS) is an upgrade and successor to the CMS Web-Based Monitoring (WBM) system, which is an essential tool for shift crew members, detector subsystem experts, operations coordinators, and those performing physics analyses.

%TOC%


---++ OMS instances

The application has two instances:

   * Production: https://cmsoms.cern.ch/
   * Development: https://cmsomsdet.cern.ch/


---++ Grants to edit OMS workspaces

---++ Grants to edit production OMS
In order to edit OMS pages for specific workspaces, you have to be granted by username or by e-group.

   * Tracker - *cms-tracker-OMScustomization*
   * HGCAL - *cms-hgcal-database-oms-edit-access*

---++ Grants to edit development OMS
User has to send headers to OMS.

We recommend to use browser extension - ModHeader.

Headers:

Adfs-Login               *asilale*
Adfs-Fullname         *User name and Last name*


---++ OMS Tutorial
---+++ OMS structure
It is important to understand the structure of OMS. 

   * Workspace – top-level container defines organizational unit, sub-detector, etc. 
   * Folder – lower-level container contains Pages organized by context. 
   * Page – lowest-level content container contains one or more Portlets. 
   * Controller - (optional) component allows the user to filter the result set. 
   * Portlet - a content presentation 
     <br />
     <img src="%ATTACHURLPATH%/structure.png" alt="structure.png" width="1404" height="206" /></verbatim>

---+++ Controller
The controller allows the user to filter data. But controllers have to be created by developers. Users can just reuse controllers. It is important to understand, that controller use selectors.
   * *Selector* - one or multiple parameters that the main purpose to filter data. The user has to create selectors (elements which will be selected in the controller and transferred into portlets to filter data).
   
In order to create a controller, a user has to go to the widgets management area as shown in the example below.

<br />
     <img src="%ATTACHURLPATH%/controller.gif" alt="controller.gif" width="1549" height="708" /></verbatim>

---++++ Selectors
First of all, the user has to create selectors as shown below.
He has to fill all the necessary fields and select the type of selector. 

<br />
     <img src="%ATTACHURLPATH%/selector.png" alt="selector.png" width="1336" height="714" /></verbatim>

---++++ Controller Component
When selectors are created the next step is to create *Controller Component*. The component name has to be the same as the controller written in code. In our example *MyExampleController*.

Below the Component name, the user can write the description of the component configuration. At this moment we don't have generic component with configuration with all details.
In the example just shown that user let other users know that this controller component requires to describe resthub URL.

<br />
     <img src="%ATTACHURLPATH%/controllerComponent.png" alt="controllerComponent.png" width="1505" height="744" /></verbatim>

---++++ Controller
This is the final step while creating a controller before using it!

In the example below show that user creates *controller* and fill all fields. Also, fill configuration as required.
Because user wants to transfer selected data from controller to portlets he selects which *selectors* he add to this controller.

<br />
     <img src="%ATTACHURLPATH%/controller.png" alt="controller.png" width="1913" height="959" /></verbatim>

---+++ Edit Page/Folders
The gif below shown how privileged user can create new folders and pages by selecting the controller for the page. Change the order of pages and folders.
    <br />
     <img src="%ATTACHURLPATH%/page.gif" alt="page.gif" width="1618" height="737" /></verbatim>

---++++ Add Portlet into page
A privileged user can easily add, remove, resize or even change position or portlets.



---+++ Create table
A user simply can create table in two different ways. In both ways steps are similar almost till the end.

   * Create component for Table. We already have a component for resthub table. So the user simply has to go to 2nd step unless he created a specific component of the table by himself.
   * Create a table. In different sections below are shown two different ways to create a table. 

---++++ Table with selectors (to use controller filter)
In our example, we use IV Curves controller where we have 2 selectors: Run Name and Sensor Type. 

<br />
     <img src="%ATTACHURLPATH%/ivselector.png" alt="ivselector.png" width="1611" height="934" /></verbatim>

The picture above shows that we have a configuration for this table.

<verbatim>
{
  "parameters": {
    "tracker_runName": {
      "selector": "tracker_runName"
    },
    "tracker_sensorType": {
      "selector": "tracker_sensorType"
    }
  },
  "query": "SELECT * FROM trker_int2r.tracker_sensor_iv_v c WHERE c.SENSOR = :tracker_sensorType AND c.RUN_NAME = :tracker_runName",
  "resthubUrl": "/tracker-resthub"
}
</verbatim>

it is important to understand that the parameters - selectors, which we use in our query. A query could be simple as this or much more difficult with joins, ordering, sorting, different column names and much more. Basically as SQL.

In our example, we select all data from *tracker_sensor_iv_v* view where sensor and run_name will be elements selected in the controller.

---++++ Dummy table
This table similar to the table with selectors. Just a different thing is that this table doesn't expect to go get data from the controller.
    
The picture below shows how it looks like.
  <br />
     <img src="%ATTACHURLPATH%/dummytable.png" alt="dummytable.png" width="1534" height="895" /></verbatim>

---+++ Difference between tables
GIF below shows how we can add both tables to page and what is the difference.

In example added both created tables. And we can see, that if we change data in controller only one table changes accordingly. 
It also showed how the user can filter data even in a dummy table. Also how to add or remove columns.

<br />
     <img src="%ATTACHURLPATH%/differenttables.gif" alt="differenttables.gif" width="1629" height="937" /></verbatim>

---+++ Create Dynamic Linear chart
At this moment (January of 2020) we have only one dynamic chart - linear chart. In this example below are shown how to create it. In order to have a chart with different data

There are several steps:

1. Go to charts management menu as shown below.

<br />    <img src="%ATTACHURLPATH%/chart.gif" alt="chart.gif" width="1909" height="1118" />



2. Fill configuration. On the left side, an example is shown.

<verbatim>
{
  "URLDescription": "We use url for resthub service to retrieve data. We should describe which view we use and which columns we want to retrieve",
  "logarithmic": true,
  "logarithmicDescription": "logarithmic could be true or false depends on user. If he wants to have this selection",
  "paramForTitle": "dynamic parameter which we use in url. To have title by selection. e.g tracker_sensorType",
  "resthubUrl": "resthub URL for tracker: /tracker-resthub",
  "series": {
    "0": {
      "name": "Serie name e.g. Temperature (C),",
      "yAxis": "if we have more than 1 y axis, we describe which axis we want to use e.g. 0"
    }
  },
  "title": "chart title e.g. 'CV Curves'",
  "url": "select t.VOLTS volts, t.CAP_PFRD cap, t.RH_PRCNT prcnt, t.TEMP_DEGC temp from trker_int2r.tracker_sensor_cv_v t where t.SENSOR = tracker_sensorType and t.RUN_NAME = tracker_runName ORDER BY t.VOLTS ASC",
  "xAxisName": "X Axis name. e.g. Volts",
  "xAxisObjectName": "this object is described in URL. e.g. volts",
  "yAxes": {
    "0": {
      "reversed": "false or true. if we want to have reversed axis - true ",
      "serie": "Series number to which serie we reflect e.g. 0",
      "text": "Series name, e.g. Temperature (C)",
      "yAxisObjectName": "Object name from url. e.g. temp"
    }
  }
}
</verbatim>

For e.g. for cv data we have the configuration like this:

<verbatim>
{
  "logarithmic": false,
  "paramForTitle": "tracker_sensor_type",
  "resthubUrl": "/tracker-resthub",
  "series": {
    "0": {
      "name": "Temperature (C),",
      "yAxis": 0
    },
    "1": {
      "name": "CAP,",
      "yAxis": 1
    },
    "2": {
      "name": "RH  (%)",
      "yAxis": 2
    }
  },
  "title": "CV Curves",
  "url": "select t.VOLTS volts, t.CAP_PFRD cap, t.RH_PRCNT prcnt, t.TEMP_DEGC temp from trker_int2r.tracker_sensor_cv_v t where t.SENSOR = tracker_sensorType and t.RUN_NAME = tracker_runName ORDER BY t.VOLTS ASC",
  "xAxisName": "Volts",
  "xAxisObjectName": "volts",
  "yAxes": {
    "0": {
      "reversed": false,
      "serie": "0",
      "text": "Temperature (C)",
      "yAxisObjectName": "temp"
    },
    "1": {
      "reversed": false,
      "serie": "1",
      "text": "CAP (cap)",
      "yAxisObjectName": "cap"
    },
    "2": {
      "reversed": false,
      "serie": "2",
      "text": "RH  (%)",
      "yAxisObjectName": "prcnt"
    }
  }
}
</verbatim>






-- Aivaras Silale - 2019-12-12

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who
gif	chart.gif	r1	manage	1728.2 K	2020-01-07 - 13:20	AivarasSilale
gif	controller.gif	r1	manage	1005.5 K	2019-12-13 - 12:15	AivarasSilale
png	controller.png	r1	manage	74.4 K	2019-12-13 - 12:35	AivarasSilale
png	controllerComponent.png	r1	manage	48.3 K	2019-12-13 - 12:52	AivarasSilale
gif	differenttables.gif	r1	manage	6932.0 K	2019-12-13 - 13:38	AivarasSilale
png	dummytable.png	r1	manage	57.6 K	2019-12-13 - 13:25	AivarasSilale
png	ivselector.png	r1	manage	78.2 K	2019-12-13 - 13:25	AivarasSilale
gif	mypage2.gif	r1	manage	650.6 K	2019-12-12 - 17:24	AivarasSilale
gif	page.gif	r1	manage	769.3 K	2019-12-13 - 12:52	AivarasSilale
png	selector.png	r1	manage	46.1 K	2019-12-13 - 12:35	AivarasSilale
png	structure.png	r1	manage	51.1 K	2019-12-13 - 09:55	AivarasSilale

Topic revision: r6 - 2020-06-23 - AivarasSilale

Main

Webs

Public webs

Welcome Guest

- Cern Search
- TWiki Search
- Google Search
Main All webs

Copyright &© 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback