Skip to content

task finish

This command finishes a task that was created in the server.

./BotCLI task finish [arguments]

What are the arguments?

Argument Required Description
-taskId Yes The ID of the task to be finished.
-message No The message to register when the task is finished.
-finishType No The type of finish as one of the following:
SUCCESS, FAILED, PARTIALLY_COMPLETED.
-totalItems Yes The total number of items processed by the bot.
-processedItems Yes The number of items processed successfully by the bot.
-failedItems Yes The number of items that failed to be processed by the bot.

Examples

Finish the task with ID 123:

./BotCLI task finish -taskId "123" -totalItems 100 -processedItems 100 -failedItems 0

Finish the task with ID 14 with the message The task is finished:

./BotCLI task finish -taskId "14" -message "The task is finished" -totalItems 5 -processedItems 5 -failedItems 0

Finish the task with ID 15 with the message Bot skipped 2 rows. and the finish type PARTIALLY_COMPLETED:

./BotCLI task finish -taskId "15" -message "Bot skipped 2 rows." -finishType "PARTIALLY_COMPLETED" -totalItems 10 -processedItems 9 -failedItems 1