Creating Webservice data sources

After selecting “Data sources” in the Project explorer, click on the button for "Add data source"

button for creating the Webservice data source.

The data source input mask opens, in which you can select the Webservice data source as "Type" as a first step. However,

if you first assign a name to the data source and if this contains the word "webservice", then "Webservice" is already preselected

as the data source type. (This works with all data source types)

After this, the data source-specific settings adapt automatically to the Webservice data source.

Now you have the following settings options, for creating the data source:

General for all data source types:

  • Active

Via checkbox you can activate or deactivate the data source. Deactivating a data source is useful to avoid that data sources that are not accessible

constantly try to reconnect, cause error messages and thus unnecessarily fill up the log.        All controls that then want to use this data source will get a

one-time message that the data source is disabled. During the startup process (loading window), a corresponding icon shows the deactivations of the data source.

By default, the data source is always activated.

  • Name

Name the data source.

  • Type

You have the possibility to create different data sources in QuickHMI.

  • Simulation
    If you do not have access to the data source, you have the option of having it simulated. To do this, select the "True" property under "Simulation".

In this case, when starting the runtime, you will be able to manually fill the variables you created later with values in order to check the correctness of your functionalities.

(Created data sources can also be released for simulation by activating them in the simulation configurations for runtime mode.)

>> Starting runtime mode

  • Update interval (ms)

The update interval indicates the interval at which you receive variable changes from the data source in the visualization.

Webservice Spezifisch:

  • Format*

Describes in which format the data is provided by the server.

Currently only the JSON format (JavaScript Object Notation) is available. In the future other formats will be supported too.

  • Request method*

Determines how data is sent to the server.

Here you can set "GET" or "POST".

  • Read URL*

The read URL specifies the URL that is called for the read operation.

  • Read parameters

If the read access must be made with parameters, these can be defined here.

When using the GET request method, you can of course just as well define them directly in the URL.


Several parameters are separated with an "&".

  • Write URL

The write URL specifies the URL to be called during a write operation. If no different write URL is specified, the read URL is also called for writing.

Always 2 parameters are passed when writing. On the one hand the parameter "path", which always contains the path of the variable in the structure,
       which is to be written. And on the other hand, the parameter "value". This contains the value that is to be written.

  • Write parameters

If the write access must be done with additional parameters, they can be defined here.

When using the GET request method, you can of course just as well define them directly in the URL.

After entering the information relevant for the connection, click on "Add". And after editing an already created data source, click on "Save".

The Webservice data source is created and subsequently displayed in the data source overview.

Created data sources can be edited or deleted. You do this via the corresponding buttons.

You also have the option of viewing all internal data sources. This works by activating the checkbox "Show internal data sources".

Below you can create variables for the Webservice data source.

You can find out how to add variables for the Webservice data source in the “Adding Webservice variables” chapter.

>> Adding Webservice variables