Inmation Connector

HostName

String

Host name or IP address of the 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.

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.

IncludeProperties

List<string>

[]

Required, min 0 items

These are names of Inmation object fields (custom/read-model properties) that the connector requests on each Inmation API call, alongside a fixed set (path, dynamic, ObjectDescription). Any properties added or removed from this list appear as additional properties for the indexed Signals, except unit or description properties, which populate known Seeq item properties.

This DepthPerSearchLayerRequest

int

10

Required, min 2

Used as the Depth argument on each Inmation Read Model API call. It determines how many hierarchy levels Inmation may return in a single response for a given path. Increase when the server can handle larger hierarchical payloads — fewer round trips often means faster indexing for deep trees. Decrease if Read Model calls time out, strain Inmation, or return very large JSON responses; this results in more calls but avoids timeouts.

MaxIndexingSearchLayers

int

10

Required, min 1

A safety cap on how deep the indexer will walk by absolute depth in the merged logical tree. Past this depth, children are not processed for that branch. This protects Seeq from runaway or cyclical trees. Increase if deep tags or assets under a path are missing from Seeq after indexing. Decrease to limit work on extremely deep, cyclical, or problematic hierarchies.

CreateQualitySignals

bool

false

Required

Determines if signals to display quality values are created for each tag signal during indexing. Other fields in this config apply only if enabled

QualitySignalNamePattern

string

null

Optional

This lets users change the display name of generated companion quality signals. If empty, the Indexer defaults to the signal name plus "Quality" as the suffix. The field supports a replacement token "{parent}", letting users customise quality signal names. For example, if a customer sets the field to "Qual-for-{parent}" and has a signal named "Temperature", the quality signal will be named "Qual-for-Temperature". Users can control word order and wording while linking the name to the parent signal.

GroupQualitySignalsUnderParentSignal

bool

false

Optional

When true, no quality asset is created; instead, quality signals attach to their parent signals. When GroupQualitySignalsUnderParentSignal is false, the connector creates a synthetic child asset under the same parent asset as the process signal. QualityAssetName names that asset

QualityAssetName

string

"Quality"

Required

Name of the synthetic child asset created under the same parent asset as the process signal to group quality companion signals. Used only when QualityAssetName is false. When QualityAssetName is true, no quality asset is created, and quality signals attach directly to their parent signals, so this property has no effect.