Manual version
Version 5.0
Version 5.1
Version 5.2
Version 5.2(SaaS)
Skip to content
VC Hub User Manual
Core Functions
Initializing search
Overview
What's New
Installation and Upgrade
Quick Start
Deployment
Management Platform
2D Visualization
3D Visualization
MEMS
Appendix
VC Hub User Manual
Overview
Overview
Version Update Notes
System Requirements
Breaking Changes
What's New
What's New
Installation and Upgrade
Installation and Upgrade
Windows Environment
Linux Environment
Typical Architecture Selection Guide
VC Hub Service Account and File Permissions
Branding & Theming (Labeling)
Quick Start
Quick Start
Deployment
Deployment
Standalone Deployment
Network Deployment
Hybrid Cloud and Local Deployment
Redundant Deployment
Azure Cloud Deployment
Management Platform
Management Platform
License
License
Workspaces
Workspaces
Multi-workspace Management
Current Workspace Configure File
Workspace Directory
Upgrade Workspace
Cannot Log In
Projects
Projects
Devices
Devices
Modbus TCP
Modbus TCP
Batch Operation of Modbus TCP Devices
Modbus RTU
Modbus RTU
Batch Operation of Modbus RTU Devices
OPC UA
OPC UA
Batch Operation of OPC UA Devices
Common OPC UA Server Test Report
MQTT Native
MQTT Native
Batch Operation of MQTT Native Devices
MQTT SparkplugB
MQTT SparkplugB
Batch Operation of MQTT SparkplugB Devices
SIEMENS S7
SIEMENS S7
Batch Operation of SIEMENS S7 Devices
WAGO Protocol
WAGO Protocol
Batch Operation of WAGO Protocol Devices
WAGO Protocol WriteValue Command Configuration and Response Processing
IEC 104
IEC 104
IEC104 TLS
Batch Operation of IEC 104 Devices
Usage of Legacy Protocols
Assets and Tags
Assets and Tags
Aggregation Modes for Historical Tags
Asset
Asset
Models and Instances
Models and Instances
Batch Instantiate Models
Referencing and Override
Asset Tree
Asset Tree
Batch Operation
Batch Operation
Batch Add
Batch Update
Export and Import
Tag
Tag
Tag Type
Tag Type
System Tag
Remote Tag
Creating Tags
Creating Tags
I/O Tag Binding Data Source
Tag Properties
Tag Properties
Alarm
History
Deadband
Scale
Event
Simulate
Custom
Tag Group
Quality
Alarming
Alarming
Stale Alarm
Alarm History Storage
Alarm Group
Alarm Notification
Alarm Notification
Services
Services
Email(SMTP)
SMS(Twilio)
SMS(Ali Cloud)
WeCom
DingTalk
Messages
Messages
Email(SMTP)
SMS(Twilio)
SMS(Ali Cloud)
WeCom
DingTalk
Schedules
Rules
Failed
Acknowledge Alarm
Scripts
Scripts
Service Script
Custom Function
Schedule
Log Configuration
Networking
Networking
Databases
Databases
Database Connection
Database Connection
Least-Privilege Database Accounts
MySQL
SQL Server
PostgreSQL
SQLite
InfluxDB
Explanation of query exceptions
History Database
History Database
Create History Database
Create History Database
Data Partitioning and Deletion
Pre-Processed
Create a Duplicated History Database
Create a Remote History Database
Database Table Reference
Database Table Reference
Tag Table Reference
Tag Table Reference
Relational Database Table Schema
InfluxDB Table Schema
Redundancy
Redundancy
Configuration Redundancy
Redundant configuration synchronization
Automatic Runtime Page Switchover Between Primary and Backup
Security
Security
Roles and Users
Online Users
User Group
Permission
Access Level
Identity Provider
Identity Provider
User Attribute Mapping
User Grants
Test Login and Logout
Troubleshooting
Azure AD integration with MFA
Integrates with OAuth0
OIDC Server(Open API) Registrations
Password Reset
Password Reset
Node Configuration
Node Configuration
Certificate Management
Certificate Management
MQTT Broker
MQTT Broker
Trust Store
Trust Store
Open API
Open API
API Document (Swagger)
Open Id Connect
Asset API Definitions
Historical Data API Definitions
Realtime Data API Definitions
Integration API definitions
Modbus Tcp API definitions
Use C# to Invoke Realtime Data API (SignalR)
Use C# to Invoke Open API (WebAPI)
Test With Postman
Test With Postman
Get Access token
Call the HTTPS API
Subscribe to real-time data
Diagnostics
Diagnostics
2D Visualization
2D Visualization
Editor Introduction
Editor Introduction
Page
Page
Page Type
Page Parameter Passing
Navigation
Resolution Adaptation
Page Permission
Page Template
Page Template
Sql Query
Sql Query
Create SQL Query
Sql Query Example
Sql Query Example
Query
Scalar Query
Update Query
Supported Data Types
Controls
Controls
Drawing
Drawing
Shape
Fill, Stroke, Shadow and Pick Color
Input
Input
Dropdown
Text Input
Slider
Datetime Input
Number Input
Display
Display
Label
Value Display
LED Display
IFrame
Rich Text
Page Container
3D Viewer
Ruler
Button
Button
Button
Menu
Checkbox
Radio Button
Toggle Button
2-State Button
Multi-State Button
Chart
Chart
Real Time Chart
Historical Chart
Bar Chart
Pie Chart
Custom Curve
Gauge
Custom Chart
Alarm
Alarm
Real-time Alarm
Real-time Alarm
Alarm Filter
Alarm Acknowledge
Shelve Alarm
Alarm Details
Historical Alarm
Historical Alarm
Alarm Filter
Alarm Details
Event
Event
Real Time Event
Historical Event
Table
Table
Table
Historical Data Table
Tag List
Report Viewer
Modify the Control Properties
Libraries
Libraries
SVG Editor
Symbol
Symbol
Symbol Libraries
Create Symbol
How to use symbol
Report
Report
Report Designer
Report Designer
Design Report
Create Data Source
View Report
Export/Import Reports
Function
Function
Expression Function
Page Function
Property Binding
Property Binding
Tag
Property
Expression
Dynamic Tag
Dynamic Cell
SQL Query
Read/Write Mode Bindings
Animation
Animation
Event
Event
Navigation
Set Value
Set Property
Script
Security Group
Project Properties
Project Properties
Customize the Login Page
3D Visualization
3D Visualization
Scene Editor
Scene Editor
Model Editor
Model Editor
Page Visualization
Page Visualization
Animation
Animation
Event
Event
Convert 3D Models to GLB Format
Convert 3D Models to GLB Format
Lighting Settings
Lighting Settings
3D Low Code Example
3D Low Code Example
find 3DView
getScene
Scenario Operation
Scenario Operation
background
backgroundImg
createBasicMesh
createCanvasMarker
createFire
createHtmlMarker
createLine
createModel
createPlane
createRain
createSmoke
createSnow
createTextLabel
createTube
createWebView
findCanvas
findFire
findHtml
findLine
findMesh
findPlane
findRain
findSmoke
findSnow
findTextLabel
findTube
findWebView
on
openFirstPersonControls
outlineObjects
query
queryCanvas
queryFire
queryHtml
queryLine
queryMesh
queryPlane
queryRain
querySmoke
querySnow
queryTextLabel
queryTube
queryWebView
remove
setOutlineOption
stopFirstPersonControls
skybox
createDiffusion
Camera
Camera
flyPath
lookAt
position
reset
rotateAround
pause
resume
Object models in the scene
Object models in the scene
Basic Model
Basic Model
addChildren
getChildren
getId
getParent
getType
getWorldPosition
name
position
userData
visible
Custom Annotations
Custom Annotations
element
Embedded Page
Embedded Page
src
title
Grid Model
Grid Model
addOutline
color
movePaths
moveTo
on
opacity
removeOutline
rotateTo
rotation
scale
scaleTo
stopAnimation
wireframe
Image Overlays
Image Overlays
canvas
size
Line
Line
color
curve
points
Lines with textures
Lines with textures
color
image
points
repeatX
repeatY
Surface
Surface
doubleSide
image
Text Annotation
Text Annotation
fontColor
fontSize
height
text
MEMS
MEMS
Overview
Overview
Purpose of MEMS
Architecture
Main Functions
Integration into VC Hub
Security
Requirements
MEMS Offline Installation
Getting Started
Getting Started
Login
User Interface Overview
Dashboard Overview
Core Functions
Core Functions
Peak Load Management
Surplus Management
Microgrid Components
Constraints
Administration
Administration
Configuration
Notifications
Appendix
Appendix
System Function
System Function
System.Alarm
System.Alarm
System.Alarm.query
System.Alarm.queryHistory
System.Context
System.Context
System.Context.alarm
System.Context.alarm
System.Context.currentAlarm.ackMode
System.Context.currentAlarm.ackNotes
System.Context.currentAlarm.ackTime
System.Context.currentAlarm.description
System.Context.currentAlarm.statusChangeId
System.Context.currentAlarm.statusChangeTime
System.Context.currentAlarm.name
System.Context.currentAlarm.nodeName
System.Context.currentAlarm.ackUser
System.Context.currentAlarm.path
System.Context.currentAlarm.priority
System.Context.currentAlarm.state
System.Context.currentAlarm.type
System.Context.currentAlarm.alarmValue
System.Context.currentAlarm.dataType
System.Context.currentAlarm.activeTime
System.Context.currentAlarm.alarmGroups
System.Context.currentAlarm.clearTime
System.Context.currentAlarm.notificationRule
System.Context.currentEvent
System.Context.currentEvent
System.Context.currentEvent.newValue
System.Context.currentEvent.offsetX
System.Context.currentEvent.offsetY
System.Context.currentEvent.oldValue
System.Context.currentEvent.screenX
System.Context.currentEvent.screenY
System.Context.currentEvent.type
System.Context.currentEvent.x
System.Context.currentEvent.y
System.Datatable
System.Datatable
System.Datatable.toDatatable
System.Db
System.Db
System.Db.runSqlQuery
System.Event
System.Event
System.Event.fail
System.Event.success
System.Function
System.Function
System.Function.runScript
System.Library
System.Library
System.Library.getLocalImage
System.Library.getSystemImage
System.Page
System.Page
System.Page.getPropertyValue
System.Page.setPropertyValue
System.Security
System.Security
System.Security.changePassword
System.Security.getRoles
System.Security.getUsername
System.Security.login
System.Security.logout
System.Tag
System.Tag
System.Tag.getPropertyValues
System.Tag.mock
System.Tag.queryPropertyValues
System.Tag.read
System.Tag.readHistory
System.Tag.readValue
System.Tag.subscribe
System.Tag.writeValue
System.UI
System.UI
System.UI.applyChanges
System.UI.back
System.UI.close
System.UI.findControl
System.UI.forward
System.UI.goHome
System.UI.open
System.UI.openNewTab
System.UI.openPopup
System.UI.redirect
System.Utils
System.Utils
System.Utils.importScript
System.Utils.importStyle
Core Functions
¶
Back to top