AVEVA Unified Engineering Publisher Module

The AVEVA Unified Engineering Publisher module is an output module that publishes flow message data to AVEVA Unified Engineering (UE) tables through the AVEVA Integration Services API. This module enables seamless integration between Crosser edge flows and AVEVA UE data sources.

Features

  • Publishes individual flow messages or batches of flow messages to AVEVA UE tables
  • Supports both API key authentication and NTLM authentication
  • Configurable data source and table targeting
  • Returns acknowledgment IDs for successful publish operations
  • Built-in error handling and status reporting

Configuration

Settings

Name Requirements Purpose Default
Credential Optional The API key credential to use for authentication. If not provided, NTLM authentication will be used null
Host String 1 - 128 chars The service address of the AVEVA Integration Services endpoint "https://eu.ais.connect.aveva.com/data/"
Product Type ProductType The product type to use (Engineering, Operations, etc.) Engineering
Data Source Name String 1 - 128 chars The name of the data source in AVEVA UE to publish to ""
Table Name String 1 - 128 chars The name of the table within the data source to publish to ""
Source Property String 1 - 64 chars The property name containing the data to publish from the flow message "data"
Context Property String 0 - 64 chars The property name containing the context to publish (optional) ""
Expiry Duration Property String 0 - 64 chars The property name containing the duration in hours for which the data is valid (optional) ""
Target Property String 1 - 64 chars The property name where the acknowledgment ID will be stored in the flow message "response"

Expiry Duration

The expiry duration value specifies the number of hours for which the published data is valid. When the Expiry Duration Property is configured:

  • The property should contain an integer value representing hours
  • Valid range: 0 - 720 hours (0 to 30 days)
  • Values below 0 will be clamped to 0
  • Values above 720 will be clamped to 720
  • If the property is not specified or empty, no expiry duration is applied (0)

Authentication

The module supports two authentication methods:

API Key Authentication

Configure a credential of type "API-Key" and assign it to the Credential property. The module will use this API key for authentication with the AVEVA Integration Services.

NTLM Authentication (Windows only)

If no credential is provided, the module will attempt to use NTLM authentication with the current Windows user context.

Data Flow

  1. The module receives a flow message
  2. Extracts data from the configured Source Property
  3. Optionally extracts context from the configured Context Property (if specified)
  4. Optionally extracts expiry duration from the configured Expiry Duration Property (if specified)
  5. Publishes the data to the specified AVEVA UE data source and table
  6. Stores the acknowledgment ID in the configured Target Property
  7. Forwards the message to the next module in the flow

Supported Data Types

The module accepts the following data types from the source property:

  • Single Flow Message: Individual IFlowMessage objects
  • Message Collection: IEnumerable<IFlowMessage> for batch publishing

Error Handling

The module includes comprehensive error handling:

  • Authentication Errors: When credentials are invalid or missing
  • Type Errors: When the source property contains unsupported data types
  • Service Errors: When communication with AVEVA Integration Services fails

All errors are captured, logged to the flow message, and the module status is updated accordingly.

Example Configuration

Basic Configuration

Host = https://eu.ais.connect.aveva.com/data/
Product Type = Engineering
Data Source Name = ProcessData
Table Name = TemperatureReadings
Source Property = sensorData
Target Property = publishResponse

Configuration with Context and Expiry Duration

Host = https://eu.ais.connect.aveva.com/data/
Product Type = Engineering
Data Source Name = ProcessData
Table Name = TemperatureReadings
Source Property = sensorData
Context Property = metadata
Expiry Duration Property = validityHours
Target Property = publishResponse

Prerequisites

  • AVEVA Unified Engineering environment
  • AVEVA Integration Services endpoint
  • Valid credentials (API key or Windows authentication)
  • Properly configured data source and table in AVEVA UE

Search Documentation

Destinations

Cloud

AVEVA Modules