13.13 dcmrmgen.exe (deleting a job definition)
This section describes the dcmrmgen command, which deletes a job definition.
Function
This command deletes the job definition specified in the parameter file.
Format
dcmrmgen.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 use also the output file output by the dcminst command (with /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 a case, 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.
-
Correspondence between the specification contents of parameter file and command arguments
The contents of the parameter file for this command can also be specified in command arguments. The following table shows the specification contents of the parameter file, and their corresponding command arguments.
Specification content of parameter file |
Content |
Whether to specify |
Command argument |
|
---|---|---|---|---|
Tag |
Parameter |
|||
job_generator#1 |
Job name |
Y#2 |
/j |
|
jobno |
Job number |
N |
-- |
|
job_folder |
Path name of job storage folder |
Y#2 |
/f |
|
unsuspended |
Whether to distribute during suspension |
N |
-- |
Command format without using any parameter file
The following shows the command format to be used when you specify only command arguments without using a parameter file:
dcmrmgen.exe /j job-name /f path-name-of-job-storage-folder [/LC {ON|OFF}]
When specifying multiple job names in /j job-name separate them by a semicolon (;).
Always specify both /j job-name and /f path-name-of-job-storage-folder. Omitting either argument causes an error.
Return codes
The following table lists the return codes that are output when the dcmrmgen command is executed:
Code |
Meaning |
Action to be taken |
---|---|---|
0 |
The specified job was deleted, or the specified job 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 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. |
Note
You cannot delete all the job storage folders and job definitions together by this command by specifying only the root folder.
Example
The following example shows use of this command to delete the Collect-slip-file-0001 job stored in the batch-definition folder in the managing server.
- Creating the parameter file
-
Specify the folder storing the job definition to be deleted and the name of the job as shown below in a parameter file, and then save the parameter file under any name.
** dcmjexe Parameter File Sample JOB_ATTRIBUTE{ job_generator= Collect-slip-file-0001 job_folder= \batch-definition }
- Executing the command
-
When the created parameter file is stored as C:\Dmbat\dcmjexe.txt, specify the command as follows:
dcmrmgen.exe /i C:\Dmbat\dcmjexe.txt