@scaleoutsoftware/digital_twin_ig_worker v0.6.0

ScaleOut Digital Twin Builder Invocation Grid Worker

This package serves as a Node-based event sink for the ScaleOut Digital Twin Builder (TM). It receives messages for real-time digital twins running in the ScaleOut Digital Twin Streaming Service (TM) or on-premise using ScaleOut StreamServer (TM). These messages originate from other client programs, such as the ScaleOut Digital Twin Client library for Javascript.

For more information, please see the ScaleOut Digital Twin Streaming Service User Guide.

Installation

This package is only intended for use with ScaleOut StreamServer. To receive events using Node.js, first ensure that Node.js is installed on all hosts in the ScaleOut store and available on the system path (you may need to restart the ScaleOut service after installation for it to recognize the new system path). Then, using an administrative shell, navigate to the ScaleOut StreamServer installation directory and use NPM to install this package:

npm install @scaleoutsoftware/digital_twin_ig_worker

After installing this package, you can start a Node-based invocation grid to receive events for a Digital Twin model using the soss.exe command-line control program:

soss start_ig node DT_NAME RESOURCE_FILE [COMMAND_LINE_PARAMS]

where the parameters are:

DT_NAME - The name of the Digital Twin model to be registered and deployed.

RESOURCE_FILE - Location of the file containing the custom message handling logic. This must be either a single .js file or a .zip archive whose name corresponds to the DT_NAME argument.

COMMAND_LINE_PARAMS - Optional, arbitrary command line argument(s) to pass to Node.js worker processes. For example, the Node.js --inspect flag may used to enable debugging of the worker process.

The Digital Twin model event handling for Javascript is further described in the ScaleOut Digital Twin Builder User Guide.

Other Documentation

Please visit the ScaleOut Software Documentation page for additional information on the ScaleOut Digital Twin Builder.

For support information and options, please visit https://www.scaleoutsoftware.com/scaleout-support/.