jprwebcollect (Windows)

Organization of this page

Syntax
Description
Command directory
Options and arguments

Syntax

jprwebcollect
     unit-name
     job-operation-information-file-name
     [  -b  year/month/day  -e  year/month/day
     |  [-L]  [-N]  [-T]
     |  {-l  month | -n  month | -t}  [-p  month]
     |  [-C]  [-G]  [-D] ] [-w]
     [-F  name-of-JP1/AJS-scheduler-service]
     [-A]  [-U]  [-y]
     [-z]
     --user login-user-name
     --mhost host-name-of-JP1/AJS3 - Manager
     --whost host-name-of-JP1/AJS3 - Web Console
     [--protocol {http | https}]
     [--port port-number]

To Page Top

Description

The jprwebcollect command collects job operation information after logging in to JP1/AJS3 - Manager from which the information is collected through the JP1/AJS3 - Web Console to connect to. It collects the information of job network element definitions as well as execution schedules and results. The collected information is stored in the job operation information file. The job operation information file is used as the input information for the job operation document output.

The jprwebcollect command uses the ajsprint and ajsshow commands provided by JP1/AJS to collect job operation information.

Command name	Purpose
`ajsprint`	Collecting definition information
`ajsshow`	Collecting execution schedules and results

Before you use the jprwebcollect command, the environment (environment variables and other settings) must be configured to support the commands listed above. For details, see the manual JP1/Automatic Job Management System 3 Command Reference.

You can use unit names to specify the job operation information to collect. Use the full path of a JP1/AJS job, jobnet, or job group to specify a unit name. A full unit name begins with a forward slash (/) and consists of the names of the root jobnet down to the job network element, each separated by forward slashes.

To collect information for all units under the root job group, specify the -A option. If you use the -A option, you can specify / (the root job group) as the unit name.

When collecting execution schedules and results, specify the period for which to collect the information. The collection period is defined by a start date and an end date. You can use date specification, monthly specification, relative month specification, or daily specification to specify the collection period. For details about the collection period, see jprcollect (Windows and UNIX).

Examples of command specification:

When the JP1/AJS3 - Manager host name from which the information is collected is host001, the login user is jp1admin, and the name of the JP1/AJS3 - Web Console host to connect to is hostweb01

To collect execution schedules and results for jobnet Net1 in job group Group1 using the current month as the collection period, and record the information in the file c:\work\test.aoi, execute the command as follows:

jprwebcollect /Group1/Net1 c:\work\test.aoi -T -F AJSROOT1 --user jp1admin --mhost host001 --whost hostweb01

The execution history is output to c:\work\test.log.

To Page Top

Command directory

installation-folder

To Page Top

Options and arguments

unit-name

Specify the name of the unit whose job operation information you want to collect. The command collects information for the specified unit and all its subordinate units.

This argument does not accept wildcards (such as * and ?).

Do not specify more than one unit name. If you do, an error occurs when you attempt to output a job operation document.

Unit names are case sensitive.

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.

Do not use any of the following symbols in the file name.

\ / : * ? " < > |

-b year/month/day

Specify the start date of the period for which to collect execution schedules and results. The base time serves as the start time.

year

Specify a year as a value from 1994 to 2036.
month

Specify a month as a value from 1 (or 01) to 12.
day

Specify a date as a value from 1 (or 01) to 31.

This option must be specified together with the -e option. If you omit one or the other, the command will not collect execution schedules and results.

-e year/month/day

Specify the end date of the period for which to collect execution schedules and results. The date you specify must be the same as or later than the start date. The base time plus 23 hours, 59 minutes, and 59 seconds serves as the end time.

year

Specify a year as a value from 1994 to 2036.
month

Specify a month as a value from 1 (or 01) to 12.
day

Specify a date as a value from 1 (or 01) to 31.

This option must be specified together with the -b option.

-L

Specify this option when you want to collect execution schedules and results for the previous month.

You cannot specify this option with the -N option unless the -T option is also specified.

-N

Specify this option when you want to collect execution schedules and results for the next month.

You cannot specify this option with the -L option unless the -T option is also specified.

-T

Specify this option when you want to collect execution schedules and results for the current month.

-l month

Specify this option when you want to collect execution schedules and results for one or more months, starting from a past month.

You can specify the following values:

Month: 1 to 12

-n month

Specify this option when you want to collect execution schedules and results for one or more months, starting from a future month.

You can specify the following values:

Month: 1 to 12

-t

Specify this option when you want to collect execution schedules and results for one or more months, starting from the current month.

-p month

When collecting execution schedules and results on a monthly basis, specify the number of months for which you want to collect data.

You can specify the following values:

Month: 1 to 12

Specify this option together with the -l, -n, or -t option.

If you omit -p, then -p 1 is assumed and the command collects information for one month.

-C

Specify this option when you want to collect execution schedules and results for the previous day.

You cannot specify this option with the -G option unless the -D option is also specified.

-G

Specify this option when you want to collect execution schedules and results for the next day.

You cannot specify this option with the -C option unless the -D option is also specified.

-D

Specify this option when you want to collect execution schedules and results for today.

-w

Specify the start date and end date of the time period when execution schedules and results are collected as an execution date. If you omit this option, specify the start and end dates of the time period mentioned earlier as a calendar date.

For details how the Calendar date and Execution date options work differently, see jprcollect (Windows and UNIX).

-F name-of-JP1/AJS-scheduler-service

Specify the name of the JP1/AJS scheduler service to be accessed by the command.

If you omit this option, the command assumes that the service name of the JP1/AJS scheduler service has AJSROOT1 specified for operation.

-A

Allows you to specify the root job group (/) in unit-name.

-U

Specify this option to collect information about the last update times for the specified unit and its subordinate units.

-y

Specify this option to collect jobnet information for each release ID when the registration information for the specified unit includes jobnet release information.

For details on jobnet release, see the description of the jobnet release functionality in the manual JP1/Automatic Job Management System 3 Overview.

-z

Specify the behavior when the file specified for the job operation information file name already exists.

If you specify this option, the file is overwritten when the file already exists. If you omit this option, an error occurs when the file already exists.

--user login-user-name

Specify the name of the JP1 user who logs in to JP1/AJS3 - Manager from which the information is collected.

Execute the jprajsmkkey command in advance, to register the JP1/AJS3 - Manager host name, login user name, and password in the authentication information file. An error occurs if the specified login user name is not registered in the authentication information file.

--mhost host-name-of-JP1/AJS3 - Manager

Specify the host name or IP address of the JP1/AJS3 - Manager host from which the information is collected from 1 to 255 bytes.

--whost host-name-of-JP1/AJS3 - Web Console

Specify the host name or IP address of the JP1/AJS3 - Web Console host from which the information is collected from 1 to 255 bytes.

--protocol {http | https}

Specify the communication protocol for JP1/AJS3 - Web Console to connect to as either HTTP or HTTPS communication. If you omit the --protocol option, the default is http.

--port port-number

Specify the port number used for communicating with JP1/AJS3 - Web Console to connect to. If you omit the --port option, the default is 22252 when you specify http in the --protocol option, and if you specify https in the --protocol option, the default is 22253.

Return values

`0`	Normal termination
`4`	Ended with warning (the command collected definition information but not execution schedules and results)
`10`	Abnormal termination (argument specification error)
`20`	Abnormal termination (runtime error)

Supplementary note:

Each time you execute the jprwebcollect command, JP1/AJS3 - Print Option creates a file containing execution log information for the command in the same directory or folder as the job operation information file. The file has the same name as the output file but with the extension .log.

The jprwebcollect command does not validate its syntax before executing. If the command terminates abnormally, identify the problem by reviewing the execution log information.

For details about the execution log information, see jprcollect (Windows and UNIX).

Cautionary notes:

This command is available when the versions of JP1/AJS3 - Print Option, JP1/AJS3 - Manager from which the information is collected and JP1/AJS3 - Print Option Manager installed in the same machine, and JP1/AJS3 - Web Console to connect to are all 12-50 or later.
If the unit you specify has not been registered for execution, the command will collect definition information but not execution schedules and results, even if you specify a collection period. The command will not collect execution schedules and results if the unit was not registered for execution within the specified collection period. In these situations, although the command terminates with a warning, you can still output documents based on the job operation information file. However, because execution schedules and results were not collected, you cannot output documents that contain execution schedules or results.

If you specify a job group that contains units that have been submitted for execution and those that have not, the command can only collect execution schedules and execution results for the units that have been submitted for execution.
Specify the correct name of the scheduler service for JP1/AJS3 - Manager from which the information is collected. If it is not specified correctly, characters are garbled when you output documents with the output job operation information file.
Specifying the -A option to collect job operation information for all units under the root jobnet can result in a large number of unit definitions and large amounts of schedule information being collected. The result is an extremely large job operation information file (.aoi file), which places significant demands on system resources. Displaying or printing such a file in the Job Operation Document Output window, or printing or outputting the file to a CSV file using the jprprint command, can take a very long time.
A job whose execution schedule and execution results exist within the range of the specified collection period is output. For a job whose execution started within the range of the collection period but ended beyond the range of the collection period, if you collect job operation information after the end of its execution, you can obtain the execution result data within the range of the collection period. You cannot obtain the execution result data beyond the range of the collection period.
When JP1/AJS3 - Manager is operating in a cluster environment, collect job operation information from the active node. To do so, specify the name of the scheduler service on the logical host as the service name.
When you specify the -b option and the -e option, the year, month, and day specified are used as the options of the ajsshow command.

When you specify the -L, -N, -T, -l, -n, -t, -p, -C, -G, and -D options, the collection period is determined based on the system time of the physical host.
If you do not specify the -w option, the jprwebcollect command executes the ajsshow command with -b and -e options.

If you specify the -w option, the jprwebcollect command executes the ajsshow command with -v and -w options.
If you do not specify the -y option, the jprwebcollect command collects definition information, execution schedules, and execution results for units in Being Applied status. It cannot collect release information.
Grant a JP1 permission level on the JP1 resource group as the target unit of the ajsprint command and ajsshow command to the JP1 user specified for login authentication of JP1/AJS3 - Manager.

For details on the JP1 permission level necessary to execute the ajsprint and ajsshow commands, see the manual of the JP1/AJS3.
If the JP1/AJS3 environment setting parameter AJSPRINTSORTUNITINF is set to yes, the related line information is output to the job operation information file in the character code ascending order for the preceding unit and succeeding unit. If the environment setting parameter AJSPRINTSORTUNITINF is set to no or a value is not set, the related line information is output in the creation order for the preceding unit and succeeding unit. For details, see the documentation for JP1/AJS3.
If JP1/AJS adds a unit or changes a unit name during execution of the jprwebcollect command, the contents of the output job operation information file become inconsistent, causing an error when a document is output.
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 job operation information 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.
An error occurs if the values specified in the --user option and the --mhost option are not registered in the authentication information file. Use the jprajsmkkey command to register them in the authentication information file before executing the jprwebcollect command.
Authentication fails and an error occurs if the authentication information file contains incorrect information. Use the jprajsmkkey command to list the information in the authentication information file and check the JP1/AJS3 - Manager host name and login user.
If any of the --mhost, --whost, --protocol, and --port options are specified incorrectly, communication fails, resulting in an error. For details on the environment settings for JP1/AJS3 - Web Console and JP1/AJS3 - Manager, see the manual of the JP1/AJS.
Specify the same communication protocol in the --protocol option and port number in the --port option as those in the Web server definition file for JP1/AJS3 - Web Console. If they do not match, communication fails, resulting in an error. For details on the Web server definition file for JP1/AJS3 - Web Console, see the manual of the JP1/AJS.
If an error occurs in JP1/AJS3 - Web Console and JP1/AJS3 - Manager, use the data collection tools for JP1/AJS3 - Web Console and JP1/AJS3 - Manager to collect logs.

If an error occurs in JP1/AJS3 - Print Option and JP1/AJS3 - Print Option Manager, take the output job operation information file and the execution history file, and use the data collection tools for JP1/AJS3 - Print Option and JP1/AJS3 - Print Option Manager to collect logs.

Size of job operation information files

You can use the following equation to estimate the size of the job operation information file (aoi file) output by the jprwebcollect command.

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

Many of the factors governing file sizes depend on individual user settings. These include the length of unit names, the depth of the hierarchy, the position of the specified unit in the hierarchy, and the numbers of relation lines and schedule rules. For this reason, the result of the equation does not always reflect the actual file size.

Equation:

Number of units defined under specified unit x 4.5 kilobytes

+ Number of generations in specified collection period x 3.5 kilobytes

The amount of memory the jprwebcollect command will use is the same value as the above size in each JP1/AJS3 - Print Option and JP1/AJS3 - Print Option Manager.

To Page Top