Skip to main content Skip to complementary content
Qlik Resources

Endpoints

The Endpoints tab lets you configure settings related to endpoint such as Endpoint Servers and default proxy settings.

Endpoint Servers

An Endpoint Server is a Java service that is installed with Replicate and starts automatically if an appropriate license is detected. The Endpoint Server is responsible for managing a set of custom endpoint types (developed using the Qlik Replicate Custom Endpoint SDK).

Information note
  • The procedure for adding custom endpoint connections and configuring tasks is the same as that for adding regular Replicate endpoints/tasks.
  • In future versions, the Add Endpoint Server, Edit, and Remove toolbar options will allow you to add and manage additional endpoint servers. In this version however, they should only be used if requested by a Qlik Support Engineer.
  • Changes to settings will only take affect after restarting all tasks.

Viewing Endpoint Server properties

When the Endpoint Server is selected, the right pane will display all associated endpoint types. Additionally, the following properties will be displayed in the grid:

  • Status – Indicates whether the Endpoint Server is running, stopped or in error.
  • Name – The name of the Endpoint Server.
  • Host – The host machine on which the Endpoint Server is installed.
  • Port – The port of the Endpoint Server.
  • Version – The version of the Endpoint Server.
  • Message – Displayed if the Endpoint Server is in an error state or Replicate cannot connect to it.
  • Last Connection – The last time Replicate successfully connected to the Endpoint Server.

JVM configuration options

The AT_JVM_OPT system environment variable enables you to set additional JVM configuration options such as limiting the heap memory consumed by the endpoint server, setting verbose logging, and so on. AT_JVM_OPT is supported on both Windows and Linux and is set on the former using the "set" command, and on the latter using the "export" command.

For example, to set AT_JVM_OPT with verbose logging on Windows:

  1. Issue the following command:

    set AT_JVM_OPT=-verbose:class

  2. Restart the Qlik Replicate Server service.

Endpoint Server logging

The following topic explains how to set Endpoint Server logging levels as well as how to manage and view associated log files.

Before you can perform the actions described in this topic, first switch to Server view (as described in Server view) and then select the Endpoint Servers tab.

Setting logging levels

To set the logging levels for an Endpoint Server:

  1. Select the desired Endpoint Server from the grid.
  2. In the Actions toolbar, click Logging Settings.
  3. Click the Logging Levels tab.

  4. Set the logging level for an individual component by moving the slider to the desired level next to the component name.

    OR

    Set a global logging level for all components by moving the top-most slider to the desired level.

  5. Click Save.
Information note

This will set the logging level for the Endpoint Server only. To modify the logging levels for a task associated with a custom endpoint type, open the Replicate task and navigate to Task Settings | Logging.

Log file management

To set the rollover and retention policies for Endpoint Server log files:

  1. Select the desired Endpoint Server from the grid.
  2. From the Actions toolbar, click Logging Settings.
  3. Click the Log File Management tab.
  4. Select the Automatic Rollover check box to enable automatic rollover of log files and enter the maximum size for each log (in MB). To disable automatic rollover of log files, clear the check box.
  5. Select the Automatic Cleanup check box to enable automatic cleanup of log files and enter the maximum number of log files to retain. To disable automatic cleanup of log files, clear the check box.
  6. Click Save.

Viewing log files

To view the log files for an Endpoint Server:

  1. Select the desired Endpoint Server from the grid.
  2. From the Actions toolbar, click View Logs.
  3. Select the log file you want to view or download from the list in the Log Files pane. The contents of the log file will be displayed in the right pane.
  4. Browse through the log file using the scroll bar on the right and the navigation buttons at the top of the window.
  5. To search for specific text in the log file, enter the text in the search box; any matching text will be highlighted blue.
  6. To download the log file, click the Download Log File icon in the top right of the window.
  7. To manually roll over the current log file, click the Roll Log File icon in the top right of the window.
Information note

Selecting View Logs will display Endpoint Server logs only.

To view log files for individual tasks on the Endpoint Server machine:

  1. Open the task.
  2. Switch to Monitor view.
  3. Click View Logs.
  4. Select Source Endpoint Server from the drop-down list.

Default proxy server

You can decide whether to configure proxy settings for each endpoint or whether to use the setting configured in this tab.

Supported endpoints

Supported with the following endpoints only:

  • Microsoft Azure Synapse Analytics target
  • Google Cloud BigQuery target
  • Databricks Lakehouse (Delta) target
  • Databricks (Cloud Storage) target
  • Amazon Redshift target

Settings

The following settings are available:

  • Host name: The host name of the proxy server.
  • Port: The port via which to access the proxy server.
  • User name: The user name for the proxy server.
  • Password: The password for the proxy server.

  • Scheme: Select which protocol to use to access the proxy server (HTTP or HTTPS).

    Information noteIf the endpoint does not support HTTPS, HTTP will be used instead.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here