LogoLogo
Contact Uscybus.io
Connectware 1.7.3
Connectware 1.7.3
  • 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
      • Structure of Commissioning Files
        • 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
      • ServiceID
      • Inter-Service Referencing
      • Deviation
      • Working with Service Commissioning Files
      • Service Details View
      • Sample Service Commissioning Files
        • Modbus
          • “Bearbeitungszentrum BAZ” - Single File
          • “Bearbeitungszentrum BAZ” - Multiple Files
          • “Bearbeitungszentrum BAZ” - Single File and Custom Topics
          • “Bearbeitungszentrum BAZ” - Agent Mode
        • Machine Condition Monitoring : OPC UA + InfluxDB + Grafana Dashboard
          • “Machine Condition Monitoring Example” - Single File
        • Machine Utilization Example (Multi file service composition) : Modbus TCP + InfluxDB + Grafana + MSS
          • “Machine Utilization Example” - Machine Connectivity
          • “Machine Utilization Example” - Dashboards with role based access permission
          • “Machine Utilization Example” - Push data to MSSQL Database
      • Rule Engine
        • Data Processing Rules
        • Rule Sandbox
      • API Definition
    • Resources
      • Containers
      • Volumes
      • Connections
      • Endpoints
      • Mappings
      • Servers
      • Nodes
      • API Definition
    • 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
      • Long lived JSON Web Tokens
      • Access Permissions for Admin-UI
        • UI Access
        • Minimum Access Role Pages
      • API Definition
    • Client Registry
      • Implicit Flow
      • Explicit Flow
      • Granting Access
      • API Definition
    • Certificates
    • Explorer
    • Workbench
      • Flows in Git Repositories
    • System Status
      • Info
      • Metrics
      • Status
      • Retrieving More System Information
      • System Health
      • API Definition
    • Backup and Restore
      • Volumes
      • User Database
    • Configuration
      • Environment Variables
      • LDAP Configuration
      • MFA Configuration
    • Agents
      • 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
        • AdsConnection
        • AdsEndpoint
      • BACnet
        • BacnetConnection
        • BacnetEndpoint
      • EtherNet/IP
        • EthernetIpConnection
        • EthernetIpEndpoint
      • Focas
        • FocasConnection
        • FocasEndpoint
      • Generic VRPC
        • GenericVrpcConnection
        • GenericVrpcEndpoint
      • Hottinger Baldwin Messtechnik (HBM)
        • HbmdaqConnection
        • HbmdaqEndpoint
      • Heidenhain DNC
        • HeidenhainConnection
        • HeidenhainEndpoint
      • HTTP/REST
        • HttpConnection
        • HttpEndpoint
      • HTTP Server
        • HttpServer
        • HttpNode
      • InfluxDB
        • InfluxdbConnection
        • InfluxdbEndpoint
      • Kafka
        • KafkaConnection
        • KafkaEndpoint
      • Modbus/TCP
        • ModbusConnection
        • ModbusEndpoint
      • MQTT
        • MqttConnection
        • MqttEndpoint
      • MSSQL
        • MssqlConnection
        • MssqlEndpoint
      • OPC DA
        • OpcdaConnection
        • OpcdaEndpoint
      • OPC UA
        • OPC UA Client
          • OpcuaConnection
          • OpcuaEndpoint
        • OPC UA Server
          • OpcuaServer
          • OpcuaNode
        • OPC UA Object Types
        • OPC UA Server References
          • OpcuaReferenceNode
          • OpcuaObjectNode
      • Siemens SIMATIC S7
        • S7Connection
        • S7Endpoint
      • Shdr
        • ShdrConnection
        • ShdrEndpoint
      • Sinumerik
        • SinumerikConnection
        • SinumerikEndpoint
      • Sopas
        • SopasConnection
        • SopasEndpoint
      • SQL
        • SqlConnection
        • SqlEndpoint
      • Werma WIN Ethernet
        • WermaConnection
        • WermaEndpoint
      • Systemstate
        • SystemstateConnection
        • SystemstateEndpoint
      • API Definition
    • Connectware Licensing
    • 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
  • Installing Services
  • Enabling Services
  • Disabling Services
  • Removing Services
  • Updating Services

Was this helpful?

  1. Documentation
  2. Services

Working with Service Commissioning Files

PreviousDeviationNextService Details View

Last updated 9 months ago

Was this helpful?

This page explains how to work with services from the service overview page of the Connectware web interface.

If your service fails to install, remove, enable or disable, already created resources will be rolled back and removed to avoid cluttering the Connectware with unused data.

Installing Services

Commissioning files are installed using the web-based interface of the Connectware on the service overview page:

  1. On the navigation panel, click Services.

  1. Click Upload Service to add a new service.

  1. In the Create Service dialog, click Choose File, select a commissioning file from your local computer in the file browser, and click Ok.

  1. This will fill in the information in the right part of this dialog window, the Configure the new service section. If your service commissioning file provides configurable parameters, you can now enter customized values for your service. Depending on the commissioning file, parameter descriptions and default values may be available. Additionally, the commissioning file can be reviewed by expanding the Click to see commissioning file tab in the left part. Once you are finished click Install.

  1. In case everything was configured correctly, you should see the new service added to the service list, initially in the Disabled state.

Enabling Services

Your service now enters the Enabling state, in which all resources which were defined in the commissioning file are being created.

Once the Enabling has finished successfully, your service will reach the Enabled status and a confirmation message is displayed.

Disabling Services

  1. To disable a running service, select the service from the service list (1.) and click Disable (2.) on the toolbar.

  1. This will open the Disable Service dialog. To disable the running service, confirm your selection by clicking Disable.

Disabling a service will destroy running containers, enabled connections, endpoints and mappings. Volumes however will remain in its current state and will reattach to the service once it is enabled again.

Removing Services

  1. To remove a disabled service, select the service from the service list (1.) and click Delete (2.) on the toolbar.

  1. This will open the Delete Service dialog. To complete the service deletion, confirm your selection by clicking Delete in the bottom right corner of the dialog window.

Removing a service will not remove volumes defined by the service commissioning file. These volumes will remain in its current state and reattach to the service once it is installed and enabled again.

Updating Services

Enabling, updating, or reconfiguring a service can only be done from the by selecting the service in the list.

Continue here:

To remove a running service, you must disable it first. Follow the instructions contained in the preceding section section to do so.

Enabling, updating, or reconfiguring a service can only be done from the by selecting the service in the list.

Continue here:

Service Details View
Service Details View
Enabling/Disabling Services
Disabling Services
Updating Services