hurence / logisland.historian Goto Github PK

USER STORY

As a user, I want to be able to zoom in/out on each chart type so that I can select a time interval of data accordingly to my mouse selection

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

Ensure that the UI is component-based and that the components developed meet the following criterias :

• They can be reused outside of the historian
• They can use multiple widget libraries
• They support reactive design (support mobiles, tablets, PC)
• Support latest version of all common browsers (including IE 11), with focus on Firefox, Chrome, Edge.
• Have an open-source license

Also investigate:

• choice of build tools
• js vs. typescript

USER STORY

As a user, I want to be able to import historical tags data in the form of CSV files so that I can easily
bulk load some existing tags

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As an operator, I want the data collection to be smart enough to adapt sample rate accordingly to data change rate so that I saturate my database neither the network bandwith

It is used to:

• adjust the data sampling rate according to the current real time process state,
• keep the bandwidth and costs on the preset level,
• avoid transmitting unnecessary data.

According to the OPC specification, the scanner module is responsible for keeping the cached data fresh, but it is worth stressing that “freshness” of the data depends on the process state and can change in time drastically. The communication server (in order to optimize the data transfer costs) should adapt the sampling rate to current process control needs.

Logisland Historian must provide an OPC gateway

Logisland.Historian follows the requirements of the OPC specification to provide data access to OPC clients. It implements OPC Data Access (DA) version 2.0a and 3.0. of the OPC custom interface. Furthermore, Logisland.Historian is optimized for high performance and uses multithreaded technology to provide efficient response to client requests. This approach allows multiple clients to connect to and effectively use resources of the server.

Technical concern here : OPC DA is a Windows only feature based on DCOM, how do we make the bridge with JAVA cross platform world ?

frameworks and tools can be found here : http://www.opcconnect.com

USER STORY

As a user, I want to add a data source or multiple data sources so that when i have selected a or multiple data source i can select tags. I want to be able to edit or remove a data source

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a use, I want to schedule daily, hourly, minutely data pipeline transfer from one datasource to another so that I can backup or move data from the historian to another target

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As an admin, I want to be warned by email if no data has been recorded since n minutes so that I check if something went wrong or not

ACCEPTANCE CRITERIA

1. Cut off a previously working OPC server polling stream for more than threshold time
2. check that we received an email

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

Kerberos is supported

USER STORY

As a user, I want to be able to browse all the tags offered by an OPC server so that I can search, filter on groups/tag name and save a selection of item values to be regularlry polled into the historian.

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user, I want to setup a connection to an existing datasource such as on OPC server, an MQTT broker, a kafka topic, an ftp site, a filesystem so that in can browse available tags, retrieve or inject data

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user i want to be able to share a graph or part of a graph so that a colleague can see what i'm talking about

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user, I want to replay the history of event changes for selected tags in my dashboard so that I can be helped to understand what happened right before a threshold has been crossed for example

I also want the alarms sets for example on thresholds (all of them) to be generated in a simulation window to show through alarms what went wrong at which time etc. The use case is diagnosis on data that we import to understand "what happened".

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

Not sure on which granularity the access rights should be set, but a minimum access rights must be provided on time series data ? on dashboards in the future ? etc. if the time serie is an heart beat from a patient in an hospital not all should be able to see this heart beat ? same if the tool is used to monitor hundreds of private homes in the future ...

USER STORY

As a user, I want to browse or query data through a standalone server, not a SolrEmbeded one.
This server must provide REST API as well as grapher html files

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user I want to able to smooth (moving average) my data points so that I can visualise more clearly highly oscillating values

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

It is possible to connect the data historian to an LDAP directory (normally vert.x supports this) to authenticate people. A default should also be supported (simple files ?).

The data historian data must be allow access through SQL from the U to be able to drill down on particular issues.

It is possible to create PDF reports from specific sensors data / dashboards so as to create documents that an auditor can give to a customer (ex. Vincent).
Automate the generation of reports and deliver them in multiple at custom intervals (e.g. hourly, daily, weekly, or monthly). Deliver reports as Word or Excel documents, PDFs, and HTML files or even sent directly to a networked printer

USER STORY

As a user, I want to see trends on historical values so that I ca detect weak signals, or predict system behaviour before it actually happens

ACCEPTANCE CRITERIA

1. visually display trends on my line charts

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a < type of user >, I want < some goal > so that < some reason >. (ex:As a user, I can backup my entire hard drive.)
as a user i want to be able to filter by date range

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user, I want to create basic or calculation tags so that I can manage alias or formula based dynamic tags

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user, I want to read a good documentation so that I don't waste my time finding out how to make it work

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

Thresholds must not only support to be a triggered when crossing a hardcoded value, but should also support to be configured to be crossed when being (for example) twice as much as the value of another time serie or the difference between two time series.

Thresholds can be set from a dynamic tag value

To support that, we need an expression language to express formulas => this can be done via aliasing

It is possible to embed vectorial designs (3D from CAD tools etc.) and position sensors on them and have this act as a map of problems (with colored points appearing on the designs when problems arise showing where the problem is...). Will serve to model floors, machines, pieces, and to locate sensors and therefore defects...

When a threshold is crossed, it should be able to trigger an action.
the supported actions must be :

• send an email
• send an SMS
• send a REST call (configurable)
• execute an external binary/script

It must be possible to attach to the email or the SMS an graph with the latest values of the sensor

All graphical representations must allow to display the threshold values as horizontal lines on graphs.

Security is a big concern, so it deserves a whole big Epic for itself

It is possible to extract data in Excel format as to be able to build reports/analysis/graphs outside of the data historian to give to customers

USER STORY

As a user, I want be able to select the language of the interface so that I can understand the product even if I do not speak english.

ACCEPTANCE CRITERIA

1. Use of Java ResourceBundle
2. Support of 2 languages (en, fr)

With the I18N support, we will be able to address the Localization into many languages

DEFINITION OF DONE

• Use of Internationalization framework (I18N) provided by Java
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

The data historian must support access to the data from third party tools using JDBC.
some use cases can be :

• monitoring using third party console
• data scientists accessing the data from R
• ...

data historian should support some industry standard for thresholds and alarms.
One that seems to have traction is "ISA 18.2-2009 & EEMUA 191"

https://www.google.fr/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&ved=0ahUKEwjX6a3FiKDaAhVQ3qQKHfztCs0QFggoMAA&url=https%3A%2F%2Fwww.isa.org%2Fstandards-and-publications%2Fisa-publications%2Fintech-magazine%2Fwhite-papers%2Fpas-understanding-and-applying-ansi-isa-18-2-alarm-management-standard%2F&usg=AOvVaw36C3LCsVTcaWns331GK3AH

USER STORY

As a windows user, I want to connect my BI tools to the historian so that I can easily switch to this tool

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user, I want my data to be automatically displayed with the correct unit so that I don't have to convert the values myself

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

As a user I want to visualise last current value of each selected tags as auto-updatable compact datable with threshold color code.

this widget should be realtime oriented (websocket on redis ?)

USER STORY

As a user, I want to manage all my events so that I can list, search, filter, define firering rules

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

holds all servers related issues (like opc, REST, ua stuff)

USER STORY

As a user, I want to know how scalable is that tool so that I know what are the read/write throughput, and how many data a single node can handle.

I also want to know the compression ratio of the time series data

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As a user, I want to be provided with built-in advanced data retrieval modes so that I can analyse my data more in§depth

ACCEPTANCE CRITERIA

The following functions must be available for the selected tags

• Maximum
• Minimum
• Average
• Standard Deviation
• Percentiles
• Count
• Sum
• Range
• First/Last
• Bottom/Top
• Derivative
• Non Negative Derivative
• Difference
• Signed Difference
• Scale
• Divide
• Time window based Moving Average
• Samples based Moving Average
• Add
• Subtract
• A linear trend detection
• Outlier detection
• Frequency detection
• Time series similarity search
• Timeshift
• Distinct
• Integral
• SAX

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)

USER STORY

As an expert in diagnosis and to explain what happened (in replay mode on in live mode), I want to export the journal of alarms and actions so that it becomes a document that can be provided for legal issues.

ACCEPTANCE CRITERIA

DEFINITION OF DONE

• Code builds without warnings (technical task)
• Code unit tested (technical task)
• Documentation updated (user story)
• Build pushed to demo server (user story)