get_task_details

Retrieves details about a selected and authorized task. The API returns full monitoring information related to the selected task.

Required User Role: See Required Enterprise Manager permissions.

Syntax

def get_task_details(

self,

server,

task

)

Parameters

Parameters
Parameter	Type	Description
server	string	The name of the server.
task	string	Replicate: - The name of the task. Compose: - The name of the task or workflow appended with a double underscore and the project name. Example: mytask__myproject

Return values for Replicate tasks

AemGetTaskDetailsResp

Return values
Value	Type	Description
task	AemTaskInfoDetailed	-
type	string	AemTaskInfoDetailed
name	string	The task name.
description	string	The task description. If there is no description, an empty string will be returned.
cdc_event_counters	AemTaskCdcEventCounters	All numeric data concerning CDC events
applied_ddl_count	long	The total number of metadata changes, such as add column
applied_delete_count	long	The number of records deleted in total for all tables
applied_insert_count	long	The number of records added in total for all tables
applied_update_count	long	The number of records updated in total for all tables
cdc_latency	AemCdcLatency	CDC latency information
source_latency	string	The time gap between the original change in the source endpoint and capturing it, in hh:mm:ss
total_latency	string	The overall latency (source latency + target latency + apply latency), in hh:mm:ss
cdc_throughput	AemCdcThroughput	Indicates how fast the table records are being replicated to the target endpoint (by number or volume of records). Refers only to the current/last CDC.
source_throughput_records_count	AemCdcThroughputItem	The current source throughput, in rec/sec
source_throughput_volume	AemCdcThroughputItem	The current source throughput, in kbyte/sec
target_throughput_records_count	AemCdcThroughputItem	The current target throughput, in rec/sec
target_throughput_volume	AemCdcThroughputItem	The current target throughput, in kbyte/sec
current	long	-
cdc_transactions_counters	AemCdcTransactionsCounters	All numeric data concerning CDC transactions
applied_comitted_transaction_count	long	The number of transactions committed.
applied_records_comitted_count	long	The sum of all records/events in all Completed transactions
applied_records_in_progress_count	long	The sum of all records/events in all In-Progress transactions
applied_transactions_in_progress_count	long	The number of transactions in progress.
applied_volume_comitted_mb	long	The sum of all volume/events in all Completed transactions, in MB.
commit_change_records_count	long	The number of COMMIT change records.
incoming_accumulated_changes_on_disk_count	long	The number of changes accumulated on disk until source commit
incoming_accumulated_changes_in_memory_count	long	The number of changes accumulated in memory until source commit.
incoming_applying_changes_in_memory_count	long	The number of changes in memory during apply and until target commit.
incoming_applying_changes_on_disk_count	long	The number of changes on disk during apply and until target commit.
rollback_change_records_count	long	The number of ROLLBACK change records.
rollback_change_volume_mb	long	The volume of ROLLBACK changes, in MB.
rollback_transaction_count	long	The number of changes in memory during apply and until target commit.
full_load_completed	bool	-
full_load_counters	AemTaskFullLoadCounters	All numeric data concerning Full Load events.
estimated_records_for_all_tables_count	long	The estimated number of records remaining to be loaded into the target endpoint.
records_completed_count	long	The total number of records that have completed loading into the target endpoint.
tables_completed_count	int	The number of tables that have been loaded into the target endpoint.
tables_loading_count	int	The number of tables that are currently being loaded into the target endpoint.
tables_queued_count	int	The number of tables that are waiting to be loaded due to an error.
tables_with_error_count	int	The number of tables that could not be loaded due to an error.
full_load_end	string	Indicates whether the full load process has ended.
full_load_start	string	The start time of the full load process. Format: YYY MM DD Timezone: UTC
full_load_throughput	AemFullLoadThroughput	-
source_throughput_records_count	int	The current source throughput, in rec/sec.
source_throughput_volume	int	The current source throughput, in kbyte/sec.
target_throughput_records_count	int	The current target throughput, in rec/sec.
target_throughput_volume	int	The current target throughput, in kbyte/sec.
memory_mb	long	The current utilization of memory, in MB. A task's memory utilization is sampled every 10 seconds. When the task is not running, the value is set to zero (0).
cpu_percentage	-	The current CPU usage of the Replicate task process. Information note Only available for Replicate tasks running on Replicate 6.2 and above. When not available, this parameter will be returned as -1.
disk_usage_mb	long	The current utilization of disk space, in MB. A task's disk utilization is sampled every minute.
data_error_count	long	The total number of data errors in all tables involved in the task. The count is affected by data errors and the Reset Data Errors option available when you drill down to a task.
options	AemCommonSettings	-
apply_changes_enabled	bool	See Task Options.
audit_changes_enabled	bool	See Task Options.
full_load_enabled	bool	See Task Options.
store_changes_enabled	bool	See Task Options.
profile	string	See Profile Parameters.
source_endpoint	TaskEndpoint	-
name	string	The name of the source endpoint.
type	string	The source endpoint type.
target_endpoint	TaskEndpoint	-
name	string	The name of the target endpoint.
type	string	The target endpoint type.
state	AemTaskState { STOPPED = 0, RUNNING = 1, ERROR = 2, RECOVERY = 3 }	The current state of the task.
task_stop_reason	AemTaskStopReason { NONE = 0, NORMAL = 1, RECOVERABLE_ERROR = 2, FATAL_ERROR = 3, FULL_LOAD_ONLY_FINISHED = 4, STOPPED_AFTER_FULL_LOAD = 5, STOPPED_AFTER_CACHED_EVENTS = 6, EXPRESS_LICENSE_LIMITS_REACHED = 7, STOPPED_AFTER_DDL_APPLY = 8, STOPPED_LOW_MEMORY = 9, STOPPED_LOW_DISK_SPACE = 10 }	The reason the task stopped.
log_stream_staging	string	If the task is writing to/reading from the Log Stream staging folder, the name of the associated Log Stream Staging task will be returned. Otherwise, an empty string will be returned.
assigned_tags	array	Returns the custom tags assigned to the task. If no tags are assigned to the task, an empty array will be returned.
message	string	The message if the task stopped due to an error.

Return Values for Compose Tasks

AemGetTaskDetailsResp

Name	Type	Description
type	string	One of the following: AemComposeDWTaskInfoDetailed (for Data Warehouse tasks) AemComposeDMTaskInfoDetailed (for Data Mart tasks) AemComposeDLTaskInfoDetailed (for Data Lake tasks)
project	string	The name of the Compose project.
profile	string	See Profile Parameters.
name	string	The name of the task or workflow appended with a double underscore and the project name. Example: mytask__myproject
description	string	The task description. If there is no description, an empty string will be returned.
state	string	The current task state
message	string	The message shown in the event that the task ends with an error.
options	AemCommonSettings	-
full_load_enabled	bool	Indicates whether the Full Load option is enabled. Can be "true" or "false"
apply_changes_enabled	bool	Indicates whether the Change Processing option is enabled. Can be "true" or "false"
source_endpoint	TaskEndpoint	-
name	string	The logical name of the landing database.
type	string	The landing database type.
target_endpoint	TaskEndpoint	-
name	string	The logical name of the storage database.
type	string	The storage database type.
loading_completed	bool	Indicates whether the loading process has completed. Can be "true" or "false"
loading_start	string	The start time of the loading process Format: YYY MM DD Timezone: UTC
loading_end	string	The end time of the loading process Format: YYY MM DD Timezone: UTC
loading_counters	AemTaskFullLoadCounters	-
tables_total_count	int	The total number of tables.
tables_completed_count	int	The number of tables that have been loaded into the target endpoint
tables_loading count	int	The number of tables that are currently being loaded into the target endpoint
tables_queued_count	int	The number of tables that are waiting to be loaded due to an error
tables_with_error_count	int	The number of tables that could not be loaded due to an error
commands_total_count	int	The total number of commands executed
commands_completed_count	int	The total number of commands completed
assigned_tags	array	Returns the custom tags assigned to the task. If no tags are assigned to the task, an empty array will be returned.

Errors

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

Error responses
Error	Message	Description
AEM_TASK_NOT_FOUND	Replication task {task} on server {server} could not be found.	The task name is unknown to Qlik Enterprise Manager.

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