This command deletes job definitions that are specified in a parameter file.

dcmrmgen.exe /i parameter-file-name [/LC {ON|OFF}]

• /i
  Specify the full path of the parameter file.
  You can also use an output file from the dcminst command (with a /s specification) as a parameter file.
  
• /LC
  Specify ON or OFF to indicate whether the command's processing is to continue after logging off from Windows when Task Scheduler or JP1/AJS is used to execute commands in the background.
  
  • ON
    Continues command processing even after logging off from Windows.
    
  • OFF
    Forcibly terminates command processing once Windows is logged off.
    
  This argument is effective when the command is executed from a service under any of the following OSs:
  
  • Windows NT 4.0
  • Windows 2000
  • Windows XP
  • Windows Server 2003 (excluding Windows Server 2003 (IPF))
  Do not specify /LC ON when you execute the command from the command prompt, because in this case the command is executed as a foreground program.
  You can use a registry setting to specify whether command processing is to continue after Windows is logged off. For details about the registry setting, see the following sections:
  
  • Executing the command in JP1/Software Distribution Manager
    4.6 Registry settings (JP1/Software Distribution Manager) in the manual Setup Guide
    
  • Executing the command in JP1/Software Distribution Client (relay system)
    5.4 Registry settings (JP1/Software Distribution Client (relay system)) in the manual Setup Guide
    
  Note that operation may differ depending on the combination of the /LC specification and the registry setting. For details, see 4.28 Command operation at logoff that depends on a registry setting and logoff option.
  

You can also use command arguments to specify the contents of the parameter file used in this command. The table below shows the correspondence between the contents of a parameter file and the command arguments.

Table 4-17 Correspondence between parameter file contents and arguments (dcmrmgen command)

Parameter file specification contents		Description	Specification	Command argument
Tag	Parameter
JOB_ATTRIBUTE	job_generator#1	Job name	R#2	/j
	jobno	Job number	X	--
	job_folder	Job folder path	R#2	/f
	unsuspended	Whether a distribution being suspended exists	X	--

Legend:

R: required.

X: not required (ignored if specified).

--: Cannot be specified in a command argument.

#1

To specify multiple jobs, use the semi-colon (;) to delineate the job names.

#2

When you use a parameter file, you can specify either job_generator or job_folder, or both job_generator and job_folder.

If both job_generator and job_folder are specified, the system searches folders below the specified folder and deletes the first job definition that is found.

If only job_generator is specified, anything below the root folder is subject to a search. If only job_folder is specified, all job definitions, including their folders, below the folder specified in job_folder are deleted.

However, when you use command arguments to specify these parameters, you should specify both /j and /f.

The following shows the format of the command when you specify the command by using arguments only instead of using a parameter file.

dcmrmgen.exe /j job-name /f job-storage-folder-path [/LC {ON|OFF}]
 

When you specify two or more job definition names in /j job-name, separate them with semicolons (;).

Both /j job-name and /f job-storage-folder-path must be specified; if they are not both specified, an error may occur.

The following explains the return codes that the dcmrmgen command may return:

Code	Meaning	Action
0	Either job was deleted or specified job is not found.	None.
1	Unable to open parameter file. Invalid file format.	Check the parameter file specification or coding format.
2	Invalid value in parameter file.	Check the values in the parameter file.
3	Error during connection to managing server.	Check the version of the managing server.
12	Other errors occurred.	Check the event log.

If JP1/Base is linked to manage JP1/Software Distribution users, see 1.3.3 Setting for executing commands.

Job storage folders and job definitions cannot be deleted collectively just by specifying the root folder.

The following is an example of deleting an invoice-file-0001-collection job definition saved in the batch-definition of the managing server system folder.

(a) Creating a parameter file

Define the folder in which the job definition to be deleted is saved, and a job name in the parameter file as follows, and save the parameter file under any name:

 
** dcmjexe Parameter File Sample
 
JOB_ATTRIBUTE{
job_generator= invoice-file-0001-collection
job_folder= \batch-definition
}

(b) Command execution

When saving the parameter file that has been created in a file named C:\Dmbat\dcmjexe.txt, code the command as follows:

dcmrmgen.exe /i C:\Dmbat\dcmjexe.txt