tctl v1.16 activity command reference
The What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.tctl activity commands enable Activity Execution
Alias: a
- `tctl activity complete`
tctl activity complete
How to provide a result and complete an Activity Execution using tctl.
- `tctl activity fail`
complete
The What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.tctl activity complete command completes an Activity Execution
tctl activity complete [<modifiers>]
The following modifiers control the behavior of the command.
--workflow_id
Specify the Workflow Id What 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. What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Aliases: --wid, -w
Example
tctl activity complete --workflow_id <id>
--run_id
Specify the Run Id What is a Run Id? A Run Id is a globally unique, platform-level identifier for a Workflow Execution. What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Aliases: --rid, -r
Example
tctl activity complete --run_id <id>
--activity_id
Specify the Activity Id What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions. of an Activity Execution
Alias: --aid
Example
tctl activity complete --activity_id <id>
--result
Specify the result of an Activity Execution What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Example
tctl activity complete --result <value>
--identity
Specify the identity of the operator when using tctl to complete an Activity Execution What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Example
tctl activity complete --identity <value>
fail
The What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.tctl activity fail command fails an Activity Execution
tctl activity fail [<modifiers>]
The following modifiers control the behavior of the command.
--workflow_id
Specify the Workflow Id What 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. What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Aliases: --wid, -w
Example
tctl activity fail --workflow_id <id>
--run_id
Specify the Run Id What is a Run Id? A Run Id is a globally unique, platform-level identifier for a Workflow Execution. What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Aliases: --rid, -r
Example
tctl activity fail --run_id <id>
--activity_id
Specify the Activity Id What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions. of an Activity Execution
Alias: --aid
Example
tctl activity fail --activity_id <id>
--reason
Specify the reason for failing an Activity Execution What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Example
tctl activity fail --reason <value>
--detail
Specify details of the reason for failing an Activity Execution What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Example
tctl activity fail --detail <value>
--identity
Specify the identity of the operator when using tctl to fail an Activity Execution What is an Activity Execution? An Activity Execution is the full chain of Activity Task Executions.
Example
tctl activity complete --identity <value>