Actions

OPC UA Data Model (Zenitel Connect)

From Zenitel Wiki

Overview

Zenitel Connect exposes operational and configuration data through an OPC UA server. The OPC UA interface enables third-party systems such as SCADA, PSIM, BMS, and integration platforms to monitor system status, retrieve information, and perform selected control operations.

The complete node structure and data model are documented in the OPC UA Schema Contract.

Root Structure

The OPC UA address space is organized hierarchically under the root object ZenitelConnectPro.

ZenitelConnectPro 
├── AudioMessages 
├── CallQueues 
├── Devices 
├── Diagnostics 
└── Groups 


Each branch contains objects and variables related to a specific functional area.

Common System Variables

Variable Data Type Access Description
AddressSpaceChanged Int32 Read Indicates whether the address space has changed.
AddressSpaceLastChangeScope String Read Scope of the most recent address space change.
AddressSpaceLastChangeUtc DateTime Read Timestamp of the most recent change.
ConnectProConnected Boolean Read Connection status of Zenitel Connect Pro.
HeartbeatSeq UInt64 Read Incrementing heartbeat counter.
HeartbeatUtc DateTime Read Timestamp of the latest heartbeat.
IsRunning Boolean Read OPC UA service status.
ResetChangeTracker Boolean Read/Write Resets address-space change tracking.

Audio Messages

The AudioMessages branch exposes information and control functions related to audio message resources.

Structure:

AudioMessages
└── {audioMessageKey}
    ├── Description
    ├── Dirno
    ├── PlayTargetDirNo
    ├── IsPlaying
    ├── Delete
    └── ...

Example use cases:

  • Start and stop audio messages.
  • Read audio message descriptions.
  • Retrieve directory numbers.
  • Determine message duration.

Devices

The Devices branch exposes information about configured devices in the system.

Structure:

Devices
└── {deviceKey}
    ├── Actions
    ├── Call Forwarding
    ├── Queue
    ├── GPIO
    ├── Status
    └── ...


Typical use cases include:

  • Monitoring device availability.
  • Start and end calls.
  • GPIO status.
  • Building external dashboards and monitoring systems.

Groups

The Groups branch provides access to group configuration and status information.

Example use cases:

  • Monitoring which audio messages currently being broadcasted
  • Reading group properties.
  • Monitoring group membership.

Call Queues

The CallQueues branch exposes call queue configuration and operational information.

Example use cases:

  • Monitoring queue status.
  • Retrieving queue properties.
  • Integrating queue information into supervisory systems.

Diagnostics

The Diagnostics branch provides operational and troubleshooting information for monitoring the health of OPC Clients.

OPC UA Schema Contract

The full OPC UA node model is maintained as a generated schema contract and should be used as the authoritative reference for:

  • Complete node hierarchy
  • Data types
  • Access rights
  • Expected values
  • Object relationships


The complete node structure and data model are documented in the OPC UA Schema Contract.