Workflow Component Status

Overview

The Workflow Component Status displays the current state of selected workflow components from the application's perspective directly in the user interface. The user can see at a glance:

whether a component is currently rated as "okay" or "faulty",
whether warning messages exist,
how the state changes during the execution of a workflow.

The status information is displayed through colored, compact UI elements and updates automatically without the user needing to reload the page.

Currently, the Workflow Component Status is available for the following components:

GPIO Trigger
Kafka
Loxi Light
MQTT
NATS
OPC UA
Remote Camera
S7 PLC
Stopwatch
TCP

Using the Workflow Component Status in the Workflow

Position of the Component Status in the User Interface

In the list of workflow components in the “My Workflow” tab, a colored status pill is displayed next to the corresponding components. The pill is located in the same row as the component name and the key configuration information. This allows the user to check the status of multiple components simultaneously without opening each component individually.

The detail view of the component indicates whether a status is displayed for this component and what it means.

Display of Status Information

The status is represented by a colored pill. The pill can be exclusively colored (purely visual signal) or additionally contain a short text in the form of a tooltip (e.g., "OK", "Error", "Warning").

The application uses a consistent color scheme for status values. The colors exclusively describe the system-side evaluation of availability and functionality of a component.

Status color	System Evaluation
Green	The component is rated as operational and reachable. The connection or functionality is currently stable.
Red	The component is in a fault state. A critical function for operation (e.g., a connection) is not available.
Yellow	The component reports a warning status or is in a transitional state. There are indications suggesting a possible impairment of functionality.
Gray	The component is in an initial state where no concrete statement about the connection status can yet be made.

Notes on the interpretation from the user's perspective and on typical reactions to the individual colors can be found in the section "Interpretation of the status indicators".

Automatic Real-Time Update

While a workflow is running, the Workflow Component Status updates automatically. Changes to the state of a component are displayed directly in the UI. The user does not need to reload the page to see status changes.

If there are changes, they become visible by a color change in the status pills in the "Components" list on the “My Workflow” tab.

Examples of visible changes:

A status pill changes from green to red when a connection fails.
A previously red pill switches back to green when the connection is restored.
A pill can temporarily show yellow when a warning state is detected.

User Interactions and Impact on Status

Actions that affect the displayed status

The user does not directly change the Workflow Component Status, but only through actions that influence the behavior of the component. Typical actions are:

Starting a workflow
- Connections or components are activated.
- Shortly after starting, the first status becomes visible (e.g., green for successful connection, red for connection error).
Stopping a workflow
- Connections can be terminated in a controlled manner.
- After stopping the workflow, the Workflow Component Status returns to its initial state.
Changing connection settings
- Adjusting IP addresses, ports, credentials, or similar parameters.
- After saving and restarting the workflow, the status can change, for example, from red to green if the connection can now be established correctly.
Physical interventions on the system
- Turning external systems on or off (e.g., controllers, sensors, cameras, servers).
- The accessibility of these systems is reflected in the status (e.g., change from green to red when a device is turned off).

Interpretation of Status Indicators

Based on the system evaluation described in "Representation of Status Information", the user utilizes the status display to quickly and reliably assess the condition of components:

Status color	Interpretation from the user's perspective	Recommendations for Users
Green	The component is ready for use from the application's perspective. The workflow can operate with this component as intended. There is no immediate need for action.	After changes (e.g., configuration or hardware), briefly check whether the affected components are green again. Green indicates that there is currently no need for action.
Yellow	There is an anomaly or a warning. The workflow may still function, but with limitations or increased risk. It is advisable to check the cause before using the workflow productively in the long term.	Do not ignore warning states. Check configuration and logic to avoid possible errors.
Red	There is a malfunction that prevents the proper operation of the component. In many cases, the workflow is at least partially impaired or not operational as a result. An analysis and resolution of the cause is necessary. For hardware components, this can be an indication that they are not present, e.g., a Loxi-Light unit.	Analyze components with red status first. Check if connections, configuration, and external systems are working correctly.
Gray	There is no information available about the connection status yet. There is no immediate need for action.	Start the workflow to initialize the connection setup and obtain an initial result.

Component-Specific Status Detection: (Remote) Camera

Specific rules apply to (Remote) Camera Components for status determination, which differ from the other components.

Status Values

The status of a camera component knows only two states:

Status	Color	Meaning
Available	Green	The camera is reachable and delivers images.
Unavailable	Red	The camera is not reachable or does not deliver images.

Investigation Principle

The status of a camera is derived from the reception of the image stream (Image). The image is the central key for status evaluation:

As long as images are received, the camera is rated as Available.
As soon as no image is received anymore, the status changes to Unavailable.

The check is performed with every transmission of an image.

Conditions for the status "Available"

The status is set to Available (Green) when all the following conditions are met:

The connection to the camera is established.
Authentication was successful.
Access to the video stream or the storage medium is possible.

Triggers for the status "Unavailable"

The status changes to Unavailable (red) as soon as one of the following situations occurs:

No image stream is being received anymore.
A network outage prevents connection to the camera.
Authentication fails.
Access to the storage medium is not possible.

Initial status and distance

Initial status: Newly added camera components receive their initial status no later than after the first inspection interval.
Removal: When a camera component is removed from the workflow, no status is provided for this object anymore.

Real-time Update

Status changes are streamed in real time. You see changes (e.g., switching from green to red in the event of a camera failure) immediately in the component list without needing to reload the page.

Typical Use Cases

Visual Inspection of Connection States in the Workflow Editor

The user opens the workflow editor.
In the "Components" list the relevant components are displayed with colored status pills.

Interpretation:

All relevant components are green → the workflow is stable from the components' perspective.
Individual components are yellow or red → the user can specifically select and examine them in detail.

Commissioning a New Connection

A new connection component is configured and the workflow is started.
In the “Components” list a colored status pill appears:
- Green → the current configuration is basically functional.
- Red → there is a fundamental problem (e.g., no connection possible).
The user can recognize without additional diagnostic tools whether the basic communication is working.

Runtime Monitoring in Productive Use

The workflow runs continuously or over extended periods.
The user keeps the workflow editor open or accesses it regularly.
Status changes are displayed automatically:
- If a previously green component fails, the status pill changes, e.g., to red.
- After resolving the cause, the pill returns to green.
The user can track disruptions and their resolution promptly.

Monitoring Camera Availability During Operation

The workflow has started and contains one or more (remote) camera components.
In the "Components" list on the "My Workflow" tab, the status pill indicates whether the respective camera is reachable and delivering images.
If a camera fails (e.g., due to network interruption or authentication error), the pill changes from green to red.
After the problem is resolved (e.g., camera reachable again, network restored), the status automatically switches back to green.
This allows the user to immediately see which cameras are operational and where action is needed.

Notes and Limitations

Pure display, no manual override
- The Workflow Component Status cannot be "overridden" or manually set in the UI.
- It results exclusively from the evaluation of the system state.
Dependency on the runtime environment
- The displayed status values depend on the actual availability and functionality of the components.
- Network issues, powered-off devices, or faulty configurations are immediately reflected in the status.
Real-time updates dependent on connection
- Automatic updates require a stable connection between client and server.
- During connection interruptions, status changes may appear delayed until the connection is restored.