Fusion Web Application Service¶
1. Introduction¶
Fusion is a program that leverages TCUP platform and its APIs to build various applications such as: - Analytics Workbench - Equipment Onboarding - Device Onboarding
It provides a simple and intuitive interface through which different users, based on their role can access specific applications to perform specific operations. Listed below are few important terms used as part of the program: - Organization: Business unit or similar entity - Location: Geographical location or facility within an organization
2. Fusion: Analytics Workbench¶
Analytics Workbench is built for the Data scientist User/Role. Analytics Workbench application provides User Interface out of which a user with Data Scientist Role can fetch files from DLS (Data Lake Service), use the files as input to a specific algorithm, execute the algorithm and visualize the output once the algorithm execution is completed.
2.1 Intended Audience¶
The intended audience of this document are the data scientists and the data analysts. After reading this document the user will understand the capability of Analytics Workbench.
2.2 Key Concepts¶
In order to use the Asset Service and modelling application in terms of asset, a user needs to understand some of the basic concepts and building blocks of Asset Service. Please refer to the following section for the concepts:
2.2.1 Input File¶
For running some analytics algorithm, at first, we need some input file. File section of this webapp provides upload /download facility direct from the DLS.
Webapp provides a tree structure of algorithm selection. User can select Algorithm type, according to this algorithm, list will be generated. After selecting any specific algorithm parameters will be generated.
Meta data is the field by which an algorithm will be run. In file section by uploading any csv file, it will take the columns name as metadata, and save into DLS. Also, it has the provision to customize meta data entry.
An instance of program that needs to be executed is known as task. A unique task ID or name is the unique identifier of each task. A given task goes through following states: Deployed – Running – Completed or Error. A deployed task is ready for execution. When the task is started for execution, it goes into the running state. Once the task finishes running, it goes to the finished state. In the finished state, the output of the task is available to the user. If there is an error, the task goes to error state.
Refers to the output of a tsk/analysis which can be downloaded from this webapp. It also provides a view of output on the output page, so that the user has a clear approach on the output which can be an image, csv, json, pkl, h5 etc.
2.3 Functional Capabilities¶
The Analytics workbench provides the following functional capabilities for the user:
upload or download input files from file section to use them as input of analysis.
set custom metadata of an uploaded file in the file section.
Visualize the task count as per their status. It shows under the specific project’s details. Status of the task can be completed, queued, progress, error, created, deployed, not deployed etc.
create an analysis/task by selecting some algorithm on the analysis form.
run the created task/ analysis. Also check the status of the task/analysis
see the details of the task/analysis data on the list of task page.
delete any task/analysis from analysis page.
see the output of the analysis by selecting specific output file on output page.
download output files.
2.4 Purpose/Usage¶
This webapp is a fully managed by DLS and Task Service that enables developers and data scientists to run any supported executables quickly and easily at any scale. Analytics workbench gives a single platform of DLS and Task service to perform an analysis. This service manages all the underlying infrastructure and provides a simple webapp and interactive user interface to manage full life cycle.
2.5 Examples¶
Use Case 1:
Suppose a data scientist user wants to run Histogram algorithm, first the user needs to upload the input file for which the algorithm will run. Then the user must fill up the form on create analysis page with the relevant input. Then the user must select the algorithm type “Data Profiling” and Histogram on the algorithm section. On the parameter section the user must input the x-parameter and bin value. After creation of the task/analysis it will redirect to analysis page with the task status “deployed”. When the user will click on run button, the task will be in running stage. By clicking on refresh button, the user can check the status of task/analysis. After successful run of this algorithm the status will be shown as “completed”. Then by clicking on the task name webapp will redirect to output page. On the output page the user will see the output. json file. If output. json file contains “Successfully” then output histogram chart will appear. User can download this image by clicking on the download button.
3. Fusion: Equipment Onboarding Dashboard¶
Equipment Onboarding is built for the Business operator User/Role. Equipment Onboarding application provides User Interfaces out of which a user with business operator role can create equipment under available locations of an organization and view the equipment data. This application also allows updating the static / dynamic properties of equipment(s), their mapping with devices, ability to create sensors at SOS and associate them with suitable equipment(s) and monitor the time series sensor data as graph.
3.1 Intended Audience¶
The intended audience of this document are the Business Operators. After reading this document the user will understand the capability of Business Operators.
3.2 Key Concepts¶
The key concepts of equipment onboarding are as follows:
3.2.1 Equipment¶
Any entity involved in any business process or operation. It refers to a role or function, does not refer to an actual physical item. Equipment has an Id and is used in all functions such as scheduling, tracking, plant dashboards, charts, etc. Equipment can be of two status - “In-Progress” or “Completed”. Completed status denotes all configuration on that equipment is done, where as In-Progress denotes that the equipment has some pending configuration. Equipment will have properties. These properties can be mapped to actual sensor observed properties in TCUP.
Below are the allowable states that an equipment can have. - Running State: This state denotes that an equipment is currently up and running.
Hot Standby: Hot standby is a redundant method in which one equipment runs simultaneously with an identical primary equipment. Upon failure of the primary equipment, the hot standby equipment immediately takes over, replacing the primary equipment.
Cold Standby: Cold standby is a redundancy method that involves having one equipment as a backup for another identical primary equipment. The cold standby equipment is called upon only on failure of the primary equipment.
3.3 Functional Capabilities¶
Equipment onboarding provides the following functional capabilities for the user:
Create & view equipment under a location of an organization
Ability to create equipment under any existing equipment and tracking it.
Edit & delete an existing equipment
Create sensors at TCUP SOS
Map sensors with equipment(s) observation properties
Map devices with existing
Update static/dynamic equipment data
Overall statistics on running, hot standby, cold standby equipment information at organization level, location level.
Observe the time series data of a chosen dynamic property of an equipment in a graph.
Export the time series graph to .png file
3.4 Purpose/Usage¶
This webapp is a fully managed by TCUP Asset Service and TCUP SOS that enables business operators to create equipment quickly and easily at their preferred location of an organization.
3.5 Examples¶
Use Case 1:
Suppose a business operator user wants to get the last 10 days’ data of an equipment. First, the user needs to create an equipment based on the available equipment types and by giving the suitable values like equipment name, unique id, make, model, manufacturer name, current status, deploy date, start date of service etc. under a location of organization. Then the user can attach sensor to some of the equipment properties whose values have to be updated by those sensors. Next, the user can go to the equipment detail page to check the data of that equipment. The user can map gateway or physical devices to this equipment.
4. Fusion: Device Onboarding Dashboard¶
Device Onboarding is built for the IT operator User/Role. Device Onboarding application provides User Interfaces out of which a user with IT operator role can create device under available locations of an organization and view the static and dynamic device details. It also allows updating the static properties of device(s), pre-register the device, sharing the device with any user role, onboarding a new equipment mapped with device based on real-time notifications, set up component, rules, algorithm and monitoring their details, upload and broadcast upgrade packages and models, ability to create sensors at SOS and associate them with suitable device(s) and monitor the time series sensor data as graph.
4.1 Intended Audience¶
The intended audience of this document are the IT Operators. After reading this document the user will understand the capability of IT Operators.
4.2 Key Concepts¶
The key concepts of device onboarding are as follows:
4.2.1 Device¶
A Device is an entity which connects OT system with IT system and may run TCUP specific device agents, analytics, rules and have storage e.g., switches, routers, edge gateways etc. It is typically not related to equipment or any business asset.
Below are the allowable states that a device can have.
Connected: If the device is connected to network and is in running/active state.
Disconnected: If the device is not connected to network.
Never Connected: If the device is registered but never used.
4.3 Functional Capabilities¶
Device onboarding provides the following functional capabilities for the user:
Create & view, Update and delete device under a location of an organization
Edit & delete an existing device ,view static and dynamic properties of a device
Create sensors leveraging at TCUP SOS.
Map sensors with device(s) observation properties
Share devices with business role’s user.
Get notification of tagged or untagged equipment with a particular device
Show overall statistics on connected, disconnected, and never connected device information at organization level, location level.
Observe the time series data of a chosen dynamic property of a device using a graph.
Export the time series graph to .png file.
Upload software, model, or configuration packages.
Broadcast the packages to single or multiple devices
View, delete audit trail of uploaded existing packages.
Broadcast the packages to single or multiple devices.
Overview of the respective edge. Visualize the components/services deployed box components for on a single device
Start/stop or enable/disabled operations can be done over components specific component/service
Enable/disable a specific component/service
Subscribe any mqtt topics of edge device and get the messages through mqtt broker.
Rules Section: Device provides capabilities for filtering and analytics on individual stream of real time data as well as batch-oriented analysis on a window created on real time streaming data. It has out of the box filtering and analytics capabilities which can be configured as part of the rule on any sensor’s observation out of many devices posting data onto the edge box. In the rule section we can add edit and delete the rules.
Monitoring Section: Edge components can be deployed as both containers and in non-container mode. Health status of these components and other statistics related to device are visible in this section.
Configuration Section: There are multiple components with their respective configurations. These configurations can be viewed and edited in this section.
Certificate Management: It allows to manage and upgrade the SSL/TLS certificate on demand and facilitates secure communication channel between device and cloud native services.
4.4 Purpose/Usage¶
This webapp uses several TCUP services. Asset Service, Pre-Register and SOS service for device creation. Event service for notification, OTA for package upload and broadcast. DM service for device onboarding.
4.5 Examples¶
Use Case 1: Suppose an IT operator user wants to visualize/track the device details, current status, health of device and its components, and other details. User needs to first register the device under the location of this web app. If needed they can add sensor details too. Now, under this location the device will be visible with some basic details and in the details page they can track all the details like component, monitoring details, basic configuration, sensor data visible with date wise chart. Also, the user can subscribe some edge topic to get notifications. IT operator can also onboard/update/delete an equipment connected to the aforesaid device based on real-time notification. IT Operator can upgrade any software package, update configuration of the components running on the device or deploy a new model/application leveraging the OTA capability.
5. Reference Document¶
Please refer to the following documents for more details about this service:
User Guide