Service Details View

When clicking on an installed service in the service overview page, the service details page for this service will be shown.

../../../_images/details.png

This details view shows the following information and potential actions:

  • Name, ServiceID, description, provider, status, deviation (if detected) and links to buttons of the service, if part of the service commissioning file

  • The first button in the upper right section will enable the service. Similarly, for a service which is already enabled, the button changes and lets the user disable the service again.

  • Further buttons in the upper right section are available to update / reconfigure, or delete the service. If the service is enabled, those buttons are inactive (greyed out).

  • Another button enables the user to download again the commissioning file.

  • The rest of the page shows the lists of the various resource of the service

Enable/Disable the Service

To enable a service, first the parameter values must be specified, then the requested permissions must be confirmed in the authorization dialog, and finally the service will actually be enabled.

  1. Press the Enable button in the service detail view.

    ../../../_images/details-button-enable.png
  2. This will open the Authorization Required dialog which provides a short summary of all the resources that your service needs to access in order to fully function. Please make sure to review the requirements thoroughly. Once you are done, enable the service by clicking Allow in the bottom right corner of the Authorization Required dialog.

../../../_images/2_authorization_required.png

For a service that is enabled, the displayed status and the available buttons change accordingly. The status line shows that the service is now in enabled state:

../../../_images/details-enabled.png

The first button in the upper right section now lets the user disable the service again.

In this example screenshot, a deviation has been detected. When clicking on the button Show Deviation, the following dialog window lists the resources whose actual state is different from the expected state.

../../../_images/deviation-dialog.png

Update a Service

When updating or reconfiguring a service, you can either update the service itself, or just reconfigure the existing service with different parameters. In either case, the service is then immediately re-enabled.

  1. Press the Update / Reconfigure button in the service detail view.

    ../../../_images/details-button-update.png
  2. If you want to update the service, you can do so in the left part of the window. Otherwise, you can skip this and go to the next step for reconfiguration in the right part of the window.

    For updating a service that was installed by uploading a commissioning file from your computer, press the button Choose File to upload a new file:

    ../../../_images/2_service.png

    For updating a service that was installed from the Services Catalog: The window will show the information about available updates in the Service Catalog. If an update is available and you want to install it, click on the button Update to version ?.?.?.

    ../../../_images/2_service_from_catalog.png

    Or simply skip this step and continue with reconfiguration in the right part of the window.

  3. If the service contains configurable parameters, customized values for the parameters can be entered in the right part of the window. Depending on the service configuration, some default values might be provided for each parameter. Additionally, in the left part of the window the currently loaded commissioning file can be viewed using Click to see commissioning file. Once the parameter values are entered, click on the Update button.

    ../../../_images/3_confirm.png
  4. This will now transition the status of the service into Updating, then into Enabled or Disabled according to the state that was there in the beginning.

Resources of the Service

For inspecting the various resource of this service, each subsection of the service details page can be expanded or collapsed by clicking on the small triangle on the right side, or by clicking the Expand all Resources button (which then changes into Collapse all Resources). This will show all resources of the selected section that belong to this service. Each resource can be clicked on, which directly jumps to the details view of the respective resource.

../../../_images/expand-collapse.png

Log Messages of the Service

Additionally, the log messages of this service can be inspected. To expand the Service Logs section, click on the the small triangle on the right side. Another click on the triangle will collapse the section again.

../../../_images/service-logs-expand.png

The Logs section shows the logging message of the selected service. In the toolbar at the top right of this section, there are the following buttons:

  • Search for log entries containing the entered keyword. This also filters the current table.

  • Download CSV to download the displayed rows of the log file as a CSV (Comma-Separated-Value) text file (Note: Log lines outside of the window are not downloaded, and the complete download is limited to the most recent 500 lines; use Download raw log for a complete log download)

  • View columns to select the columns to be shown

  • Filter table to select filter criteria to have only a subset of rows shown

  • Download raw logs to download the full log file in order to pass on this file to Cybus Support for in-depth issue resolution. See Logs for an explanation of the file format.

  • and Refresh to refresh (reload) the currently shown log messages.