> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/data-flows.md).

# Building Data Flows

- [Services](https://docs.cybus.io/data-flows/services.md): Services allow you to automate deployment and management of multiple connected operations.
- [Managing Services](https://docs.cybus.io/data-flows/services/managing.md): Manage services in the Services view of Connectware, including installing, enabling, updating, disabling, and deleting them.
- [Installing Services](https://docs.cybus.io/data-flows/services/managing/installing.md): Upload service commissioning files to deploy services and check the prerequisites that prevent failed installations.
- [Enabling Services](https://docs.cybus.io/data-flows/services/managing/enabling.md): Enable services in the Connectware Admin UI after uploading a service commissioning file and grant the required resource access.
- [Updating Services](https://docs.cybus.io/data-flows/services/managing/updating.md): Update a service by uploading a new commissioning file or changing its parameters in the Admin UI.
- [Disabling Services](https://docs.cybus.io/data-flows/services/managing/disabling.md): Disable individual or multiple services in Connectware to stop their containers, connections, endpoints, and mappings.
- [Deleting Services](https://docs.cybus.io/data-flows/services/managing/deleting.md): Disable and delete services that you no longer need in the Services view of Connectware.
- [Service Overview](https://docs.cybus.io/data-flows/services/service-overview.md): Start in the Service Overview to install new services and drill down into the details of any running service.
- [Service Resources View](https://docs.cybus.io/data-flows/services/service-resources-view.md): Inspect every resource across all services from a single view instead of opening each Service Details view individually.
- [Service Links View](https://docs.cybus.io/data-flows/services/service-resources-view/service-links-view.md): Open external web pages or container-hosted web interfaces that services expose as Cybus::Link resources.
- [Servers View](https://docs.cybus.io/data-flows/services/service-resources-view/servers-view.md): Monitor the server resources that give clients access to Connectware data, such as OPC UA or REST servers, in the Servers View.
- [Containers View](https://docs.cybus.io/data-flows/services/service-resources-view/containers-view.md): Monitor the containers that run third-party applications for your services in the Containers View of Connectware.
- [Volumes View](https://docs.cybus.io/data-flows/services/service-resources-view/volumes-view.md): Check the persistent storage volumes that your services use in Docker Compose deployments of Connectware.
- [Connections View](https://docs.cybus.io/data-flows/services/service-resources-view/connections-view.md): Check which protocol connections of your services are currently established and inspect the details of each connection.
- [Endpoints View](https://docs.cybus.io/data-flows/services/service-resources-view/endpoints-view.md): Monitor the data endpoints of your services and their protocol addresses in the Endpoints View of Connectware.
- [Mappings View](https://docs.cybus.io/data-flows/services/service-resources-view/mappings-view.md): Follow how data flows through your services by inspecting all deployed mapping resources in Connectware.
- [Service Details View](https://docs.cybus.io/data-flows/services/service-details-view.md): Examine individual services in the Service Details view to inspect configurations, monitor live data and metrics, and access logs.
- [Service ID](https://docs.cybus.io/data-flows/services/serviceid.md): Unique identifier for services and inter-service communication.
- [Inter-Service Referencing](https://docs.cybus.io/data-flows/services/inter-service-referencing.md): Building modular service architecture by referencing resources across service commissioning files.
- [Deviations](https://docs.cybus.io/data-flows/services/deviations.md): Spot and fix service resources that do not reach their target state.
- [Service Logs](https://docs.cybus.io/data-flows/services/service-logs.md): Watch what your services are doing in near real time and narrow down issues with filters, search, and log export.
- [Logs of Individual Services](https://docs.cybus.io/data-flows/services/service-logs/service-logs-of-individual-services.md): Monitor, filter, search, and export the log messages of an individual service in the Service Logs tab of the Service Details view.
- [Logs of All Services](https://docs.cybus.io/data-flows/services/service-logs/service-logs-of-all-services.md): Monitor, filter, search, and export the service log messages of all services in the Service Logs view of Connectware.
- [Shared Subscriptions](https://docs.cybus.io/data-flows/services/shared-subscriptions.md): Distribute MQTT messages across a group of clients for load balancing, horizontal scaling, and fault tolerance.
- [Setting Up Shared Subscriptions](https://docs.cybus.io/data-flows/services/shared-subscriptions/setting-up-shared-subscriptions.md): Configure shared subscriptions in mappings and endpoints with ready-to-use service commissioning file examples.
- [Service Commissioning Files](https://docs.cybus.io/data-flows/service-commissioning-files.md): Learn the structure of service commissioning files, the YAML blueprints that define each service in Connectware.
- [Version](https://docs.cybus.io/data-flows/service-commissioning-files/version.md): Declare a version number for your service commissioning file to keep track of template revisions.
- [Description](https://docs.cybus.io/data-flows/service-commissioning-files/description.md): Summarize the purpose of your service in the required description section of the service commissioning file.
- [Metadata](https://docs.cybus.io/data-flows/service-commissioning-files/metadata.md): Specify structured information about your service, such as its name, icon, provider, and version, in the metadata section.
- [Parameters](https://docs.cybus.io/data-flows/service-commissioning-files/parameters.md): Customize services for different use cases with parameters that users set or confirm when installing or reconfiguring a service.
- [Definitions](https://docs.cybus.io/data-flows/service-commissioning-files/definitions.md): Define reusable value blocks in a service commissioning file and reference them with the !ref or !merge functions.
- [Resources](https://docs.cybus.io/data-flows/service-commissioning-files/resources.md): Define the resources of a service, such as connections, endpoints, mappings, and containers, in the resources section.
- [Cybus::Connection](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-connection.md): Establishing connectivity to external systems and devices.
- [Cybus::Container](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-container.md): Run custom Docker containers inside Connectware for data processing, dashboards, and integrations.
- [Docker Problem with Network Changes](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-container/docker-problem-with-network-changes.md): Understanding temporary connection losses caused by Docker’s default gateway selection during network reconfiguration.
- [Cybus::Endpoint](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-endpoint.md): Defining and managing data endpoints.
- [Cybus::File](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-file.md): Managing files inside Docker volumes.
- [Cybus::IngressRoute](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-ingressroute.md): Create secure entry points from outside Connectware to your service containers.
- [Cybus::Link](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-link.md): Providing quick access to external or internal web resources.
- [Cybus::Mapping](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-mapping.md): Transforming and routing MQTT data between topics.
- [Cybus::Node](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-node.md): Defining data points in a server.
- [Cybus::Role](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-role.md): Defining reusable permission sets.
- [Cybus::Server](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-server.md): Making data available through additional protocol servers.
- [Cybus::User](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-user.md): Defining users and access control.
- [Cybus::Volume](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-volume.md): Persistent storage for services.
- [Rule Engine](https://docs.cybus.io/data-flows/rule-engine.md): Transform and process data streams in Connectware with JSONata-based Rule Engine rules and test them in the Rule Sandbox.
- [Data Processing Rules](https://docs.cybus.io/data-flows/rule-engine/data-processing-rules.md): Apply data processing rules such as filter, transform, and collect in the resources section of your service commissioning files.
- [Rule Sandbox](https://docs.cybus.io/data-flows/rule-engine/rule-sandbox.md): The Rule Sandbox provides an isolated environment where you can test data processing rules.
- [FlowSync](https://docs.cybus.io/data-flows/flowsync.md): Handle synchronous request-response cycles between HTTP or OPC UA server nodes and MQTT with FlowSync in Connectware.
- [Example 1 - Node with Transaction Mode (HTTP)](https://docs.cybus.io/data-flows/flowsync/flowsync-example-1.md): Set up a basic FlowSync HTTP node in transaction mode and observe how requests time out when no MQTT response is published.
- [Example 2 - Node Responds (HTTP)](https://docs.cybus.io/data-flows/flowsync/flowsync-example-2.md): Build a complete FlowSync request-response cycle in which a mapping processes incoming HTTP requests and publishes responses.
- [Example 3 - Node with Error (HTTP)](https://docs.cybus.io/data-flows/flowsync/flowsync-example-3.md): Return custom error responses in FlowSync transactions by publishing an HTTP 500 error code and message for incoming requests.
- [Example 4 - Node with Timeout Error Code & Error Message (HTTP)](https://docs.cybus.io/data-flows/flowsync/flowsync-example-4.md): Customize FlowSync timeout handling with a specific timeout duration, error code, and error message for HTTP requests.
- [Example 5 - Full Transactional Data Flow (HTTP)](https://docs.cybus.io/data-flows/flowsync/flowsync-example-5.md): Implement a full FlowSync transaction flow that forwards DNS requests from a local HTTP endpoint to dns.google and returns the results.
- [Example 6 - Full Transactional Data Flow (OPC UA)](https://docs.cybus.io/data-flows/flowsync/flowsync-example-6.md): Expose an OPC UA method that triggers an HTTP request through FlowSync and returns the result as the method call output.
- [Agents](https://docs.cybus.io/data-flows/agents.md): Flexible, scalable, and secure data infrastructure with agents.
- [Agents View](https://docs.cybus.io/data-flows/agents/agents-view.md): Monitor the health of all your distributed agents from a central overview in the Connectware Admin UI.
- [Installing Agents](https://docs.cybus.io/data-flows/agents/installing-agents.md): How to install and configure agents using Docker, Docker Compose, or Kubernetes.
- [Installing Agents via Docker](https://docs.cybus.io/data-flows/agents/installing-agents/installing-agents-via-docker.md): How to install agents using Docker.
- [Installing Agents via Docker Compose](https://docs.cybus.io/data-flows/agents/installing-agents/installing-agents-via-docker-compose.md): How to install agents using Docker Compose.
- [Installing Agents via Kubernetes](https://docs.cybus.io/data-flows/agents/installing-agents/installing-agents-via-kubernetes.md): How to install agents using Kubernetes.
- [Using Mutual TLS for Agents](https://docs.cybus.io/data-flows/agents/installing-agents/using-mutual-tls-for-agents.md): Configure protocol-mapper agents to authenticate with Connectware over mutual TLS (mTLS) using client and CA certificates.
- [Registering Agents in Connectware](https://docs.cybus.io/data-flows/agents/registering-agents-in-connectware.md): Register agents in Connectware to let them connect for the first time or after their stored credentials become invalid.
- [Configuring Agents](https://docs.cybus.io/data-flows/agents/configuring-agents.md): Deploy connections, endpoints, and mappings on agents by setting the agentName property in your service commissioning file.
- [Progressive Service Deployment](https://docs.cybus.io/data-flows/agents/configuring-agents/progressive-service-deployment.md): Stagger agent startups to avoid thundering-herd spikes after restarts.
- [Monitoring Agents](https://docs.cybus.io/data-flows/agents/monitoring-agents.md): Verify that your agents are connected to Connectware and remove offline agents that you no longer need from the list.
- [Restarting Agents](https://docs.cybus.io/data-flows/agents/restarting-agents.md): How to restart Connectware agents running in Docker or Kubernetes environments.
- [Agents with the connectware-agent Helm Chart](https://docs.cybus.io/data-flows/agents/agents-in-kubernetes.md): Deploy and manage standalone Connectware agents using the connectware-agent Helm chart.
- [Deploying Agents with Your Connectware Installation](https://docs.cybus.io/data-flows/agents/agents-in-kubernetes/deploying-agents-with-your-connectware-installation.md): Deploy Connectware agents as part of your Connectware installation using the connectware-agent Helm subchart.
- [Installing Connectware Agents Using the connectware-agent Helm Chart](https://docs.cybus.io/data-flows/agents/agents-in-kubernetes/installing-connectware-agents-using-the-connectware-agent-helm-chart.md): Flexible, scalable, and secure data infrastructure with agents.
- [Upgrading the connectware-agent Helm Chart](https://docs.cybus.io/data-flows/agents/agents-in-kubernetes/upgrading-the-connectware-agent-helm-chart.md): Upgrade the connectware-agent Helm chart to a new version.
- [Uninstalling Connectware Agents with the connectware-agent Helm Chart](https://docs.cybus.io/data-flows/agents/agents-in-kubernetes/uninstalling-connectware-agents-with-the-connectware-agent-helm-chart.md): Remove agents deployed with the connectware-agent Helm chart.
- [Troubleshooting Agents](https://docs.cybus.io/data-flows/agents/troubleshooting-agents.md): Resolve agent connection loss, protect buffered data with MQTT QoS settings, and fix user registration conflicts.
- [Node-RED Workbench](https://docs.cybus.io/data-flows/node-red-workbench.md): A built-in Node-RED environment for rapidly prototyping data flows and integration solutions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cybus.io/data-flows.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.