LogoLogo
Contact Uscybus.io
Connectware 1.10.0
Connectware 1.10.0
  • Getting Started
    • Introduction
    • Installing Connectware
      • System Requirements
      • Acquiring your License Key
      • Installing Connectware on Docker
      • Installing Connectware on Kubernetes
    • Connectware Admin UI
    • Basic Components of Connectware
    • Connecting your First Machine
      • Your First Service Commissioning File
  • Documentation
    • Services
      • Service Overview
      • Service Resources View
        • Service Links View
        • Servers View
        • Containers View
        • Volumes View
        • Connections View
        • Endpoints View
        • Mappings View
      • Service Details View
      • Service Commissioning Files
        • Structure of Service Commissioning Files
          • Version
          • Description
          • Metadata
          • Parameters
          • Definitions
          • Resources
            • Cybus::Connection
            • Cybus::Endpoint
            • Cybus:Mapping
            • Cybus::Container
              • Docker problem with network changes
            • Cybus::Link
            • Cybus::IngressRoute
            • Cybus::User
            • Cybus::Role
            • Cybus::Volume
            • Cybus::File
            • Cybus::Server
            • Cybus::Node
      • Setting Up and Configuring Services
        • Installing Services
        • Enabling Services
        • Updating Services
        • Disabling Services
        • Deleting Services
      • FlowSync
        • Example 1 - Node with Transaction Mode (HTTP)
        • Example 2 - Node Responds (HTTP)
        • Example 3 - Node with Error (HTTP)
        • Example 4 - Node with Timeout Error Code and Error Message (HTTP)
        • Example 5 - Full Transactional Data Flow (HTTP)
        • Example 6 - Full Transactional Data Flow (OPC UA)
      • ServiceID
      • Inter-Service Referencing
      • Deviation
      • Service Logs
        • Logs of Individual Services
        • Logs of All Services
      • Rule Engine
        • Data Processing Rules
        • Rule Sandbox
      • Shared Subscriptions
        • Setting Up Shared Subscriptions
    • User Management
      • Users and Roles View
      • Users
      • Roles
      • Permissions
      • Password Policy Rules
      • Default Admin User
      • MQTT Users
      • Adding a MQTT Publish Prefix for Users
      • Multi-Factor Authentication
      • Single Sign-On (SS0)
        • Single Sign-On with Microsoft Entra ID
        • Single Sign-On with LDAP
      • Long lived JSON Web Tokens
      • Access Permissions for Admin-UI
        • UI Access
        • Minimum Access Role Pages
    • Client Registry
      • Implicit Flow
      • Explicit Flow
      • Granting Access
    • Certificates
    • Monitoring
      • Data Explorer
      • Live Data
    • Workbench
      • Flows in Git Repositories
    • System Status
      • Info
      • Metrics
      • Status
      • Retrieving More System Information
      • System Health
    • Backup and Restore
      • Volumes
      • User Database
    • Environment Variables
    • Agents
      • Agents View
      • Installing Agents
        • Installing Agents via Docker
        • Installing Agents via Docker Compose
        • Installing Agents via Kubernetes
        • Using Mutual TLS for Agents
      • Registering Agents in Connectware
      • Using Agents
      • Monitoring Agents
      • Troubleshooting Agents
    • Industry Protocol Details
      • ADS
        • ADS Connection Properties
        • ADS Endpoint Properties
      • BACnet
        • BACnet Connection Properties
        • BACnet Endpoint Properties
      • EtherNet/IP
        • EtherNet/Ip Connection Properties
        • EtherNet/Ip Endpoint Properties
      • FOCAS
        • FOCAS Connection Properties
        • FOCAS Endpoint Properties
      • Generic VRPC
        • Generic VRPC Connection Properties
        • Generic VRPC Endpoint Properties
      • Hottinger Baldwin Messtechnik (HBM)
        • HBM Connection Properties
        • HBM Endpoint Properties
      • Heidenhain DNC
        • Heidenhain DNC Connection Properties
        • Heidenhain DNC Endpoint Properties
      • HTTP/REST
        • HTTP/REST Connection Properties
        • HTTP/REST Endpoint Properties
      • HTTP Server/Node
        • HTTP Server Properties
        • HTTP Node Properties
      • InfluxDB
        • InfluxDB Connection Properties
        • InfluxDB Endpoint Properties
      • Kafka
        • Kafka Connection Properties
        • Kafka Endpoint Properties
      • Modbus/TCP
        • Modbus/TCP Connection Properties
        • Modbus/TCP Endpoint Properties
      • MQTT
        • MQTT Connection Properties
        • MQTT Endpoint Properties
      • MSSQL
        • Mssql Connection Properties
        • Mssql Endpoint Properties
      • OPC DA
        • OPC DA Connection Properties
        • OPC DA Endpoint Properties
      • OPC UA
        • OPC UA Client
          • OPC UA Client Connection Properties
          • OPC UA Client Endpoint Properties
        • OPC UA Server
          • OPC UA Server Properties
          • OPC UA Node Properties
        • OPC UA Object Types
        • OPC UA Server References
          • OPC UA Reference Node
          • OPC UA Object Node
      • Siemens SIMATIC S7
        • Siemens S7 Connection Properties
        • Siemens S7 Endpoint Properties
      • Shdr
        • Shdr Connection Properties
        • Shdr Endpoint Properties
      • SINUMERIK
        • SINUMERIK Connection Properties
        • SINUMERIK Endpoint Properties
      • SOPAS
        • SOPAS Connection Properties
        • SOPAS Endpoint Properties
      • SQL
        • SQL Connection Properties
        • SQL Endpoint Properties
      • Werma WIN Ethernet
        • Werma WIN Ethernet Connection Properties
        • Werma WIN Ethernet Endpoint Properties
      • Systemstate
        • Systemstate Connection Properties
        • Systemstate Endpoint Properties
    • Connectware Licensing
    • API Reference
      • User Management (API)
      • Client Registry (API)
      • Services (API)
      • Resources (API)
      • System Status (API)
      • Industry Protocol Details (API)
    • Changelog
      • General changes from 0.x to 1.0
        • Upgrading from 0.x to 1.0
    • Upgrade Guide
      • Upgrading from 1.x to 1.7.0
      • Upgrading from 1.x to 1.5.0
Powered by GitBook
LogoLogo

Cybus

  • Terms and Condition
  • Imprint
  • Data Privacy

© Copyright 2025, Cybus GmbH

On this page
  • Rule Sandbox View
  • Testing and Refining Data Processing Rules
  • Using Endpoint or MQTT Topic Data
  • Using Custom JSON Input

Was this helpful?

  1. Documentation
  2. Services
  3. Rule Engine

Rule Sandbox

The Rule Sandbox provides an isolated environment where you can test data processing rules.

The Rule Sandbox allows you to develop and test your data processing rules directly in Connectware without affecting your live data or production systems. In the Rule Sandbox, you can input sample data that represents what you expect in your actual data flows, set up your rules, and then run the simulation to see the results. This allows you to fine-tune your rules before deploying them in a live environment.

As the transformation source, you can select JSON, endpoints, or MQTT topics.

Here is an overview of what you can do with the Rule Sandbox:

Real-time Rule Execution

  • You can input sample data and immediately see how your rules process it. This allows you to verify that your rules are working as intended and to quickly iterate on your rule designs.

Step-by-step Visualization

  • The Rule Sandbox shows you how data moves through each step of your rule pipeline. You can see the input and output of each individual rule, helping you understand exactly how your data is being transformed at each stage.

Error Detection

  • If there are any issues with your rules, such as syntax errors or logical problems, the Rule Sandbox will highlight these, making it easier to debug your rules.

Performance Insights

  • While it's not a full-fledged performance testing tool, the Rule Sandbox can give you a general idea of how your rules perform, which can be useful for optimizing complex rule sets.

Rule Experimentation

  • You can modify rules, change their order, or try out new rule combinations to see how they affect your data processing. This makes it a valuable tool for developing and refining your data processing strategies.

Learning Tool

  • The Rule Sandbox can serve as an interactive learning environment where you can experiment with different rule types and see their effects in real-time.

Rule Sandbox View

This is an overview of the functions of the Rule Sandbox view.

  • To open the Rule Sandbox view, select Services > Rule Sandbox.

Select the transformation source

  • Select the source of your transformation. The following transformation sources are available:

    • JSON

    • Endpoint

    • MQTT Topic

Select an Endpoint

  • Select the endpoints for which you want to apply data processing rules. The list displays all endpoints that are currently connected to Connectware. You can select one or multiple endpoints. If you select multiple endpoints, the Last transformation input field always displays the data of the endpoint that was most recently updated.

Input the MQTT Topic

  • Select the MQTT topic for which you want to apply data processing rules. The Last transformation input field displays the data of the MQTT topic that you have selected.

Custom transformation input

  • If you have selected JSON as the transformation source, you can enter custom transformation input for testing your data processing rules.

Last transformation input

  • If you have selected Endpoint or MQTT Topic as the trasnformation source, this field displays the last detected transformation input for the selected endpoint or MQTT topic. You cannot enter custom transformation here.

Transformation rule expression

  • Enter the transformation rule expression that you want to test.

Transformation result

  • Displays the result of your transformation rule.

Testing and Refining Data Processing Rules

You can test and refine rules using real data from endpoints and MQTT topics, or create custom JSON input for custom scenarios.

Using Endpoint or MQTT Topic Data

  1. In the Rule Engine view, select Endpoint or MQTT Topics from the Select the transformation source menu.

  2. Do one of the following:

    • For Endpoint: Select an endpoint from the Select an Endpoint list.

    • For MQTT Topics: Specify the MQTT topic location in the Input the MQTT Topic field.

The result of your data processing rule is displayed in the Transformation result field.

Using Custom JSON Input

  1. In the Rule Engine view, select JSON from the Select the transformation source menu.

  2. Enter your custom JSON data in the Custom transformation input field.

The result of your data processing rule is displayed in the Transformation result field.

PreviousData Processing RulesNextShared Subscriptions

Last updated 4 months ago

Was this helpful?

Specify your data processing rule in the Transformation rule expression field. For a list of all data processing rules, see .

Specify your data processing rule in the Transformation rule expression field. For a list of all data processing rules, see .

Data Processing Rules
Data Processing Rules