waltz-controls/waltz

A general purpose web application that provides the interface between SCADA(s) system and the scientific users who define and calibrate their experiments

SonarCloud

Documentation

Waltz User/Developer guides

Waltz API reference

Other useful resources

Videos

[1] UI and features presentation, 2018

[2] Tech stack presentation: Waltz (ex. TangoWebapp) + Tango REST + Tango Controls, 2017

[3] Waltz Workshop@DESY, 2019, part I

[4] Waltz Workshop@DESY, 2019, part II

[5] Waltz Workshop@DESY, 2019, part III

[6] Integrating React based widget into Waltz

Slides

[1] TangoWebapp Insights, 32 Tango Users meeting, 2018

Live demo

To run the live demo click on the image

User: tango-cs Pass: tango

Getting started

1. Execute docker-compose.yml using docker-compose i.e. docker-compose up
2. Open browser and navigate to http://localhost:8080/waltz
3. Login using tango-cs/tango
4. Explore Tango Controls via Waltz...

Developer requirements

• Tango Controls environment (tested on Tango 9.3+)
• Tango REST Server that supports API spec version v1.1 (tested on rest-server-2.1)
• User-Context
• Web server that can handle .war files (tested on Apache Tomcat 8+)

Build

This project uses npm and webpack for high level build operations:

$> npm install
$> npm run build

Extra parameters may ne passed to ant script to define default Tango REST API endpoint and/or Tango host:

$> REST_API_PROTOCOL=[http|https] REST_API_HOST=[ip/fqdn] REST_API_PORT=[e.g. 10001]  \
   TANGO_HOST=[ip/fqdn] TANGO_PORT=[e.g. 10000] \
   npm run build

Implementation details

• Webix is used for UI
• CodeMirror is used for scripting console
• Plotly is used to display plots and images

Misc

When using Waltz, please cite:

I.Khokhriakov, O. Merkulova, F. Wilde, Waltz – A Platform for Tango Controls Web Applications, Proceedings of ICALEPCS2019, WESH3003, 2019 icalepcs2019/papers/wesh3003.pdf

waltz's Issues

FR: clone device

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

Clone a device with db meta data (properties, attributes config, etc) from one tango host to another

• add menu item to device ctx menu (clone to...)
• add popup with destination choice

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/27

LogViewer widget

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj,

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/2

FR: multiple tango hosts in the device (server) tree

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

• replace refresh btn with add (+) in the main toolbar
• add context menu for tango host in the device/server tree: refresh | remove | info

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/26

Associate log with a user

subj

Cannot load device tree when tango database is not accessible

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

Jive somehow manages this situation. Investigate

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/30

Travis build passes even though gradle not

subj

Handle errors

User must receive a feedback if anything goes wrong.

Currently the most urgent is to handle 401 response code.

Implement login

• Overlay screen;

• login/out;

• personal account

Log console

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/24

Device panel abstract tab

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

Refactor code of device panel so that it uses a single abstract tab view

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/12

Remember user defined REST_API and TANGO_HOST

subj.

Not unique ID warning expanding tree after refresh

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/19

Tango REST API wrapper

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

aka

#!javascript

new TangoREST({url:'...'}).devices().get('...') => promise

where get will emit GET response and handle error response (console.error + webix.message)

Same for PUT, DELETE etc

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/9

Implement DB filter

User must be able to specify which devices he/she wants to see in the tree

UI redesign

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

UI should look like visualvm

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/13

main toolbar's refresh button duplicates existing db

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/20

Application does not load

If fresh copy of the application (in production mode) is open, it does not load properly. Seems to be webix problem, or tomcat setup. See related issue

Handle errors

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj.

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/7

Implement bottom toolbar with loading icon

Bottom toolbar should provide:

• user with ajax operation feedback (UI)
• platform must provide API to the components, i.e. when ajax operation is invoked icon should be updated with 0-efforts

TreeView widget

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/1

Dynamic tabs close button is not centered when tab is too small or label is too long

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/14

Implement device panel log view using logger widget

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/28

Dock TestDevice window in the right vertical panel

• Expandable side bar
• move list into form and mark it as required
• implement buttons (use new Platform API e.g. attribute.read())
• implement output (store result in corresponding field of the entity instance e.g. attribute.values)
• reuse plot and image (depends on #40)

Restore open tabs after page refresh

https://docs.webix.com/desktop__app_state.html

TANGO_HOST as tree root

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

Device/Server tree must have TANGO_HOST as its root, i.e.

localhost:10000
   |
   |--- test
   |--- sys
   |
...

Root must be editable. When changed corresponding device/server tree is loaded.

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/15

Migrate to RC3

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/21

Remeber all tango_host added to the tree after page refresh

subj

Context menu in tree view

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj.

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/8

Redesign main window

A carousel with getting started slides should be good enough (full window)

- [x] show message (and log) after rest refresh

Device admin panel [5d]

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/16

Packaging and CI

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj.

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/18

Force device info update each time user clicks it in the device/server tree

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

or add context menu item

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/29

Device object

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

aka DeviceProxy

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/10

Server Wizard

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/17

Integrate with RC4

• support multiple hosts
• support new image format

readme.html

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

Getting started etc

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/5

DevicePanel widget

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/4

Database object

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

Using webix Database proxy can even return values

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/6

DeviceInfo widget

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj.

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/3

Refactoring: device model

Device model with methods: asWebixTreeNode(), asTab(). Contains device proxy.

Write/plot buttons does not become active

subj

Create GitHub release with gradle

subj.

Refactoring: DataBase Model

Same as #32, but for DataBase, i.e. asWebixTreeNode(), asWebixTab(); contains tango_host and db proxy.

Release 0.1

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

• DeviceInfo/Polling apply does not update
• DeviceInfo/Events tab values are not editable
• DeviceInfo/Events apply is not implemented
• DeviceInfo/AttributesConfig use multiple info read
• [v.0.2] DeviceInfo/AttributesConfig apply only update changed attributes
• DeviceInfo/AttributesConfig/Alarms is not updated after editing/apply does not work
• [v.0.2] DeviceInfo/PipesConfig is not implemented
• DeviceInfo/Logging is empty
• MonitorDevice/Scalar alarm/warning highlighting (header + rows)
• MonitorDevice/Spectrum/Image do not show data
• DevicePanel/Attributes info is not updated
• [v.0.2] DevicePanel/Admin is not implemented
• [v.0.2] DeviceTree/LogViewer is not implemented
• [v.0.2] ServersTree is not implemented
• StartPage is empty
• ServerWizard fails
• [v.0.2] ServerWizard add devices to the tree without refresh
• packaging and CI

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/22

Cache attributes, commands and pipes infos on the client

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj.

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/11

REST API and TANGO_HOST validation

Simple check for non emptiness is enough for the beginning.

Migrate to webix 3.4

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

subj

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/23

Add refresh button for tango host

in the list of all tango hosts

Replace big Logo in the main view with a small one in left corner of the top toolbar

subj

FR: tango hosts drop down list

Originally reported by: Ingvord (Bitbucket: Ingvord, GitHub: Ingvord)

---

entered tango hosts can be cached and then used in drop down list (text suggestion) so users do not need to enter same tango host several times

---

• Bitbucket: https://bitbucket.org/tango-controls-collaboration/feature-request-6-tango-webapp/issue/25