14.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
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.
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 |
-- |
|
- Legend:
-
Y: The parameter must be specified.
N: The parameter is not necessary (is ignored even when specified).
--: The content cannot be specified by using a command argument.
- #1
-
When specifying multiple job names, separate them by a semicolon (;).
- #2
-
In the parameter file, write one or both of the job_generator and job_folder parameters.
When both the job_generator and job_folder parameters are written, this command searches job definitions in the specified folder, and then deletes the job definition detected first.
When only the job_generator parameter is written, this command searches job definitions in the root folder. When only the job_folder parameter is written, this command deletes the folder (all the job definitions in the folder) specified in the job_folder parameter.
When using command arguments for specification, you must specify both the arguments /j and /f.
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
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