Managing Qlik Data Gateway - Direct Access in Administration

This section describes how to manage the Direct Access gateway in Administration.

Editing the data gateway data properties

1. In Administration, go to Data gateways.

2. Click the button at the end of the row, and select Edit.

   The Edit data gateway dialog opens.

3. Update the properties as needed, and then click Save.

Enabling and disabling data gateways

1. In Administration, go to Data gateways.

2. Do one of the following:

   • Select the check box at the beginning of the row and click the Enable or Disable toolbar button.
   • Click the button at the end of the row, and select Enable or Disable.

3. Confirm the action.

Deleting data gateways

1. In Administration, go to Data gateways.

2. Do one of the following:

   • Select the check box at the beginning of the row, and click the Delete toolbar button.
   • Click the button at the end of the row, and select Delete.

3. Confirm the deletion.

Setting notifications for Direct Access gateway

Notifications for a specific Direct Access gateway

You can set notifications to be alerted at changes in the operation of your data gateway. You can get a notification in your browser, by email, or a push message to the Qlik Analytics mobile app.

1. Select Administration from the launcher menu (), and then select Data gateways.

2. Click on a data gateway, and select Notifications.

3. Select which events to receive a notification for.

   Notifications are available for the following events:

   • Data gateway state has changed

   • Data gateway version requires an update

     Information noteThis notification will only be sent in the rare case of Qlik forcibly deactivating the gateway (usually due to a critical issue).

4. Click Done.

You can view and edit gateway-specific notifications in your settings. You can find them under Settings > Notifications > Custom notifications > Data gateways.

Notification for a new Direct Access gateway version

Under Settings > Notifications > Data gateways, you can set the following additional notification:

• New data gateway version is available

When enabled, the notification will be sent to the data gateway creator only, whenever a new Direct Access gateway version becomes available for download.

Viewing and running benchmark tests

Overview

Benchmark tests are diagnostic operations that measure network connectivity and performance between the Direct Access gateway and Qlik Cloud. Use them to troubleshoot reload performance, establish performance baselines, or compare gateways.

Benchmark results can help you identify network conditions that affect reload performance and provide information for troubleshooting.

Prerequisites

Before you run a benchmark test, verify the following requirements:

• The gateway runs version 1.7.17 or later.

• The gateway is connected and running in Qlik Cloud.

• You are assigned the Tenant Admin role and are either the gateway space owner or a member of the gateway space with the Can consume data role.

Creating a new benchmark test

To create a benchmark test:

1. In the Administration activity center, click Data gateways.

2. Next to a gateway that you want to benchmark, click > Benchmarks.

   The Direct access gateway benchmarks tab opens. All existing benchmarks associated with the gateway are listed.

3. Click Create benchmark.

4. Type a Name and optionally a Description.

5. As needed, adjust the Data size and Overlap policy.

6. Click Create benchmark.

Running a benchmark test

To run an existing benchmark test:

1. In the Administration activity center, click Data gateways.

2. Open the Direct access gateway benchmarks tab.

3. Next to a benchmark test that you want to run, click > Run.

The benchmark runs as a background task. You can also create and monitor a benchmark through the Direct Access Gateway benchmarks API.

Viewing benchmark results

The Direct access gateway benchmarks tab allows you to view and compare benchmark results. You can view results for a single benchmark or reload run, or compare multiple benchmark and reload runs. You can also compare metrics across different gateways.

To analyze benchmark results:

1. In the Administration activity center, click Data gateways.

2. Open the Direct access gateway benchmarks tab.

3. Navigate between the Benchmarks and Reloads sections as needed, selecting any items you wish to analyze.

4. You can compare benchmark and reload runs across different gateways. After selecting one or more items for a gateway, use the gateway selector in the top bar to switch gateways, and then select more items.

5. Click View results or Compare selected.

Analysis results

The results of benchmark and reload analysis consist of the following, depending on the option you use:

• View results: Trend analysis to track latency over time between benchmark and reload runs.

• Compare selected: Metrics such as latency and throughput, analyzed as poor, basic, or good on a per-run basis.

Troubleshooting benchmarks

Limitations

Only the 100 most recent reloads and the 100 most recent benchmarks are presented per gateway.

Data gateway properties

To access the Data gateways table, select Administration from the launcher menu (), and then select Data gateways. The Data gateways table shows basic information about each data gateway.

The table columns are as follows:

• Name – The name specified when the data gateway was created.

• Type – Should be Direct Access gateway.

• Version - The current version. For more information, see Upgrading and uninstalling Qlik Data Gateway - Direct Access.

• Description – The description provided when the data gateway was created.

• Data gateway ID – A unique identifier, which might be useful for troubleshooting purposes.

• State – Can be one of the following:

  • Connected - Indicates that the data gateway service has established a connection with Qlik Cloud.

  • Disconnected - If the status is Disconnected, start the data gateway service as described above.

  • Disabled - The data gateway is disabled in the Administration activity center.
  • Establishing session - Shown when the data gateway establishes a connection to the data source.

• Space - The space with which the data gateway is associated.

• Date created – When the data gateway was created.