Skip to main content
ReconfigureEndpointNoWait

ON THIS PAGE

ReconfigureEndpointNoWait

Call this method to override the source endpoint settings with settings from another endpoint of the same type. This method also supports automatically stopping and then resuming all tasks that are using the source endpoint (which is required for unplanned switchovers).

Information note
  • Supported with the Oracle source endpoint only.
  • Using this method, requires you to set up relevant Qlik Replicate task(s) with three separate source endpoints - two inactive source endpoints defined with the primary and secondary database connection settings, and one active source endpoint (initially defined with the primary database connection settings).

    For detailed instructions, see Reconfiguring endpoints.

Required User Role: See Required Enterprise Manager permissions.

Syntax

public void ReconfigureEndpointNoWait(

string server,

string endpoint,

string configuration = null,

bool recycle = true

);

Parameters

Parameters
Parameter Type Description

server

string

The name of the Replicate server (as defined in Qlik Enterprise Manager) on which the task(s) are running.

endpoint

string

The name of the source endpoint defined for the Replicate task(s).

configuration

string

The name of the secondary endpoint (or the primary endpoint when reverting the settings).

recycle

bool

Whether to stop and resume the Replicate task(s) automatically. The default is "true", that is, when an unanticipated switchover occurs, tasks using the source endpoint will be automatically stopped and then resumed after the source endpoint is updated with the settings from the secondary endpoint.

Set to "false" for planned switchovers (such as migrating to a production database or switching back to the primary database).

Return values

N/A

Errors

All of the general errors as well as the errors listed in the table below.

Error responses
Error Message Description

AEM_ENDPOINT_NOT_FOUND

Replicate endpoint "{endpoint}" on server "{server}" could not be found.

The specified endpoint could not be found.

AEM_RECONFIGURE_ENDPOINT_INNER_ERR

Failed to reconfigure endpoint "{endpoint}" on server "{server}". Error: "{message}"

Qlik Enterprise Manager failed to reconfigure the endpoint with the settings of the secondary endpoint.