1.6.11 stoptask (stopping a task)

Description

This command stops execution of a task by specifying the ID of the task. However, execution of a debug task cannot be stopped.

Note that this command cannot forcibly stop execution of a task.

Syntax

stoptask
     /taskid task-ID
     /user user-ID
     {/password password | /passwordfile password-file-path}

Arguments

/taskid task-ID

This option specifies the task ID of the task of which you want to stop execution.

The possible values are half-width numeric characters (in decimal number) in 16 or fewer digits.

/user user-ID

This option specifies the user ID for JP1/AO.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are half-width alphanumeric characters, !, #, $, %, &, ', (, ), *, +, -, ., =, @, \, ^, _, and |.

This option is not case sensitive.

/password password

This option specifies the password of the user indicated by the user option.

You must specify either this option or the passwordfile option. If both options are specified, or if neither are specified, then you will get an error.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are the same as those for the user option.

/passwordfile password-file-path

This option specifies the absolute or relative path to the password file for the user specified in the user option. You can create a password file by using the encryptpassword command.

You must specify either this option or the password option. If both options are specified, or if neither are specified, then you will get an error.

Located in

In Windows:

JP1/AO-installation-folder\bin

In Linux:

/opt/jp1ao/bin

Execute permission

Execute the command as a user with Administrator or root permissions for the OS. If a user without Administrator or root permissions executes the command, a message appears asking the user to elevate the permission level.

The Admin, Develop, Modify, or Submit role must be set for the service group of the target task from the user group that the user who executes the command belongs to. The command does not stop any tasks in a service group for which none of these roles are set.

Remarks

Execute this command when the task, which you want to stop execution of, is either in In Progress, Waiting for Response, or Abnormal Detection status. If you execute this command in any other status, the command fails with the return code 140.

Return code

The following table lists the return codes from the command.

Example

The following example shows how to use the command to stop, in Windows, execution of the specified task (whose task ID is 1):

stoptask /taskid 1 /user user01 /password pass01