cpajobstop
- Organization of this page
Function
Suspend: Waits for all running actions to finish and then stops the job.
Forced stop: Forcibly stops all running actions and then stops the job.
Stop monitoring: Stops monitoring whether execution conditions are met for the job executed on event.
Format
cpajobstop [{-c|-t|-e}] -i job-name [-o job-execution-ID]
Permission for execution
None
Arguments
- -c
-
Waits for all running actions to finish and then stops the job.
This command cannot work unless the specified job is running.
- -t
-
Forcibly stops all running actions and then stops the job.
- -e
-
Stops monitoring whether execution conditions are met for a job executed on event when the job is in the Monitoring for event state (MONITORING) or the Overflowing events state (MONITORING).
This option is allowed only for jobs executed on event.
Regardless of whether a job execution ID is specified with -o, this option can stop monitoring whether execution conditions are met but cannot stop a running job. Specifying an invalid job execution ID results in an error.
To stop jobs executed on event that are in the Executing (RUN) state, use the -c or -t option with the -o option.
- -i job-name
-
Specify the job name of the job to stop.
A job name can include multibyte characters, alphanumeric characters, and underscores (_) and the length must be from 1 to 45 bytes.
- -o job-execution-ID
-
Specify the ID of the job execution unit you want to stop. Omitting this option causes the system to use the ID of the running job execution unit.
A job execution ID can include alphanumeric characters and hyphens (-) and the length must be from 1 to 40 bytes. You can use the cpareport command to see job execution IDs. For details, see the description in cpareport.
Return values
|
0 |
Succeeded |
|
11 |
Nothing is done because the specified job is stopped. |
|
40 |
Insufficient resources |
|
45 |
System error (temporary exclusion error) |
|
50 |
Not allowed to access the system settings file (config.xml). |
|
52 |
There is no appropriate privilege for the executable file. |
|
58 |
Syntax error in arguments |
|
65 |
Cannot stop monitoring because the specified job is a job executed on time. |
|
67 |
The specified job or job execution ID does not exist. |
|
82 |
The job is not running. |
|
94 |
The system settings file (config.xml) is invalid. |
|
96 |
The job or item is invalid. |
|
109 |
The system settings file (config.xml) does not exist. |
|
111 |
System error (file open error) |
|
119 |
System error (Too many connections were attempted for the message communication service.) |
|
124 |
System error (I/O error) |
|
125 |
System error or other error |
|
126 |
Program error |
Environment requirements
This command can run only when the job execution service is running.
Command stored in:
install-path\bin
Note that the command is stored in the following folder by default.
- In a 32-bit operating system:
-
%ProgramFiles%\Hitachi\JP1CPA\bin
- In a 64-bit operating system:
-
%ProgramFiles(x86)%\Hitachi\JP1CPA\bin
Notes
If the job status is already Waiting for start (QUEUEING), you cannot stop the job in question by running the cpajobstop command. In this case, wait until the job status changes to Running (RUN) and then use the cpajobstop command to stop the job in question, or delete the job by either operating from the Job Design View or executing the cpajobdelete command.