Using the engine API explorer

Overview

The engine API explorer is a tool that allows you to send messages to the Qlik engine and get answers from the engine.

URL

The engine API explorer is accessible at:

• http://localhost:4848/dev-hub/engine-api-explorer while running in local installation mode
• https://[server]/dev-hub/engine-api-explorer while running in server mode.

Connect to the Qlik engine and open an app

To connect to the Qlik engine and open an app, do the following:

1. Enter the app identifier in the App field.

2. Click Connect.

You are connected to the engine and the app is opened. You can now start using the methods available in the Qlik Engine API.

Connect to the Qlik engine

If you do not know the identifier of the app you want to open and you wish to connect to the Qlik engine, do the following:

1. Leave the App field empty.

2. Click Connect.

   You are connected to the engine.

3. Select the method GetDocList in the Methods drop-down list.
4. Click Execute.

The list of apps is displayed.

Open an app

Once you are connected to the engine, you can open an app.

To open an app, do the following:

1. In the Methods drop-down list, select the method OpenDoc and click Use as template.

2. In the template window, fill in the parameter qDocName with the name of the app to open (in desktop mode) or with the GUID of the app (in server mode).

3. Click Execute.

The app is opened and has for handle 1.

Handles

The protocol uses handles to reference the objects/methods available.

When connecting to the engine you always get the handle -1, which is global and refers to the engine itself.

When opening an app, the handle of the app is 0.

Handles are listed in the Handles drop-down list. As you create and get objects, more and more handles become available.

Methods

The Methods drop-down list shows the methods available for the selected handle.

To send a call to the engine, do the following:

1. Select a handle in the Handles drop-down list.

2. Select a method in the Methods drop-down list.

3. Click Use as template.
   A template is displayed.
4. Fill in any parameter you require.
5. Click Execute.

The call is sent to the engine and both the request and the response messages are displayed in the engine API explorer.

Macros

A number of macros are supplied. Each macro contains a set of commands/methods.

To use a macro, do the following:

1. Select a macro in the Macros drop-down list.

2. Click Execute.