cpajobprint
- Organization of this page
Function
Outputs the definition information for a job or item to a file.
The command output result is redirected and saved as a definition file. A job or item can be registered by specifying the definition file in the cpajobentry command or loading it from the Job Design View or the Item Design View.
- Example:
cpajobprint -i Job1 > output-file-name.xml
Format
cpajobprint { -i job-name | -f action-flow-item-name | -c calendar-item-name | -a action-item-name | -d execution-date-item-name | -t execution-time-item-name } > output-file-name.xml
Permission for execution
None
Arguments
- -i job-name
-
Outputs the definition information for the specified job.
Only one job can be specified.
For the job name, you can use multibyte characters, half-width alphanumeric characters, and underscores (_), and the length of the name is from 1 to 45 bytes.
- -f action-flow-item-name
-
Outputs the definition information for the specified item.
Only one item can be specified.
For the item name, you can use multibyte characters, half-width alphanumeric characters, and underscores (_), and the length of the name is from 1 to 45 bytes.
- -c calendar-item-name
-
Outputs the definition information for the specified item.
Only one item can be specified.
For the item name, you can use multibyte characters, half-width alphanumeric characters, and underscores (_), and the length of the name is from 1 to 45 bytes.
- -a action-item-name
-
Outputs the definition information for the specified item.
Only one item can be specified.
For the item name, you can use multibyte characters, half-width alphanumeric characters, and underscores (_), and the length of the name is from 1 to 45 bytes.
- -d execution-date-item-name
-
Outputs the definition information for the specified item.
Only one item can be specified.
For the item name, you can use multibyte characters, half-width alphanumeric characters, and underscores (_), and the length of the name is from 1 to 45 bytes.
- -t execution-time-item-name
-
Outputs the definition information for the specified item.
Only one item can be specified.
For the item name, you can use multibyte characters, half-width alphanumeric characters, and underscores (_), and the length of the name is from 1 to 45 bytes.
- > output-file-name.xml
-
Specify the output file name as a redirect destination. The extension must be .xml.
- Note
-
When the -c item or -c jds option is used in the cpareport command to output the information of the item or job list, and the item name or job name that is output is specified as an option of the cpajobentry command, the definition information can be output by item or job type.
Return values
0 |
Succeeded |
40 |
Insufficient resources |
58 |
Invalid argument |
67 |
The specified job or item does not exist. |
96 |
The job or item is invalid. |
111 |
File access error |
125 |
System error |
126 |
Program error |
Environment requirements
This command can run regardless of whether the job execution service is running or stopped.
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
-
The definition information is output in UTF-8 format.
-
If the command is executed without redirection, the result is sent to the standard output.
-
Do not modify the contents of the definition file that is output. If modified, they cannot be registered using the cpajobentry command and read from windows using the Open button.
-
Job names and items names are case sensitive. Specify them correctly.
-
If the name of a job or item that does not correspond to the argument option is specified as an argument, a command error occurs and the command terminates. However, if a job or item with the same name as the value specified in the argument exists, the definition information of the job or item is output.