AVEVA Unified Engineering Reader

The AVEVA UE Reader module enables reading data from AVEVA Unified Engineering tables via the AVEVA Integration Services API. The module supports both API-key authentication and NTLM authentication (Windows only).

Overview

This module connects to AVEVA Unified Engineering through the Integration Services API and retrieves data from specified tables. Key features include:

  • Support for both API-key and NTLM authentication
  • Configurable data source and table selection
  • Live data or snapshot data reading
  • Error handling and status reporting

Settings

Name Requirements Purpose Default
Credential API-Key GUID The API-key for authentication (leave empty to use NTLM - Windows only) None
Host String 1-128 chars The AVEVA Integration Service endpoint https://eu.ais.connect.aveva.com/data/
Product Type Enum The AVEVA product type (Engineering, etc) Engineering
DataSource Name String 1-128 chars The name of the AVEVA data source to read from None
Table Name String 1-128 chars The name of the table to read from None
Target Property String 1-64 chars The property name to write the output data to data

Input

The module expects a flow message to trigger the read operation. No specific input properties are required.

Output

Name Type Description
crosser.success Boolean False if an error occurred when processing the message
crosser.message String Contains an error message if processing fails
{targetProperty} Array The table data read from AVEVA UE

Example

Settings

Credential = 00000000-0000-0000-0000-000000000000
Host = https://eu.ais.connect.aveva.com/data/
ProductType = Engineering
DataSourceName = MyDataSource
TableName = Equipment
TargetProperty = data

Incoming Message

{
    "trigger": true
}

Outgoing Message

{
    "data": [
        {
            "id": "EQ001",
            "name": "Pump-101",
            "type": "Centrifugal Pump",
            "location": "Area-A"
        },
        {
            "id": "EQ002",
            "name": "Tank-201",
            "type": "Storage Tank",
            "location": "Area-B"
        }
    ],
    "crosser": {
        "success": true
    }
}

Error Handling

The module handles several error conditions:

  • Invalid or missing credentials
  • Connection failures
  • Invalid data source or table names
  • Data access permission issues

When an error occurs:

  • Sets crosser.success to false
  • Adds error message to crosser.message
  • Sets module status to Warning with error details
  • Forwards the message with error information

Authentication

The module supports two authentication methods:

  1. API-Key Authentication

    • Provide a valid API-Key credential GUID
    • Recommended for most deployments
    • Required for non-Windows environments

  2. NTLM Authentication

    • Leave credential empty
    • Only available on Windows
    • Uses current Windows credentials

Usage Notes

  • Ensure the AVEVA Integration Service endpoint is accessible from the Crosser node
  • Verify data source and table names exist in AVEVA UE
  • For API-Key auth, the credential must be pre-configured in Crosser
  • Monitor module status for connection and authentication issues

Search Documentation

Cloud

Cloud Sources

AVEVA Modules