1. Documentation
2. 2024.1 (Latest) 2024.0 10.3 10.2 10.1 10.0 9.10 9.9 9.8 9.7 9.6 9.5 9.4 9.3 9.2 9.1 9.0 8.2 8.1 8.0 7.6
3. Server
4. Advanced topics
5. Qlik integration
6. Import Web Service to QlikView

Call Web Service in QlikView

This guide will walk you through the process of configuring and calling a RapidMiner Server web service via your QlikView environment:

1. Launch QlikView and go to File > New to create a new empty QlikView document.
2. Press CTRL + E or go to File > Edit script. The script editing page will open.
3. On the Data tab, click on Web files:

   

4. A new Source window, where the data source is configured, will open. Select the Internet File radio button and insert the direct link of the RapidMiner web service in the text box provided and click Next.

   

   Note: If the web service requires authentication, the URL has to be modified to include user credentials as follows: http://username:password@web-service-url

   Example: http://admin:pass123@dev.rapidminer.com:8080/api/rest/process/QlikViewService?

   When the Next button is clicked, QlikView will call the RapidMiner web service and as a result, RapidMiner Server will execute the process behind the web service. Depending on the complexity of your process and the amount of data, this step can take some time. Once RapidMiner Server has executed the process and all data is received by QlikView, a new window will open.
5. Select Html as File type and (based on your data) choose appropriate Labels and Character Set values. Click the Next button.

   Labels tell QlikView where to look for column names. If the first row contains the column names then the Embedded Labels setting should be selected. If the first row does not contain column names, None should be selected. RapidMiner always sends column names in the first row so Embedded Labels is the setting to use.

   

6. On the Transform window, click the Next button (as all data have already been transformed and prepared to be read by QlikView).

   

7. The Options window can be used to further filter input data if needed. Once finished, click the Next button.

   

8. The last window will show a QlikView load script. No action is required so simply click the Finish button. QlikView will automatically create a data loading script. Click the OK button:

   

9. The data loading script is created but in order to use it, the script must be saved. Go to File > Save and save to a location of your choice.
10. The last step is to load the data in QlikView. To do that, press CTRL + R or go to File > Reload.
11. The data is now in QlikView and ready to use. To view data table press CTRL + T or go to File > Table Viewer. Now that the two tools have been connected and data is pulled from RapidMiner Server to QlikView, data can be used to build dashboards. Data can also be refreshed on demand by going to File > Reload or pressing CTRL + T. On data reload, the script will call the RapidMiner web service again and receive fresh data back.

Call Parameterized Web Service

It is possible to configure a RapidMiner Server web service to accept URL query parameters. QlikView offers two ways by which a parameterized web service can be called:

• Statically using a data loading script
• Dynamically using QlikView variables

Using Data Loading Script

Parameters are passed through the URL of the web service. To be able to edit the service URL, the data loading script has to be modified.

1. Press CTRL + E or go to File > Edit script. The Edit script window will open.
2. Locate the URL of web service and add parameters to URL.

   Parameters are added to the end of the web services URL preceded by a question mark (?).
   Syntax: http://username:password@web-service-url?param-name=value

   Example: http://admin:pass123@dev.rapidminer.com:8080/api/rest/process/QlikViewService?p0=1

   

3. Save the script by pressing CTRL + S or going to File > Save.
4. Reload the script by pressing the CTRL + R or going to File > Reload.

Using QlikView Variables

To be able to pass QlikView Variables as parameters to a RapidMiner web service, they have to be defined in QlikView and the data loading script has to be modified to use them.

1. To create a QlikView Variable go to Settings > Variable Overview or press CTRL + ALT + V

   

2. Click the Add button, enter the name of variable and click OK button to accept.

   

3. Then click the OK button on Variable Overview window.
4. Create a new object (like a button) on QlikView dashboard or use an existing one.
5. Right click on the object and select Properties.

6. In the Text box enter the name of your object.

   

7. Go to Actions tab and click Add button.

   

8. As Action Type select External and as Action select Set Variable. Click the OK button.

   

9. Under the Actions list box, Set Variable will appear. On the right side open variable selection window by clicking the … button.

   

10. An Edit Expression window will open. Click on the Variables tab, choose the variable from the dropdown menu and click Paste button.

    

11. Click the OK button to accept changes.
12. On the right hand side, enter the Value of your variable in the corresponding text box and click the OK button.

    

13. Click on the object to apply the new variable value.
14. Open the data loading script window by going to File > Edit Script or pressing CTRL + E.
15. Locate the URL of the web service and add the QlikView variables as parameters to the URL.

    Parameters are appended to the end of a web service URL string, preceded by a question mark (?).
    URL syntax: http://username:password@web-service-url?param-name=value
    QlikView variables can be referenced with the following syntax: $(variable-name)

    Example: http://admin:pass123@dev.rapidminer.com:8080/api/rest/process/QlikViewService?p0=$(Variable1)

    

16. Save the script by pressing CTRL + S or going to File > Save.
17. Reload the script by pressing the CTRL + R or going to File > Reload.
18. Data will be reloaded with parameter value equal to variable value.