13.7 dcmjbrm.exe (deleting a job)
This section describes the dcmjbrm command, which deletes an executed job.
Function
This command deletes, on the managing server, an executed job specified in the parameter file.
Format
dcmjbrm.exe /i parameter-file-name [/LC {ON|OFF}]
Arguments
-
/i
In the argument /i, specify the full path name of the parameter file to be used.
You can also use the output file output by the dcmcoll command (without /s specified), the dcminst command (without /s specified), the dcmjexe command, or the dcmsusp command (without /s specified) as the parameter file.
-
/LC
In the argument /LC, write ON or OFF to specify whether to continue command processing even if you log off from Windows while executing this command as a background service by using the Task Scheduler or JP1/AJS.
-
ON
Continues command processing even when you log off from Windows.
-
OFF
Forcibly ends command processing when you log off from Windows.
This argument is effective when this command is executed from a service on the following OS:
-
Windows Server 2003
When you enter this command from the command prompt, this command is executed as a foreground program. Therefore, in such cases, do not specify /LC ON.
You can also use a registry to set whether to continue command processing even if you log off from Windows.
Note that the command operation differs depending on the combination of the specification of the argument /LC and the setting in the registry. For details, see 13.20 Command operation at logoff according to registry setting and logoff option.
-
Specification contents of parameter file
The table below shows the specification contents of the parameter file for the dcmjbrm command. The contents of the parameter file for this command cannot be specified by using command arguments.
Specification content of parameter file |
Content |
Whether to specify |
Command argument |
|
---|---|---|---|---|
Tag |
Parameter |
|||
job_generator |
Job name |
N |
-- |
|
jobno |
Job number |
Y |
-- |
|
job_folder |
Path name of job storage folder |
N |
-- |
|
unsuspended |
Whether to distribute during suspension |
N |
-- |
Return codes
The following table lists the return codes that are output when the dcmjbrm command is executed:
Code |
Meaning |
Action to be taken |
---|---|---|
0 |
The specified job was set to the Now being deleted state, or was not found. |
None |
1 |
The parameter file cannot be opened, or the file format is incorrect. |
Check the specification of the parameter file or its description format. |
2 |
An invalid value was specified in the parameter file. |
Check the values specified in the parameter file. |
3 |
Connection to the database failed. |
Check the database settings in the setup of the managing server. |
5 |
Connection to the JP1/IT Desktop Management 2 service failed. |
Check whether the service of JP1/IT Desktop Management 2 - Manager has started. |
12 |
Restoration of one or more archive files failed. |
Reference the event log. |
Notes
-
In the parameter file, specify the job number that was output to the output file by the dcmcoll command (without /s specified), the dcminst command (without /s specified), the dcmjexe command, or the dcmsusp command (without /s specified).
-
If the job number of the job to be deleted is unknown, you cannot execute the dcmjbrm command. In such cases, in the Job Status window of the managing server, delete the job that has the job name of the job to be deleted.
Example
The following example shows use of this command to delete the Collect-slip-file-0001 job executed by the dcmjexe command.
- Creating the parameter file
-
In the parameter file, specify the job number output to the output file by the dcmjexe command as shown below.
If the output file output by the dcmjexe command has been stored, you can specify the stored file as the parameter file.
** dcmjexe output->dcmjbrm input JOB_ATTRIBUTE{ job_generator= Collect-slip-file-0001 jobno= JB03121113315383 job_folder= \batch-definition }
- Executing the command
-
When the output file output by the dcmjexe command is stored as the file C:\Dmbat\out.txt, specify the command as follows:
dcmjbrm.exe /i C:\Dmbat\out.txt