AVEVA Unified Engineering Subscriber

The AVEVA Unified Engineering Subscriber module receives table data from Unified Engineering data sources through the AVEVA Integration Services API. This module acts as an input module, receiving data from AVEVA UE and making it available to downstream modules in the flow.

Overview

The AVEVA UE Subscriber module enables seamless integration with AVEVA Unified Engineering systems by:

• Establishing secure connections to AVEVA UE servers
• Subscribing to specified data sources
• Receiving real-time data updates
• Forwarding data through the Crosser flow pipeline
• Supporting both API key and NTLM authentication methods
• Handling connection errors and providing status updates

This module is designed as an input module and serves as the entry point for AVEVA UE data into Crosser flows.

Authentication Methods

The module supports two authentication methods:

1. API Key Authentication: Secure token-based authentication using AVEVA UE API keys
2. NTLM Authentication: Windows-based authentication for domain-integrated environments

Settings

Setting Details

Credential

• Type: API key
• Description: Optional API key credential for secure authentication
• Usage: When provided, the module uses API key authentication. When null, NTLM authentication is attempted
• Security: API keys are stored securely using Crosser's credential management system

Host

• Type: String
• Description: The hostname or IP address of the AVEVA UE server
• Examples:
  • aveva-server.company.com
  • 192.168.1.100
  • localhost:8080
• Requirements: Must be a valid hostname or IP address, optionally with port number

Product Type

• Type: ProductType enumeration
• Options: Product Types that supports subscriptions
• Default: Engineering
• Description: Specifies which AVEVA product services to connect to

Data Source Name

• Type: String
• Description: The name of the data source configured in AVEVA UE to subscribe to
• Examples:
  • ProductionData
  • SensorReadings
  • AlarmData
• Requirements: Must match an existing data source name in the AVEVA UE system

Target Property

• Type: String
• Description: The property name where received data will be placed in outgoing flow messages
• Default: "data"
• Examples:
  • avevaData
  • sensorData
  • measurements

Possible Errors

The module may encounter the following error conditions:

Input

This module is an input module and does not process incoming flow messages. Instead, it receives data directly from AVEVA UE subscriptions and generates new flow messages.

Output

The module generates flow messages containing data received from AVEVA UE subscriptions.

Output Message Structure

{
    "{targetProperty}": {
        // AVEVA UE data structure varies based on data source
        "timestamp": "2024-09-03T10:30:00Z",
        "values": {
            "temperature": 25.5,
            "pressure": 1013.25,
            "status": "normal"
        },
        "quality": "good",
        "dataSourceName": "ProductionSensors"
    },
    "crosser": {
        "success": true,
        "timestamp": "2024-09-03T10:30:00.123Z"
    }
}

Configuration Examples

Example 1: Basic Configuration with API Key

credential = 550e8400-e29b-41d4-a716-446655440000
host = https://eu.ais.connect.aveva.com/data/
productType = Engineering
dataSourceName = ProductionData
targetProperty = avevaData

Expected Behavior: Module connects to AVEVA Engineering server using API key authentication and subscribes to "ProductionData" source.

Example 2: NTLM Authentication

credential = null
host = https://eu.ais.connect.aveva.com/data/
productType = Engineering
dataSourceName = SensorReadings
targetProperty = sensors

Expected Behavior: Module connects using Windows NTLM authentication and places received data in the "sensors" property.

Data Flow Example

Scenario: Temperature Monitoring

Module Settings:

host = https://eu.ais.connect.aveva.com/data/
credential = api-key-guid
productType = Engineering
dataSourceName = TemperatureSensors
targetProperty = temperatureData

Outgoing Message:

{
    "temperatureData": {
        "timestamp": "2024-09-03T14:25:30Z",
        "sensorId": "TEMP_001",
        "location": "Reactor_A",
        "temperature": {
            "value": 75.2,
            "unit": "°C",
            "quality": "Good"
        },
        "alarm": {
            "status": "Normal",
            "highLimit": 85.0,
            "lowLimit": 60.0
        }
    },
    "crosser": {
        "success": true,
        "timestamp": "2024-09-03T14:25:30.456Z"
    }
}

Best Practices

Security

• Use API key authentication when possible for better security
• Store API keys securely using Crosser's credential management
• Regularly rotate API keys according to security policies
• Use NTLM authentication only in trusted network environments

Performance

• Monitor subscription frequency to avoid overwhelming downstream modules
• Consider data filtering at the AVEVA UE level to reduce unnecessary data transfer
• Implement appropriate error handling and retry logic

Reliability

• Configure proper network timeouts for your environment
• Monitor module status and implement alerting for connection failures
• Test failover scenarios and recovery procedures
• Document data source dependencies and requirements

Configuration

• Use descriptive data source names that clearly identify the data content
• Choose meaningful target property names for better flow readability
• Document the expected data structure for each data source
• Validate data source availability before deploying to production