VC Hub User Manual
Index
Initializing search
    • Product Overview
    • New in this Version
    • Installation and Upgrade
    • Quick Start Guide
    • System Deployment
    • Management Platform
    • 2D Visualization
    • 3D Visualization
    • Appendix
    • Product Overview
      • Version Update Notes
      • System Requirements
      • Breaking Changes
    • New in this Version
    • Installation and Upgrade
      • Windows Environment
      • Linux Environment
      • Product License
      • Typical Architecture Selection Guide
      • Setup Service Running User
    • Quick Start Guide
    • System Deployment
      • Standalone Deployment
      • Network Deployment
      • Hybrid Cloud and Local Deployment
      • Redundant Deployment
      • Azure Cloud Deployment
    • Management Platform
      • License and Activation
      • Workspaces
        • Multi-workspace management
        • Current Workspace Configure File
        • Workspace Directory
        • Upgrade Workspace
        • Cannot Log In
      • Projects
      • Devices
        • Modbus TCP
          • Batch Operation of Modbus TCP Devices
        • Modbus RTU
          • Batch Operation of Modbus RTU Devices
        • OPC UA
          • Batch Operation of OPC UA Devices
          • Common OPC UA Server Test Report
        • MQTT Native
          • Batch Operation of MQTT Native Devices
        • MQTT SparkplugB
          • Batch Operation of MQTT SparkplugB Devices
        • SIEMENS S7
          • Batch Operation of SIEMENS S7 Devices
        • WAGO Protocol
          • Batch Operation of WAGO Protocol Devices
        • Usage of Legacy Protocols
      • Assets and Tags
        • Aggregation Modes for Historical Tags
        • Asset
          • Models and Instances
            • Batch Instantiate Models
            • Referencing and Override
          • Asset Tree
            • Batch Operation
              • Batch Add
              • Batch Update
              • Export and Import
        • Tag
          • Tag Type
            • System Tag
          • Creating Tags
            • I/O Tag Binding Data Source
          • Tag Properties
            • Alarm
            • History
            • Deadband
            • Scale
            • Event
            • Simulate
            • Custom
          • Tag Group
          • Quality
      • Alarming
        • Stale Alarm
        • History Storage
        • Alarm Group
        • Alarm Notification
          • Services
            • Email(SMTP)
            • SMS(Twilio)
            • SMS(Ali Cloud)
            • WeCom
            • DingTalk
          • Messages
            • Email(SMTP)
            • SMS(Twilio)
            • SMS(Ali Cloud)
            • WeCom
            • DingTalk
          • Schedules
          • Rules
          • Failed
          • Acknowledge Alarm
      • Scripts
        • Service Script
        • Custom Function
        • Schedule
        • Log Configuration
      • Networking
      • Databases
        • Database Connection
          • MySQL
          • SQL Server
          • PostgreSQL
          • SQLite
          • InfluxDB
          • Explanation of query exceptions
        • History Database
          • Create History Database
            • Data Partitioning and Deletion
            • Pre-Processed
          • Create a Duplicated History Database
          • Create a Remote History Database
        • Database Table Reference
          • Tag Table Reference
            • Relational Database Table Schema
            • InfluxDB Table Schema
      • Redundancy
        • Configuration Redundancy
        • Redundant configuration synchronization
        • Automatic Runtime Page Switchover Between Primary and Backup
      • Security
        • Roles and Users
        • User Group
        • Permission
        • Access Level
        • 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
      • Node Configuration
      • Certificate Management
      • MQTT Broker
      • Trust Store
      • Open API
        • API Document (Swagger)
        • Open Id Connect
        • Asset API Definitions
        • Historical Data API Definitions
        • Realtime Data API Definitions
        • Integration API definitions
        • Test With Postman
          • Get Access token
          • Invoke Web APIs over HTTPs
          • Subscribe to real-time data via WebSocket API
      • Diagnostics
    • 2D Visualization
      • Introduction to the Editor
      • Page
        • Page Type
        • Page Parameter Passing
        • Navigation
        • Resolution Adaptation
        • Page Permission
      • Page Template
      • Sql Query
        • Create SQL Query
        • Sql Query Example
          • Query
          • Scalar Query
          • Update Query
        • Supported Data Types
      • Controls
        • Drawing
          • Shape
          • Fill, Stroke, Shadow and Pick Color
        • Input
          • Dropdown
          • Text Input
          • Slider
          • Datetime Input
          • Number Input
        • Display
          • Label
          • Value Display
          • LED Display
          • IFrame
          • Rich Text
          • Page Container
          • 3D Viewer
          • Ruler
        • Button
          • Button
          • Menu
          • Checkbox
          • Radio Button
          • Toggle Button
          • 2-State Button
          • Multi-State Button
        • Chart
          • Real Time Chart
          • Historical Chart
          • Bar Chart
          • Pie Chart
          • Custom Curve
          • Gauge
          • Custom Chart
        • Alarm
          • Real-time Alarm
            • Alarm Filter
            • Alarm Acknowledge
            • Shelve Alarm
            • Alarm Details
          • Historical Alarm
            • Alarm Filter
            • Alarm Details
        • Event
          • Real Time Event
          • Historical Event
        • Table
          • Table
          • Historical Data Table
          • Tag List
          • Report Viewer
        • Modify the Control Properties
      • Libraries
        • SVG Editor
      • Symbol
        • Symbol Libraries
        • Create Symbol
        • How to use symbol
      • Report
        • Report Designer
          • Design Report
        • Create Data Source
        • View Report
        • Export/Import Reports
      • Function
        • Expression Function
        • Page Function
      • Property Binding
        • Tag
        • Property
        • Expression
        • Dynamic Tag
        • Dynamic Cell
        • SQL Query
        • Bidirectional Bindings
      • Animation
      • Event
        • Navigation
        • Set Value
        • Set Property
        • Script
        • Security Group
      • Project Properties
        • Customize the Login Page
    • 3D Visualization
      • Introduction to Scene Editor
      • Introduction to Model Editor
      • Page Visualization
      • Animation
      • Event
      • Convert 3D Models to GLB Format
      • Lighting Settings
      • 3D Low Code Example
        • find 3DView
        • getScene
        • 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
          • flyPath
          • lookAt
          • position
          • reset
          • rotateAround
          • pause
          • resume
        • Object models in the scene
          • Basic Model
            • addChildren
            • getChildren
            • getId
            • getParent
            • getType
            • getWorldPosition
            • name
            • position
            • userData
            • visible
          • Custom Annotations
            • element
          • Embedded Page
            • src
            • title
          • Grid Model
            • addOutline
            • color
            • movePaths
            • moveTo
            • on
            • opacity
            • removeOutline
            • rotateTo
            • rotation
            • scale
            • scaleTo
            • stopAnimation
            • wireframe
          • Image Overlays
            • canvas
            • size
          • Line
            • color
            • curve
            • points
          • Lines with textures
            • color
            • image
            • points
            • repeatX
            • repeatY
          • Surface
            • doubleSide
            • image
          • Text Annotation
            • fontColor
            • fontSize
            • height
            • text
    • Appendix
      • System Function
        • System.Alarm
          • System.Alarm.query
          • System.Alarm.queryHistory
        • System.Context
          • 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.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.toDatatable
        • System.Db
          • System.Db.runSqlQuery
        • System.Event
          • System.Event.fail
          • System.Event.success
        • System.Page
          • System.Page.getPropertyValue
          • System.Page.setPropertyValue
        • System.Security
          • System.Security.changePassword
          • System.Security.getRoles
          • System.Security.getUsername
          • System.Security.login
          • System.Security.logout
        • 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.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.importScript
          • System.Utils.importStyle

    Index

    • src
    • title
    Previous
    element
    Next
    src
    Copyright © 2016 - 2025 Martin Donath
    Made with Material for MkDocs