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 server with a version greater or equal to version 1.100.0
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

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",
  "ScriptIndexerConfig": {
    "Paths": [
      "/System"
    ],
    "ExcludedClasses": [],
    "IncludedProperties": [
      "DecimalPlaces",
      "OpcEngUnit",
      "EngUnitOverride"
    ],
    "MaxIndexingSearchLayers": 10,
    "DepthPerSearchLayerRequest": 10
  },
  "IndexQualityTags": {
    "Enabled": false,
    "SignalNameOverridePattern": null,
    "QualityTagAssetName": "Quality",
    "NestTagsUnderSignals": false
  }
}

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 Inmation server. In addition to the default, `Http` is also supported but not recommended.
`OAuthAuthority`	`BuiltIn`	String	Where credentials are validated. `BuiltIn` authenticates the username/password against a Profile in the Access Model. `AD` authenticates the domain user against Active Directory. `Machine` authenticates the local Windows user against the Security Account Manager (SAM).
`ScriptIndexerConfig`		Complex Object	Configuration for the script-based indexer. See InmationScriptIndexerConfigV1 below.
`IndexQualityTags`		Complex Object	Configuration for quality tag indexing and display. See QualityTagHandlingConfigV1 below.

Inmation Script Indexer Configuration

Configuration for the script-based indexer that traverses the inmation object hierarchy.

Property Name	Type	Default	Constraints	Description
`Paths`	`List<string>`	`[]`	Required, min 1 item	The list of root paths in the inmation hierarchy to index.
`ExcludedClasses`	`List<uint>`	`[]`	Required, min 0 items	Inmation object class IDs to exclude from indexing. See the Inmation Classes Doc for details. NOTE: once a class is excluded, any node of that class type and its children are excluded from indexing.
`IncludedProperties`	`List<string>`	`[]`	Optional	The list of properties to include in the index. If null, default properties are used.
`MaxIndexingSearchLayers`	`int`	10	Required, min 1	Maximum layered indexing requests per configured Path. Increase incrementally if expected Assets and Signals are not indexed.
`DepthPerSearchLayerRequest`	`int`	10	Required, min 2	Maximum traversal depth per search layer query; increase on resource-adequate servers to improve indexing speed, balancing higher resource use.

Inmation Index Quality Tags Configuration

Configuration for how quality tags are indexed and displayed alongside signals. Quality tags hold data about the quality values for each sample in the associated tag.

Property Name	Type	Default	Constraints	Description
`Enabled`	`bool`	`false`	Required	Whether quality tag indexing is enabled.
`SignalNameOverridePattern`	`string`	`null`	Optional	Pattern for generating the quality tag signal name. The placeholder `{parent}` is replaced with the associated signal's name.
`QualityTagAssetName`	`string`	`"Quality"`	Required	Name of the parent asset that will contain the quality tag(s).
`NestTagsUnderSignals`	`bool`	`false`	Required	If `true`, quality tags are nested under the parent signal. If `false`, they are placed in a separate asset.

Known Issues

There are no known issues for the Inmation connector. Please report any issues you find to our support portal.

Troubleshooting

If you are running into issues with connecting to or access data from Inmation, view our guide for troubleshooting datasource issues.

Performance considerations

If your Inmation server has adequate hardware resources, the DepthPerSearchLayerRequest can be increased to improve indexing speed at the expense of higher resource usage. Increment the property in small increments so as not to put undue strain on the server.

View optimizing datasource performance for general guidance.