Inmation Connector

.NET AGENT

Item Type Support

SIGNALS ASSETS

Overview

The Inmation Connector lets you bring time series data from AspenTech Inmation into Seeq. After setup, Seeq builds an asset tree from your Inmation structure and makes matching tags available as signals.

Prerequisites

An Inmation system with REST API access enabled.
Network connectivity from the Remote Agent machine to your Inmation host and port.
An Inmation account (BuiltIn, AD, or Machine authority) that can:
- Authenticate with the Inmation Web API
- Install the Seeq companion script located in <connector-dir>/Scripts/syslib.api-seeq.lua

Configuration

Use the following template in Additional Configuration when creating or editing an Inmation datasource.

JSON

{
  "HostName": "<Your Inmation server address>",
  "Port": 8002,
  "Username": "<Your Inmation username>",
  "Password": "<Your Inmation password>",
  "RequestProtocol": "Https",
  "OAuthAuthority": "BuiltIn",
  "ParentAssetPath": null,
  "IndexerType": "InmationScriptIndexer",
  "IndexerConfiguration": "{\"IndexEndpoint\":\"/api/v2/execfunction/syslib.api-seeq/readmodel\",\"Paths\":[\"/\"]}",
  "SkipLevelsForAssetTree": 0,
  "ParentElementMerge": {
    "Enabled": false,
    "Separator": "."
  },
  "RootNodePrefix": null,
  "RootNodeSuffix": null,
  "IndexQualityTags": {
    "Enabled": false,
    "SignalNameOverridePattern": null,
    "QualityTagAssetName": "Quality",
    "NestTagsUnderSignals": false
  },
  "SignalTypes": [
    "AnalogMeasurement"
  ],
  "MaxConcurrentRequests": null,
  "MaxResultsPerRequest": null
}

Inmation Additional Configuration

Property Name	Default Value	Data Type	Description
`HostName`		String	Host name or IP address of your Inmation server.
`Port`	`8002`	Integer	Port used by the Inmation REST API.
`Username`		String	User name for OAuth authentication.
`Password`		Secret String	Password for the configured user.
`RequestProtocol`	`Https`	String	The protocol to be used to communicate with the Canary server. In addition to the default, `Http` is also supported but not recommended.
`OAuthAuthority`	`BuiltIn`	String	Authentication authority for your Inmation account. Supported values are `BuiltIn`, `AD` and `Machine`
`ParentAssetPath`	null	String	Optional root path used when mapping indexed items to query paths. Leave as null unless required in your environment.

InmationScriptIndexer Configuration

IndexerConfiguration is a JSON string that matches the InmationScriptIndexerConfiguration class. Both properties are required: Paths must contain at least one non-empty entry, and IndexEndpoint must be a non-empty string.

JSON

{
  "IndexEndpoint": "/api/v2/execfunction/syslib.api-seeq/readmodel",
  "Paths": [
    "/System/Core"
  ]
}

Property Name	Required	Description
`IndexEndpoint`	Yes	Web API endpoint that runs the Inmation script returning items to index.
`Paths`	Yes	One or more Inmation paths to index. Must contain at least one non-empty value; empty entries are invalid.