Managing Bus Stops

Hide Topic ContentsShow Topic Contents
  1. About Bus Stops
  2. Installing a Bus Stop
  3. Bus Stop Types
  4. Create or Modify a Bus Stop
    1. General Info and NServiceBus Info
    2. Select Operations to be Handled by Bus Stop
    3. Select Topics to be Handled by Bus Stop
    4. Select Equipment Bus Stop will Communicate with
    5. Select Channels Bus Stop will Use to Communicate
    6. Select Actions Bus Stop will Take for Channel Data
    7. Select Bus Messages Bus Stop will Subscribe to
    8. Select Actions Bus Stop will Take for Bus Message Data
    9. Configure NServiceBus

About Bus Stops

Bus Stops are the interfaces between ATS Bus and the outside world. Bus Stops translate data into B2MML before putting it onto the bus. Other Bus Stops that require that data can then read it and translate it into the appropriate format before sending it to the appropriate recipient.

Installing a Bus Stop

The bus stops must first be installed on the required servers and then the individual bus stops can be configured using Cockpit. Installation and configuration is the same for all bus stop types.

Installing Bus Stops

Bus Stop Types

OT

OT (Operational Technology) Bus Stops allow data to be exchanged with equipment on the factory floor.

IT

IT (Information Technology) Bus Stops allow data to be exchanged with IT systems, such as MES, MOM, ERP and PLM.

ADOS

ADOS Bus Stops allow ADOS applications to connect to the Bus.

Cloud

Cloud Bus Stops allow data to be exchanged with Azure Event Hubs and Azure IoT Hub on the cloud.

Create or Modify a Bus Stop

Select the required bus stop tab.

Click Bus Stops.

A list of the existing bus stops is shown.

Click Add to create a new bus stop or double-click on an existing bus stop to modify it.

A new window opens.

General Info and NServiceBus Info

Enter the required information in the General tab.

Name: A unique name for the bus stop.

Host and Monitoring Port: The host where the bus stop will be hosted and the port number at which the monitoring interface (REST API) will listen.

Enable heartbeat plug-in: A tool named ServicePulse shows the bus stop’s (endpoint) availability using this plug-in. The plug-in sends heartbeat messages to ServiceControl.

More information about heartbeats can be found online here and here.

Enable saga plug-in: This plug-in enables the ‘Saga’ view in ServiceInsight. Sagas are containers that can be used by various handlers to add information. Sagas are used for long running operations such as work orders. More information about the plug-in can be found on:

More information about sagas can be found online here.

Immediate retries: How often to immediately retry the message. Remove the tick to override the default value.

Delayed retries: How often to repeat the immediate retries. Remove the tick to override the default value.

Enter a description in all required languages.

Select Operations to be Handled by Bus Stop

Enable the operations that will be handled by the bus stop in the Operations tab.

The Operations tab is not available in the Archive bus stop.

If you are using an OT bus stop select the Data Type Scope Description for each enabled operation.

For information on operations see here.

Select Topics to be Handled by Bus Stop

The Topics tab is not available in the Archive bus stop.

Enable the topics that will be handled by the bus stop in the Topics tab.

Select Equipment Bus Stop will Communicate with

The Equipment tab is only available in the OT bus stop.

The Equipment tab allows you to select which equipment this bus stop will communicate with.

Enable the equipment that will be handled by this bus stop in the Equipment tab.

The selected equipment will appear in the right-hand column.

For information on creating the equipment hierarchy see here.

Select Channels Bus Stop will Use to Communicate

The Channels  tab is not available in the Archive bus stop.

The Channels tab allows you to select the channels that will be used by this bus stop to communicate with the outside world. The messages handled by the selected channels will be available in the Channel Message Handling tab.

Enable the channels that will be handled by this bus stop in the Channels tab.

Select Actions Bus Stop will Take for Channel Data

The Channel Message Handling tab is not available in the Archive bus stop.

The Channel Message Handling tab allows you to define the actions that will be taken when messages are received through the channels that were selected in the Channels tab.

Select the Channel Message Handling tab.

The left-hand pane lists the channels and the messages they contain. The right-hand pane lists the actions that can be carried out.

In the right-hand pane select the Upload or Download tab to choose the type of action you want.

Drag and drop an action onto a message on the left-hand pane.

Alternatively, you can select a message, click Add and select an action from the drop-down list.

Enter the required message action parameters.

Click OK.

The action is added to the list.

Select Bus Messages Bus Stop will Subscribe to

This tab allows you to select the bus messages that will be handled by this bus stop. The messages selected in this tab will be available in the Bus Message Handling tab.

Select the Subscribed Messages tab.

Every combination of operation and bus message type is listed.

For information on managing operations see here.

Enable the messages that will be handled by this bus stop.

Select Actions Bus Stop will Take for Bus Message Data

Not available in the Archive bus stop.

The Bus Message Handling tab allows you to define the actions that will be taken when messages are received from the Bus. These are messages that were selected in the Bus Messages tab.

Select the Bus Message Handling tab.

The left-hand pane lists the bus message type and the operations. The right-hand pane lists the actions that can be carried out.

In the right-hand pane select the Upload or Download tab to choose the type of action you want.

Drag and drop an action onto an operation on the left-hand pane. Alternatively, you can select an operation, click Add and select an action from the drop-down list.

For information on managing operations see here.

Enter the required message action parameters.

Click OK.

The action is added to the list.

Configure NServiceBus

ATS Bus allows bus stops to override the default NServiceBus Recoverability settings. It also allows plug-ins to be enabled.

Select the NServiceBus tab.

Select the plugins to be used:

Enable heartbeat plug-in: Every 10 seconds, the bus stop will send heartbeat messages to ServiceControl once this feature is enabled. ServiceControl will keep track of these heartbeats and mark a bus stop as active if it receives them on a regular interval and will mark it as inactive if it doesn’t. ServicePulse, the NServiceBus monitoring tool, shows the active/inactive state of the bus stops. This feature is enabled by default when creating a new bus stop, it may be disabled but it is recommended to keep it enabled to allow monitor the active/inactive state of a bus stop.

More information about heartbeats can be found online here and here.

Enable metrics/monitoring: Allows bus stop throughput, processing times and other KPI’s to be monitored in Particular ServicePulse. It shows how well the bus stop is performing.

Enable message auditing: Auditing has a considerable impact on the performance of the monitoring node and the required disk space. Messages not being audited are not shown in ServiceInsight and are not stored in the ServiceControl persistence.

Enable saga auditing (only available in OT bus stop): This plug-in enables the ‘Saga’ view in ServiceInsight. Sagas are containers that can be used by various handlers to add information. Sagas are used for long running operations such as work orders. More information about the plug-in can be found on:

More information about sagas can be found online here.

Configure how the bus stop should recover after a connection loss:

Immediate retries: How often to immediately retry the message. Remove the tick to override the default value.

Delayed retries: How often to repeat the immediate retries. Remove the tick to override the default value.

Specify which messages should not be audited by adding them to the Message Auditing Filter (Only available in the OT bus stop). This option is an addition to message auditing and is only visible when message auditing is enabled. This option allows the user to add channel messages to an exclusion list that should not be audited.

Can we improve this topic?