Skip to main content
Skip table of contents

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 there are warning messages,

  • how the status changes during the execution of a workflow.

The status information is displayed using 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

  • S7 PLC

  • Stopwatch

  • TCP


Using the Workflow Component Status in the Workflow

Position of 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 respective 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 at once without opening each component individually.

Bild (1).png

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

Display of Status Information

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

Bild (2).png

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

Status Color

System Assessment

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 function essential 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 pointing to a possible impairment of functionality.

Gray

The component is in an initial state where no concrete statement about the connection status is yet available.

Notes on the interpretation from the user's perspective and 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 are made visible by a color change on the status pills in the "Components" list in the "My Workflow" tab.

Examples of visible changes:

  • A status pill changes from green to red when a connection fails.

  • A previously red pill changes 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 affect the component's behavior. Typical actions include:

  • 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 availability of these systems is reflected in the status (e.g., changing from green to red when a device is switched off).

Interpretation of the Status Indicators

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

Status Color

Interpretation from User 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 if the affected components are green again.

  • Green indicates that there is currently no need for action.

Yellow

  • There is an anomaly or warning.

  • The workflow might 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 preventing the proper operation of the component.

  • In many cases, the workflow is at least partially impaired or not operational.

  • An analysis and resolution of the cause is necessary.

  • For hardware components, this can indicate that they are missing, e.g., a Loxi-Light unit.

  • Analyze components with red status first.

  • Check if connections, configuration, and external systems are working correctly.

Gray

  • No information about the connection status is yet available.

  • There is no immediate need for action.

  • Start the workflow to initiate the connection and obtain an initial result.


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 these in detail.

Commissioning of 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, for example, to red.

    • After the cause is resolved, the pill returns to green.

  • The user can promptly track disruptions and their resolutions.


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 runtime environment

    • The displayed status values depend on the actual accessibility 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.

    • In case of connection interruptions, status changes may appear delayed until the connection is restored.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.