System Objects for MSI Integration

There are dedicated objects in the system’s I/O Model used to handle messages sent to and from the MSI. The functions and properties of these objects are described below.

Overview of MSI integration
Figure 1. Overview of MSI Integration

Message Broker

The Message Broker object defines the basic setup of the interface. The Message Broker can be created below the Core in the I/O Model (right-click on the Core object in the I/O Model and select Admin  New  External Interfaces  Message Broker from the context menu to open the Create Object Wizard).

Apart from the mandatory Object Name and optional Object Description properties, the remaining Message Configuration properties are described below:

Message Broker - Properties Panel
Figure 2. Message Broker - Properties Panel

In the Common Property compound:

  • Processing Mode - During the configuration steps, the Processing Mode should be kept in "Configuration" mode. When everything is fully configured, the Processing Mode should be set to "Operation" to begin sending and receiving messages.

In the Message Type Options Property compound:

  • Message Type - The Message Type currently only supports MSI (other configurations to follow).

  • Protocol - For MSI Protocols, only the Web Service is currently supported (other configurations to follow).

  • Version - This is the version of the MSI interface itself, which can be selected to be MSI 1.3, MSI 2.0 or MSI 3.1. This depends on the PAS-X version in use. For the most common version PAS-X 3.1.8.x, MSI 1.3 should be used. For the newer version of PAS-X starting from 3.2.x, MSI 3.1 should be used.

  • Prefix - This configuration should be left empty for this example.

  • Folder - This configuration defines where the Message Configuration (XML) is stored. As the message configuration is generated by the Core, it is important that a folder is used, for which the Core Service has sufficient access rights for write operations.

  • System ID - This property holds the System ID described in the prerequisites section and it is vitally important that the value defined here matches the System ID configured in PAS-X.

  • Debug - If there are problems with the interface or its configuration, then activating Debug will generate more Log messages, simplifying the debugging process.

  • Endpoint to Shopfloor and Endpoint to MES - These are non-configurable properties that are automatically generated to provide Web API endpoints for the PAS-X configuration (see PAS-X Endpoint configuration).

Message Processor

The Message Processor object manages additional processing of incoming messages, as well as the preparation of outgoing messages. The Message Processor is created below the Message Broker in the I/O Model (right-click on the newly created Message Broker object in the I/O Model and select Admin  New  External Interfaces  Message Processor from the context menu to open the Create Object Wizard). Only an Object Name is required.

Message Processor - Properties Panel
Figure 3. Message Processor - Properties Panel

If the Central Mapping feature will not be used, then no further configuration of this object is required.

If the Central Mapping feature will be used, then the Central Mapping should be configured as a Historian Mapping table in this object. This table holds the Central Mapping as described in Central Mapping. It has exactly the same format as the mapping table for the Historian Mapping.

This mapping can be generated manually or automatically. For automatic generation, enable the Auto Generate Mapping Table property in the Common section of the Message Processor’s property panel. The automatic generation is based on information taken from the 'ISA95 Equipment Model' and is explained in detail in Auto-generation of Mapping.

Depending on the size of the ISA-95 Equipment mode, Auto Generation of the Mapping Table can be demanding on the host machine resources. To maximize efficiency and performance, it is strongly recommended to configure the Root Folder property on the Message Processor before activating the auto mapping.

Message Configuration

Message Configuration objects are required for the exchange of data between the MES and Shopfloor using the Web API. They can be created below Message Processor and Message Broker objects in the I/O Model (right click on the parent object and select Admin  New  External Interfaces  Message Configuration from the context menu to open the Create Object Wizard).

The properties and configuration of Message Configuration objects are explained in further detail here.