System

The System object is the top object in the I/O model tree and is created upon installation as the parent object to the Core. The most important configuration options of the System object involve connection properties to the different MongoDB data stores including the time series, event, logging and production tracking data stores.

The System object can also be used to set to Auxillary State management settings for all objects in the I/O model and to house custom Lua script libraries that can be accessed by all objects in the system.

Quick Configuration

The System object is normally automatically configured during setup, including the connection and security settings for the MongoDB repositories. However it is sometimes necessary to change or check configuration settings when there is a problem with the system object.

An example is when the System object shows a yellow state colour. To diagnose the problem and find a potential solution, do the following steps.

  1. Right click on the System object and select Admin  Open Log  Last Day from the context menu

  2. The Log Display will show errors related to the System object including connection problems to the available data repositories/stores. Double click on a log entry to open the details panel and identify the repository that is causing the problem

  3. Open the Object properties panel of the System object and check the MongoDB connection settings of the Data Store causing the logged error.

  4. Firstly check that the connection settings are correct for the repository (Connection String and any security settings).

  5. Depending on whether the MongoDB repository is on a remote machine or local, check the network connectivity to the remote machine.

  6. Check that the MongoDB service is running on the local or remote host

  7. If none of these solutions solves the problem, contact inmation Support.

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.

Attachments

File attachments stored in MongoDB file store.

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.

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.

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.