Connector

The Connector object corresponds to a Connector service that can be running on a host or a remote machine. It is a key component in system:inmation, allowing a fully dispersed data network with optimized and easy to configure network communication to be created. The Connector services forwards data to the Core service. The Connector can operate as a client to connect to OPC servers, TCP servers, PLCs and other data endpoints.

Connector objects are created underneath the Core object in the I/O Model. To connect to a an existing inmation Connector service, the host name (or IP address) and port number of the service need to be configured.

Use Cases

  • Connecting to and browsing OPC servers.

  • Centralizing data gathering across a dispersed network.

  • Connecting to remote host machines and servers with minimum configuration

Quick Configuration

For information on creating and using Connector objects, please visit:

Object Properties

Common

Object Name

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description

This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

Display Alias

Alternate label for objects to be used for easier identification in the displays.

Component Version Policy

Use this to configure exceptions to component auto-update.

  • Automatic, Restrictive: Component updated automatically. Communication with outdated component not permitted.

  • Automatic, Permissive: Component updated automatically. Communication with outdated component permitted.

  • Manual, Restrictive: Component updated manually. Communication with outdated component not permitted.

  • Manual, Permissive: Component updated manually. Communication with outdated component permitted.

Component Update Verification

Update verification policy for remote component updates.

  • None: No verification.

  • Signature: Verify the signature of the signed inmation executable.

Attachments

File attachments stored in MongoDB file store.

Usecases

Lists the usecases that apply to this object.

Log Console Output

Save console output in service log file.

Software Information

Information about the current executable.

Version

The version of the executed file.

Architecture

The software architecture of the executed file.

  • Unknown: The architecture is not known.

  • Windows 32-bit: The executable is a 32-bit Windows service.

  • Windows 64-bit: The executable is a 64-bit Windows service.

Host Information

Information about the host system running the inmation service.

OS Name

The host operating system name.

Architecture

The host processor architecture.

  • Unknown: The architecture is not known.

  • x64 (AMD or Intel): The host processor is a x64 AMD or Intel processor.

  • ARM: The host processor is a ARM processor.

  • Intel Itanium-based: The host processor is a Intel Itanium-based processor.

  • x86: The host processor is a x86 processor.

Version

The host operating system version.

System Name

The host system (computer) name.

Processor

The host processor ID.

CPU Cores

The number of CPU cores of the host.

Logical Processors

The number of logical processors of the host.

Physical Memory

The amount of physical memory (RAM) installed in the host.

Disk Size

The size of the hard disk volume this service component is installed on.

Communication

Configure the communication settings.

Host Name or IP

The host name or IP address under which the Server can be reached.

Local Client Port

This port number can optionally be used in Communication Mode = Active for local port presets (if set to 0 (default), which is the default, a random high port will be used).

Listener Port

Component listener (server) port for core service communication in Communication Mode = Passiv.

Forwarded Port

This value, if set, will be used to connect to the component. Use this if the externally visible port is different from the listener port, as may happen with NAT and port forwarding.

Timeout

Value in seconds for the communication timeout. After this time the communication to the remote component is considered to be unavailable and the connection will be terminated. Re-connection will be attempted periodically.

Reconnect Period

The period, in seconds, between re-connects on a failed connection.

Connection Mode

Configure how the connection between the inmation core service and a remote component is established.

  • Passive: The remote component passively listens for connection requests from the Core service.

  • Active: The remote component actively sends connection requests to the Core service.

Passphrase

Passphrase to authorize clients.

Self Certificate Selection

The selection settings of this component certificate to be used for authentication in TLS-X.509 security mode.

Subject Name

The subject name of the certificate to be matched.

Effective Certificate

Effective certificate currently being used for authentication in TLS-X.509 security mode.

Peer Certificate Validation

The validation settings of the peer component certificate to be used for authentication in TLS-X.509 security mode.

Subject Name

The subject name of the certificate to be matched.

Effective Certificate

Effective certificate currently being used for authentication in TLS-X.509 security mode.

DCOM Credentials

DCOM Credentials for the communication accross a network.

Domain

A (Windows) domain name to which a particular computer or user account belongs.

User Name

User Name.

Password

Password.

Component Identification

This structure contains the data and settings, which identify the component within a larger system and define its specific functional behaviour.

Component ID

The internal ID number of a component (=service on a particular hardware), which must be system-wide unique.

Component GUID

The internal GUID of a component.

Component Type

The internal type of a component (=service).

  • Connector Service Component: Connector Service Component.

  • Relay Service Component: Relay Service Component.

  • Core Service Component: Core Service Component.

  • Cache Service Component: Cache Service Component.

  • Broker Service Component: Broker Service Component.

  • Server Service Component: Server Service Component.

Instance

The inmation instance.

I/O Subsystem State

Property compound for volatile runtime information about the state of the I/O subsystem in a connector component.

I/O Timer Recent Time

The most recent execution of the timer thread (should be recent and ever-changing).

I/O Timer Runtime

The runtime of the periodic timer thread in milliseconds.

I/O Timer Heartbeat

A heartbeat value which oscillates between 1 and 1000 (each second).

Connector Options

Connector options (for later use).

Bypass Discovery Rules

Bypass the discovery rules of data sources and items as described on the Black and White lists.

Datasource Whitelist

A whitelist is a list that name the Datasources (separated by TAB) that may be automatically added to the hierarchy when they are discovered. If the whitelist is empty all discovered Datasources will automatically be added, as long as they are not listed in the blacklist. The blacklist has priority over elements in the whitelist. The default whitelist value is empty.

Datasource Blacklist

A blacklist is a list of Datasources (separated by TAB) that are not automatically added to the hierarchy when discovered. If both the blacklist and the whitelist are empty, all discovered Datasources will be automatically added. If not, the blacklist has precedence over the whitelist. The default value "inmation.OPC.Server.1" prevents an installation on a single server from a "short-circuit". For cascaded systems with remote connections this entry may be deleted.

Datasource Discovery Suppression

Connector options, disabling distinct discovery mechanisms.

  • Disable Classic OPC Server Discovery: If this option is set, the connector object will not discover classic (COM-based) OPC servers automatically.

  • Disable OPC UA Server Discovery: If this option is set, the connector object will not discover OPC UA servers automatically.

OPC UA Stack

Settings which impact all stack-wise OPC UA client connections for this connector instance.

Discovery Server Url

URL of the UA Discovery Server.

Certificate Security

Defines settings for processing of certificates.

Always Import Server Certificate

If this property is set then the UA Server certificate will be checked and imported to the folder containing trusted certificates. If importing fails then certificate will be copied to the folder containing rejected certificates. If this this property is not set then certificate will be always copied to the folder containing rejected certificates.

Create Certificate

Create self signed certificate if it does not exist.

Own Certificate Details

Settings of the own client certificate.

Application Name

Descriptive name of the application.

Organization Name

Organization name used for creation of application description and for creation of self signed certificate. Should be the same as the organization name in the client certificate.

Certificate Validity

Defines how long the cerificate is valid.

Password Protect Private Key

Set this property to protect private key.

Private Key Password

Private key will be protected with this password.

Domain Names

Defines the list of domain names for which certificate is valid.

Domain Name

Domain name for which the certificate is valid.

Certificate Digest Algorithm

The hash algorithm for the creation of new OPC UA certificates. Existing certificates are not affected by this option.

  • SHA160: Use the SHA160 algorithm.

  • SHA224: Use the SHA224 algorithm.

  • SHA256: Use the SHA256 algorithm.

  • SHA384: Use the SHA384 algorithm.

  • SHA512: Use the SHA512 algorithm.

Client Certificate

Content of the UA Client certificate.

Network Serializer

OPC UA network serializer options. Please note that such settings should only be modified with good reason as they may affect the overall reliability of the OPC UA communication stack.

Max. Alloc

The largest size of a memory block the serializer can do when deserializing a message.

Max. Byte String Length

The largest byte string accepted by the serializer.

Max. String Length

The largest string accepted by the serializer.

Max. Array Elements

Maximum number of elements in an array accepted by the serializer.

Max. Message Size

The maximum number of bytes per message in total.

TCP Connection

OPC UA network connection options. Please note that such settings should only be modified with good reason as they may affect the overall reliability of the OPC UA communication stack.

Max. Message Length

The default and maximum size for messages. Affects memory usage.

Default Chunk Size

The maximum number of chunks per message in total.

Max. Chunk Count

The default and maximum number of message chunks per message. Affects memory usage.

Startup Script

Property compound to setup the object’s startup script.

Lua Script Body

Script editor to enter an advanced Lua script.

Timeout

Timeout in seconds, used for determining the script’s execution state.

State

State of execution for the startup script.

Scratch

Scratch output container, which is accessiblee during execution of the startup script.

Script Library

The script library compound contains Lua-Script libraries.

Module Name

The Lua module name of the library that will be used to reference the library by its users.

Lua Script Body

Script editor to enter an advanced Lua script.

Mandatory Execution

Execute the script library when initializing the Lua environment for child objects.

Location

The location of the object.

Strategy

Definition of the location strategy.

  • No location: This object is not interpreted in a location context.

  • Static (or manually changed) location: You may set the location data manually, by Engineering Script or by selecting the location visually using the Location Finder feature.

  • Inherited location: The object inherits the location from the owning object in the system hierarchy.

  • Dynamic location: The object location is supplied by other I/O Items. You may drop other I/O items into the location fields of this object.

  • Location properties: The endpoint server has distinct properties for I/O item location data. Please note, that this option works only for I/O items .

Name

The optional name of a location.

Latitude

The north-south position of a point on the Earth’s surface.

Longitude

The east-west position of a point on the Earth’s surface.

Altitude

The height above sea level of the location.

Track Location

Enables historization of Location data.

Store and Forward Retention Method

Store and Forward retention method selection.

On disk (size limited)

Persist Store and Forward items on disk up to an absolute size limit.

On disk (relative limit)

Persist Store and Forward items on disk up to a given percentage of the disks capacity.

On disk (time limit)

Persist Store and Forward items on disk and discard items that are older than a given date.

Main memory

Retain Store and Forward items in main memory only.

None

Do not retain items in any buffers.

Store and Forward Options

General configuration options for Store and Forward.

Operating Status

The current operating status of the Store and Forward system.

  • Normal: The Store and Forward system is operational.

  • Warning: The Store and Forward system is in a warning state.

  • Degraded (data corruption): The Store and Forward data in the disk database is corrupt. Operating in Fallback Mode.

  • Normal (repaired): The Store and Forward system is operational (it was corrupt but has been repaired).

  • Normal (destroyed): The Store and Forward system is operational (the disk database has been destroyed due to a purge action or because it could not be opened).

  • Repair in Progress: The Store and Forward disk database is being repaired.

  • Destroy in Progress: The Store and Forward disk database is being destroyed.

  • Degraded (disk IO error): A disk IO error occurred. Operating in fallback mode.

  • Error: An internal error occurred.

  • Warning (disk full): The Store and Forward system is using disk storage to its configured capacity.

  • Warning (configuration): The Store and Forwad system configuration is erroneous.

  • Warning (disk usage): The warning threshold for the Store and Forward disk usage has been reached.

  • Warning (disk statistics): An error occurred when retrieving disk usage statistics.

  • Warning (main memory): One of the Store and Forward main memory queues is being used to its capacity.

  • Degraded (unknown disk error): An unknown disk error occurred. Operating in fallback mode.

  • Unknown: The Store and Forward system operating state is unknown at the moment.

Keep Lost Data

Keep lost data after repairing a corrupted Store and Forward database.

Free Message Retention

The time period for which free messages (not associated with an object) are retained in the SaF database.

VQT Data Limit

Size limit for Store and Forward VQT data transmissions per network round-trip.

Log Limit

Size limit for Store and Forward Log entry transmissions per network round-trip.

Event Limit

Size limit for Store and Forward Event transmissions per network round-trip.

Audit Trail Limit

Size limit for Store and Forward Audit Trail entry transmissions per network round-trip.

Debugging

Please only change this as instructed by Support.

Real-time Data Transmission Limits

Limits for real-time data transmissions.

Total Limit

Total size limit for real-time data transmissions per network round-trip.

VQT Data

Size limit for real-time VQT data transmissions per network round-trip.

Auxiliary State Management

Configurable settings for auxiliary state management.

Strategy

Specifies how auxiliary state changes are handled.

  • Inherit: Inherit the setting from the parent object. In case of no parent object, the "Persist" mode is used.

  • Persist: All object auxiliary states are indicated and persisted to the archive.

  • Volatile: Auxiliary state changes are volatile and not persisted.

  • Inhibit: Inhibit all auxiliary state changes.

SQL Catalog

A catalog of the properties of objects in the component which can be queried via SQL interface. Any changes will only be read on restart.

Creation Options

Options to create the SQL catalog.

  • Do Not Create Catalog: Catalog is not created. It’s not possible to query the properties in the component.

  • Create Catalog: Catalog is created and can be used for querying.

  • Create Indexed Catalog: Catalog is created and indexed for quicker search.

Enable Integer Type Affinity

Convert property values to integral numbers if possible.

Package Installer

Package Installer configuration and runtime state.

Packages

This is the desired package configuration for this service component.

Package Name

The version-independent package name.

Package Version

The dotted version string, such as 2.14.5.7. This is either the minimal or the exact version that will be installed depending on other configuration settings.

Instance Name

The instance name. It can be left blank if multiple instances are not needed.

Automatic Update

Whether the package should be automatically updated to higher version as they become available in the system store.

Exact Version

Whether the configured package version must match exactly the version of the installed package.

Configuration String

An opaque configuration string that is passed to the package when it is installed.

Package Installer Status

This is used by the Package Installer to orchestrate package distribution.

Package Installer Diagnostics

This is diagnostic information provided by the Package Installer.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String

A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name

A custom property name which can be used programmatically.

Property Value

The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name

A custom table name which can be used programmatically.

Table Data

Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.