Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 - Print Option Description and User's Guide


jprprint (Windows)

Organization of this page

Syntax

jprprint
     job-operation-information-file-name
     format-definition-file-name
     [{-p|-c output-CSV-file-name [-u]}]
     [-r release-ID]

Description

The jprprint command outputs the contents of a job operation information file to a printer in the format defined in a format definition file. The command outputs the information to the default printer.

The jprprint command displays a window when it prints the document using a printer. For this reason, you must be logged in to Windows to use this command.

Specify the job operation information file (.aoi) and format definition file (.jof) by full path. You cannot specify a relative path.

If you specify a -c output CSV file name (.csv), the jprprint command outputs the information to the specified file in CSV format.

For automatic operation by using JP1/AJS
When a window or a message dialog does not display and wait for input# by executing the jprprint command

You can specify an executable file or a script file to JP1/AJS job definition for executing the job.

For details on how to design the system for automated job execution, see the manual JP1/AJS.

When a window or a message dialog displays and waits for input# by executing the jprprint command

You can use JP1/Script by logging in to Windows. JP1/Script provides functionality to enable job execution in the user session space. Create a script file (.spt) and specify the created script file for the executable file for JP1/AJS. For details on how to create a script file, see the manual JP1/Script (For Windows Systems).

#

For an example that a window or a message dialog displays and waits for input:

- When you print the document using a printer, a printer dialog displays and wait for a user response.

Example of command specification:

To print the job operation information file C:\Input\SAMP.aoi as defined in the format definition file C:\Format\unit.jof, execute the command as follows:

jprprint  c:\Input\SAMP.aoi c:\Format\unit.jof

The following shows an example of executing the command above using a JP1/Script script file:

NetExec("SERVER","C:\Program Files\HITACHI\JP1AJS2PO\jprprint.exe", _
        True,"",False,Empty,_
        " " "c:\Input\SAMP.aoi "" ",_
        " ""c:\Format\unit.jof "" ",_
        "-p")
Exit(_EXEC_RTN_)

For details on how to create a script file, see the manual JP1/Script (For Windows Systems).

Command directory

installation-directory

Options and arguments

job-operation-information-file-name

Specify the name of the job operation information file whose information you want to output.

Specify the file name by full path (including the extension .aoi).

Make sure that the path and file name of the file do not exceed 258 bytes in total, the path does not exceed 194 bytes, and the file name does not exceed 63 bytes.

format-definition-file-name

Specify the name of the format definition file that contains the formats for the job operation information you want to output.

Specify the file name by full path (including the extension .jof).

Make sure that the path and file name do not exceed 258 bytes in total, the path does not exceed 194 bytes, and the file name does not exceed 63 bytes.

The format definition file is located in the folder specified in the Format definition field in the Environment Settings window.

You can create format definition files in the Format Definition Settings window.

-p

Specify this option to output the job operation information to the default printer. This option cannot be specified together with the -c option.

-c output-CSV-file-name

When you want to output job operation information to a CSV file, specify the -c option and the name of the CSV file to which to output the information.

Specify the file name by full path (including the extension .csv).

Make sure that the path and file name of the file do not exceed 258 bytes in total, and the path does not exceed 194 bytes. The file names of files whose path and file name exceed 258 bytes in total are converted automatically when the file is saved. For details on the rules governing automatic file name conversion, see 7.10 Save CSV File window.

Do not use any of the following characters in a file name:

\ / : * ? " < > |

This option cannot be specified together with the -p option.

If you specify this operand, the document is not output to the printer.

The contents of the CSV file differ depending on whether the Outputs CRLFs to CSV file check box is selected in the Environment Settings window.

-u

You can specify this option when -c output-CSV-file-name is specified.

This option dictates how the command behaves when the file specified in output-CSV-file-name already exists.

If you specify this option, the file is overwritten if it already exists. If you omit this option, the command terminates abnormally if the file already exists.

-r

If the specified job operation information file contains release ID information, specify the release ID of the jobnet whose information you want to output.

If you do not specify a release ID, the command outputs jobnet information for one of the release IDs in the file. For details on release IDs, see the manual JP1/Automatic Job Management System 3 Overview.

Cautionary notes:
  • If you print a document using a printer by executing the jprprint command, a printer dialog or a message dialog might display and wait for a user response. In this way, log in to Windows and execute the command.

  • If a user without administrator privileges in an environment where UAC (User Account Control) is enabled, specifies a protected folder such as C:\Program Files as the output destination for a CSV file, the file might be redirected and saved to each user's VirtualStore folder.

    Files are redirected when the save destination is a folder in one of the following directories:

    - system-drive:\Windows

    - system-drive:\Program Files

    - system-drive:\Program Files (x86) (for 64bit Windows)

    The redirected files are stored in the following directories:

    - %LocalAppData%\VirtualStore\Windows

    - %LocalAppData%\VirtualStore\Program Files

    - %LocalAppData%\VirtualStore\Program Files (x86)

    The default value of the %LocalAppData% is system-drive:\Users\OS-user-name\AppData\Local.

  • If the length of the path (including the file name) to the CSV file created by the jprprint command exceeds 218 characters, an error occurs when you start Microsoft Excel to open the CSV file. If this occurs, use one of the following methods to open the file:

    - Change the name of the file to a shorter one.

    - Change the name or names of one or more folders that contain the file to shorter ones.

    - Move the file to a folder with the shorter path name.

  • If you press the Ctrl + C keys during execution of the jprprint command, the jprprint command is interrupted, but printing might go on in the background or a CSV file might be output.

Return values

0

Normal termination

4

Terminated with warning (there is no information to output or the input file includes unsupported units)

10

Abnormal termination (such as an argument specification error or the maximum number of units exceeded)

20

Abnormal termination (runtime error)

Memory used by jprprint command

You can use the following equation to determine how much memory the jprprint command will use.

Keep in mind that a certain amount of leeway is built into this equation.

Many of the factors governing memory usage depend on individual user settings. These include the length of unit names, the depth of the hierarchy, the amount of unit attribute data, and the number of schedule rules. For this reason, the result of the equation does not always reflect actual memory usage.

Equation:

4 MB + (Memory needed to load job operation information file) x 3.5 bytes

  • Memory needed to load job operation information file:

    = All units + Format

  • All units:

    = 20 bytes + 4 bytes x Total number of units + (1 unit) x Total number of units

  • 1 unit:

    = 28 bytes + (48 bytes + average data of unit attributes x number of days of daily data collected) x number of attributes collected by ajsshow command + (48 bytes + average data of unit attributes) x number of attributes collected by ajsprint command + (number of attributes collected by ajsshow command + number of attributes collected by ajsprint command) x 8 bytes

  • Format

    = 61 bytes x 4 bytes + 12 bytes x number of columns selected

Note:
  • If memory usage reaches the OS's upper limit (2 GB) for a single process, the process fails in the insufficient memory error (KAVR0002-E) even when the machine capacity allows more.

    In such a case, perform (1), (2), or both below in order to divide the job operation information file into smaller parts

    (1) In order to make the number of target units smaller, choose a unit name from the lower level and specify it for the jprcollect command.

    (2) In order to make the volume of collecting schedule information smaller, specify a shorter collection period for the jprcollect command.

  • In cases where multi-user remote operation is enabled, the required amount of memory space is given by multiplying the amount needed for a single process of JP1/AJS3 - Print Option by the number of users who use JP1/AJS3 - Print Option.