tctl v1.17 activity command reference
The new Temporal CLI is available for use.
tctl v1.17 can still be used with Temporal Server version 1.20 and is expected to be compatible with Temporal Server version 1.21.
tctl is expected to be fully deprecated by Temporal Server version 1.22
The tctl activity commands enable Activity Execution
What is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more operations.
- tctl activity completetctl activity complete
How to provide a result and complete an Activity Execution using tctl.
Learn more - tctl activity failtctl activity fail
How to fail an Activity Execution using tctl.
Learn more
complete
The tctl activity complete command completes an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
tctl activity complete <modifiers>
The following modifiers control the behavior of the command.
--workflow_id
Specify the Workflow IdWhat is a Workflow Id?
A Workflow Id is a customizable, application-level identifier for a Workflow Execution that is unique to an Open Workflow Execution within a Namespace.
Learn more of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more to complete.
Alias: -w
Example
tctl activity complete --workflow_id <id>
--run_id
Specify the Run IdWhat is a Run Id?
A Run Id is a globally unique, platform-level identifier for a Workflow Execution.
Learn more of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more to complete.
Alias: -r
Example
tctl activity complete --run_id <id>
--activity_id
Specify the Activity IdWhat is an Activity Id?
A unique identifier for an Activity Execution.
Learn more of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more to complete.
Example
tctl activity complete --activity_id <id>
--result
Specify the result of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more when using tctl to complete the Activity Execution.
Example
tctl activity complete --result <value>
--identity
Specify the identity of the operator when using tctl to complete an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
Example
tctl activity complete --identity <value>
fail
The tctl activity fail command fails an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
tctl activity fail [<modifiers>]
The following modifiers control the behavior of the command.
--workflow_id
Specify the Workflow IdWhat is a Workflow Id?
A Workflow Id is a customizable, application-level identifier for a Workflow Execution that is unique to an Open Workflow Execution within a Namespace.
Learn more of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more to fail.
Alias: -w
Example
tctl activity fail --workflow_id <id>
--run_id
Specify the Run IdWhat is a Run Id?
A Run Id is a globally unique, platform-level identifier for a Workflow Execution.
Learn more of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more to fail.
Alias: -r
Example
tctl activity fail --run_id <id>
--activity_id
Specify the Activity IdWhat is an Activity Id?
A unique identifier for an Activity Execution.
Learn more of an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more to fail.
Example
tctl activity fail --activity_id <id>
--reason
Specify the reason for failing an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
Example
tctl activity fail --reason <value>
--detail
Specify details of the reason for failing an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
Example
tctl activity fail --detail <value>
--identity
Specify the identity of the operator when using tctl to fail an Activity ExecutionWhat is an Activity Execution?
An Activity Execution is the full chain of Activity Task Executions.
Learn more.
Example
tctl activity complete --identity <value>