Core

The Core object is the representative of a Core service, the central element of the system, in the I/O Model.

Normal installations of the system only have a single Core service running for the whole system. In large scale installations the use of Local Cores may be beneficial. Local Cores are located under a Master Core with the local Core service running on a remote machine. Although the Local Core can be accessed directly with client applications such as DataStudio, operations such as deleting objects can only be done on a Master Core level with the necessary credentials.

For more information about Local Cores, their uses and how they are related to the Master Core, see Autonomous Site Operation.

Regarding Configuration

The fundamental configuration of a Core takes place during the installation of the Core Service, i.e. during the system setup.

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.

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.

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.

Host Name or IP

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

Server Port

TCP Server port for the inmation core server communication with user processes. This port must be accesible through your network and firewall infrastructure.

Client Timeout

Value in seconds for the client communication timeout. Connections from non-service clients to the core service (e.g. from DataStudio) are considered to be unavailable and are terminated after the specified timeout if no data is transmitted.

Attachments

File attachments stored in MongoDB file store.

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.

Security Settings

The security settings for the component.

Security Mode

The security mode for components communicating to an inmation core service.

  • None: No security is applied to component communication.

  • Passphrase: The Core service uses a passphrase to authenticate actively connecting remote components.

  • TLS-SRP: TLS connection with SRP authentication.

  • TLS-X.509: TLS connection with X.509 certificate-based authentication.

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.

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.

Local Core Settings

Contains settings for the Local Core component represented by this object (not applicable to the Master Core).

Performance Metrics Forward Mode

Specify how performance metrics (counters) are forwarded to the parent component.

  • Inhibit: Performance counter values are not forwarded to the parent component.

  • All: All performance counter values are forwarded to the parent component.

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.

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.

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.

Data Store Configuration

Data store configuration compound.

Data Store Sets

Maps sets of data stores to logical groups.

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.

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.