Se-node-red-aveva_insight NPM

1. Overview

SE Aveva Insight node is a publishing node that collects data in CMS format from collection node (Ex. SE Harmony Hub which collects data from Harmony Hub gateway), It converts into Aveva Insight data format and pushes the data to the Aveva Insight Cloud.

You must Sign-Up to AVEVA cloud and create a Data Source.

Package Content

Component	Version
se-node-red-aveva_insight	2.0.1

2. Features

v2.0.1:

Node Configuration
Store and Forward
Common Message Structure
Schneider Look & Feel
Logging

3. Operating System

This app can be installed on the following platforms with the version of NodeJS: 10.15.3 and Node-Red 0.20.7

Windows 10 (Standard Image-HMIBMP)

4. Hardware Requirements

Magelis HMIBMP Reference HMIBMPHI74D4801 HMIBMP with 4 expansion slots, i7, 8GB, 500 GB HDD

5. Software Requirements

Observe these minimum software requirements for functioning of the Aveva Insight node:

Node.js V10.15.3
Node-RED server V0.20.7
Npm (Node package manager) V6.4.1
Node-RED application is supported in any browser with V8 engine or similar (for instance- Google Chrome V73.0 and Firefox V66.0)

NOTE: The software versions mentioned above support the SE Nodes installation. Other versions do not support it.

6. Installation

Prerequisites for SE Aveva Insight node installation:

Installation of Supported Node.js version
1. Download the Windows installer from the Nodes.js® web site. https://nodejs.org/en/download/
2. Run the installer (the .msi file you downloaded in the previous step.)
3. Follow the prompts in the installer (Accept the license agreement, click the NEXT button a bunch of times and accept the default installation settings).
4. Restart your computer. You won’t be able to run Node.js® until you restart your computer.
Installation of Supported Node-RED version
1. Check out http://nodered.org/docs/getting-started/ for full instructions on getting started.
2. In Schneider network, set the registry to https://registry.npmjs.org/ by executing below npm command.
```
    npm config set registry https://registry.npmjs.org/
```
3. Set the proxy to your network proxy (e.g. https://yourproxy:xxxx/) by executing below npm command.
```
    npm config set proxy http://gateway.schneider.zscaler.net:9480/
```
  For Schneider Electric proxy across the world, refer the link below:
  http://wain05400.apa.gad.schneider-electric.com:81/wiki/index.php/%28Proxy_List%29
  Make sure the set registry and proxy are configured
  Run below npm command to install Node-RED (v0.20.7)
```
    npm install -g --unsafe-perm node-red@0.20.7
```

Online installation

Installation of SE Aveva Insight node through Schneider Electric Repository (Windows system only)

At present, online installation is possible only inside Schneider Electric corporate network.

Launch command prompt and run below commands

    npm set registry https://wain05400.apa.gad.schneider-electric.com:4878/
    npm config rm proxy
    npm config rm http-proxy
    npm config rm https-proxy
    cd .node-red
    npm install se-node-red-aveva_insight

Automated Offline installation

Download the Aveva-Insight_V2.0.1_offline.zip file by clicking on the Download Icon in the top right menu or from the below link https://schneider-electric.box.com/s/xsmgvjhjo4km8jwlsn8qyprgb0gy8bv6
Unzip the Aveva-Insight_V2.0.1_offline.zip file into folder
For Windows
```
    Click on se-node-red-aveva_insight_offline_install.bat file
```
For Linux
Run below command
```
    sh se-node-red-aveva_insight_offline_install.sh
```
NOTE: The node package is saved in the User directory
(for example: C:/Users/\<User Name>/se-node-red-aveva_insight/)
After installation restart the Node-RED server

7. Uninstallation

Online uninstallation

If SE Aveva Insight Node is installed using online installation process, below is the process to uninstall

Delete the nodes from the flow

Open the Command Prompt and run the below command to uninstall

    cd .node-red
    npm uninstall se-node-red-aveva_insight

Offline uninstallation

If SE Aveva Insight Node is installed using offline installation process, below is the process to uninstall

Delete the nodes from the flow
For offline uninstallation process 'se-node-red-aveva_insight_offline_uninstall' file is required and the 'se-node-red-aveva_insight_offline_uninstall' file will be available in the User directory
( for example: C:/Users/\<User Name>/)
For Windows:
```
    Click on se-node-red-aveva_insight_offline_uninstall.bat file
```
For Linux: Run below command
```
```bash
   sh se-node-red-aveva_insight_offline_uninstall.sh
```
```
After uninstallation restart the Node-RED server

8. Help Manual

SE Aveva Insight node user manual can be downloaded using the Help Icon in the top right menu.

9. License

SE Aveva Insight node is available under Schneider Electric license.
The license file can be downloaded using the License Icon in the top right menu

10. Information

Supported Language is English only.
User needs to Signup for Aveva Insight Cloud, create a datasource and copy the end of datasource to push data
For detailed information for generating token and if the token expires, please refer Help Manual

11. Best Practices (for further information refer help manual)

Run Node-RED-as-a-service
Use Browser wisely
Stop unused services

12. Limitations 1. Operating system anything less than Windows 10 is not supported. 2. Node-RED application is supported in any browser with V8 engine or similar (for instance: Google Chrome V73.0 and Firefox V66.0). 3. Node-RED web page is only available in English, irrespective of the system language. 4. SE Aveva Insight will not work on Node.js® unstable versions and 6.x.x, 8.x.x and 12.x.x versions. 5. SE Aveva Insight node should work on Node.js 10.15.3 and Node-RED 0.20.7 version only. 6. When you launch a Node-RED server, it takes time to get started Please follow the steps mentioned below to overcome this issue: Open Task Manager Search for the Nodejs in the "Background Process" Right click on nodejs task and click on "End Task" to kill the process Now the Node-RED server starts running

Based on the AVEVA Insight subscription of the user, the maximum number of tags pushed through one SE Aveva Insight node cannot exceed the limit defined for a Data Source. E.g: If AVEVA Insight user has subscribed 500 tags per Data Source and the node attempts to push more than 500 tags data in to the Data Source. In such instances, the Store-and-Forward functionality assumes that the data has been successfully pushed and that the files stored were are deleted. However, the user will not be notified that the data push has been unsuccessful.
When the user wants to do the offline installation, the internet should be disabled. It takes longer to install if internet is enabled.

13. Known Issues

json-size jsonfile node-json-db pdfreader request winston

@infinitebrahmanuniverse/nolb-se-@everything-registry/sub-chunk-2724

2.0.4

4 years ago