esi-examples

Function head:

Installs the chosen example in a folder named Examples underneath the system core object.

The function expects a multi-dimensional Lua table containing the name of the example(s) to be installed and possible additional parameters.

Available examples:

Valid Lua usages:

This creates various sets of Demo Data for training and testing purposes. Demo data and objects for I/O Model, KPI Model and ISA-95 model, including historical data, can be created.

This example provides an Action Item with a Lua script to point local data stores to a different Mongodb instance.

The example can be loaded from a Console Display in DataStudio with the following simple Lua code:

The code above will create a folder structruce "Examples/Remote Mongodb" underneath the Core object in I/O Model. In this folder will be a single, disabled Action Item named "Repoint Data Stores". This Action Item contains a Lua script body that illustrates how to repoint the several of the standard data stores to a different standalone Mongodb server.

This example connects to an SMTP server to send emails using the esi-SMTP library

The example can be loaded from a Console Display in DataStudio with the following simple Lua code:

The code above will create a folder structure "Examples/Sendmail" underneath the Core object in I/O Model.

The Weather Data example uses the esi-lcurl-http-client library to fetch weather data from the German Weather Service ("DWD - Deutscher Wetterdienst") servers.

This is an official public server and the data is made available in an HTML file that can be downloaded from this URL: https://www.dwd.de/DWD/wetter/aktuell/deutschland/tabelle/wx_brd_akt.html

A Lua script parses this HTML file and then creates objects in I/O model that contain this data.

The example can be loaded from a Console Display in DataStudio with the following simple Lua code:

The code above will create a folder structure "Examples/Weather Data" underneath the Core object in I/O Model.

In order to illustrate the use of the batch tracker feature, an example use case was chosen to is relatively easy to comprehend for everyone. A bread factory represents a scenario everybody can relate to, and baking simple wheat bread, for example, is something everybody can do in their kitchen at home.

The example can be loaded from a Console Display in DataStudio with the following simple Lua code:

The code above will create a folder structruce "Examples/Bread Factory" underneath the Core object in I/O Model, and it will also create an enterprise structure in the ISA95 Equipment Model.

After the initial setup, the simulated bread factory will not be active and its objects in I/O model will appear disabled. To activate the simulation, enable the "00 MES" object:

This example uses the esi-lcurl-http-client library to fetch data in XML format from an official US government server: https://soa.smext.faa.gov/asws/api/airport/status/

A Lua script parses the XML file and then creates an object representing the data in I/O model.

The example can be loaded from a Console Display in Data Studio with the following simple Lua code:

The code above will create a folder structruce "Examples/US Airport Data" underneath the Core object in I/O Model.

The sample automatically initializes itself and directly begins downloading the data and creating the I/O model objects for each US airport.

This example demonstrates ODBC access using Lua scripts.

he example can be loaded from a Console Display in Data Studio with the following simple Lua code:

The code above will create a folder structruce "Examples/ODBC" underneath the Core object in I/O Model.

The created objects contain Lua script bodies to showcase the use of ODBC.

This example demonstrates JSON processing using Lua scripts.

The example can be loaded from a Console Display in Data Studio with the following simple Lua code:

The code above will create a folder structruce "Examples/JSON" underneath the Core object in I/O Model.

The created objects contain Lua script bodies to showcase JSON processing.

The example can be loaded from a Console Display in Data Studio with the following simple Lua code:

The code above will create a folder structure 'Examples/OEE' underneath the Core object in I/O Model. This structure hosts the OEE Simulator Action Item and all objects providing simulated data. In the ISA-95 Equipment Model 'The OEE Demo Enterprise' hierarchy will be added. This is the simulation enterprise with all it’s subsections. The OEE Equipment Monitor and the configuration objects are located in this structure (see below). When the OEE Equipment Monitor is running, the Output Objects for the OEE indices will also be found there, underneath the OEE Equipment Monitor object. In the KPI Model the 'OEE Demo KPI Root Node' is generated.

The OEE Simulator Action Item in the I/O Model starts producing simulation data on installation.

To launch the calculation of OEE Indices for this simulation, go to the ISA-95 Equipment Model and select the OEE Equipment Monitor object which is located at …​

... and in the Properties Panel go to the Common section. For the Processing Mode property select 'Production' from the drop-down list, then click 'Apply' for the Properties Panel.