Skip to main content

Parameters

The following table lists all parameters used in the response body, along with their values.

Parameters
Parameter Name Value / Description

Server State

  • MONITORED: The server is being monitored, the Qlik Enterprise Manager is connected and synchronized successfully.

  • ERROR: Qlik Enterprise Manager fails to connect and monitor the server.

  • NOT_MONITORED: The server is not being monitored.

Server Platform

  • WINDOWS
  • LINUX

License State

  • LICENSE_VALID
  • LICENSE_INVALID_CHECKSUM
  • LICENSE_EXPIRED NO_LICENSE
  • MACHINE_NOT_LICENSED
  • INVALID_LICENSE

Endpoint Role

Specifies whether an endpoint is being used as a source or a target in a Replicate task.

  • SOURCE

  • TARGET

Task State

  • RUNNING: The task is running.

  • STOPPED: The task has not been run yet or has stopped running at some point during the replication.

  • ERROR: The task has stopped due to a fatal error.

  • RECOVERING: The task has detected an error and is trying to recover. After a limited number of attempts, the task either recovers and the state returns to RUNNING, or the task fails and the state turns to ERROR.

Task options

  • full_load_enabled [bool]: Creates all files or tables at the target endpoint, automatically defines the metadata that is required at the target, and populates the tables with data from the source.

  • apply_changes_enabled [bool]: Updates all changes made to files and tables that were created during the full load. Applied changes include inserts, updates, and removal of items.

  • store_changes_enabled [bool]: Stores changes in Change tables. This value and the audit_changes_enabled value are mutually exclusive.

  • audit_changes_enabled [bool]: Stores changes in a single audit table. This value and the store_changes_enabled_value are mutually exclusive.

Task Stop reason

  • NONE: Indicates that a task is running and no Stop reason is prevalent.

  • NORMAL: Indicates that the task was stopped by the user.

  • RECOVERABLE_ERROR: Indicates that the task is still active, but that there is a temporary problem, such as a missing connection. As soon as the error state is resolved, Replicate restarts the task.

  • FATAL ERROR: Indicates that the task stopped and the error must be resolved manually. The task cannot be started again until the error has been resolved.

  • FULL_LOAD_ONLY_FINISHED: Indicates that the task only finished full load.

  • STOPPED_AFTER_FULL_LOAD: Indicates that the task stopped after full load. Cached changes may or may not have been applied.

  • STOPPED_AFTER_CACHED_EVENTS: Indicates that the task stopped after cached changes were applied.

  • EXPRESS_LICENSE_LIMITS_REACHED: The task definition includes actions that are not included with Express license privileges.

  • STOPPED AFTER_DDL_APPLY: Indicates that the task stopped after DDL statements were applied.

  • STOPPED_LOW_MEMORY: Indicates that the task stopped due to low memory.

  • STOPPED_LOW_DISK: Indicates that the task stopped due to low disk space.

Source/target status

  • RUNNING: The endpoint is running.

  • ERROR: File channel only. Cannot send files to another endpoint. Indicated by an asterisk (*) in the user interface.

  • DISCONNECTED: Information that is provided by all targets and Oracle sources that cannot establish a successful connection. Other sources stop the task. Indicated by an asterisk (*) in the user interface.

  • WARNING: The target is applying changes one by one instead of bulk to find the problem. Indicatedby an asterisk (*) in the user interface.

Profile

  • Unidirectional: A Replicate task that replicates from a source endpoint to a target endpoint.

  • Bidirectional: A Replicate task that replicates changes from the source to the target, and vice versa.

  • Log Stream: A Replicate task that captures changes from a single source and stores them on Replicate Server for replication to one or more targets.

  • Data Storage: A data storage task in a Compose Data Lake project.

  • Data Warehouse: A data warehouse task in a Compose Data Warehouse project.

  • Data Mart: A data mart task in a Compose Data Warehouse project.

  • Compactor: A Compose system task that merges the changes (i.e. history) from the delta_hds folder with the hds folder and then deletes the delta_hds folder.

  • Workflow: A workflow task in Compose.

Source type

Source and target endpoint types should be specified in the same format that they appear in the Type drop-down list (when adding a new endpoint in Enterprise Manager). For information on how to add an endpoint in Enterprise Manager, refer to the Enterprise Manager Setup and User Guide.

Target type

-

Run options

  • RESUME_PROCESSING: Resumes task execution from the point that it was stopped.

  • RELOAD_TARGET: Re-starts the full-load replication process if the task was previously run.

  • RESUME_PROCESSING_FROM_TIMESTAMP: Starts the CDC replication task from a specific point.

  • RECOVER_USING_LOCALLY_STORED_CHECKPOINT: Recovers a task using the recovery state stored locally in the task folder (located under the Data folder).

  • RECOVER_USING_CHECKPOINT_STORED_ON_TARGET: Recovers a task using the CHECKPOINT value from the attrep_txn_state table (created in the target database).

    Information note

    This option is only available if the Store task recovery data in target database option is enabled in the Changes Processing Tuning tab of the Task Settings dialog box.

  • METADATA_ONLY_RECREATE_ALL_TABLES: Recreates the target tables defined for full load.

  • METADATA_ONLY_CREATE_MISSING_TABLES: Creates missing target tables, including Change Tables.

Request state

  • SUCCESS: Connection to endpoint is valid

  • FAILURE: Connection to endpoint is not valid

state

Represented as enum values:

  • TABLE_QUEUED = 0: A table awaiting loading.
  • TABLE_LOADING = 1: A table being loaded to the target.
  • TABLE_COMPLETED = 2: A table that has been loaded to the target.
  • TABLE_CHANGE_PROCESSING = 3: A table that has been loaded to the target and is being updated according to changes on the source.
  • TABLE_ERROR = 4: An error occurred while processing the table.

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!