Post-Installation and Configuration Tasks › Verify Installation › Retrieving Report Data › Running the Report Fetch Test Tool

Running the Report Fetch Test Tool

The report fetch tool lets you download a report from a particular repository.

Important! Files that are downloaded to USS are in the ASCII format, and require an ASCII reader, such as z/OS UNIX Directory List Utility (va option).

Follow these steps:

1. Open a Command Prompt in Windows or Terminal in Unix/Linux/USS.
2. Navigate to the Utilities folder.

   Windows Default:

   C:\Program Files\CA\CA_OM_Web_Services\utilities

   Unix/Linux Default:

   /usr/local/CA_OM_Web_Services/utilities

   USS (Installed by SMP/E) default:

   /cai/om_web_services/utilities

   Other:

   <CA OM Web Services Install Location>/utilities

3. Invoke the Report_Fetch_Test command.

   Note: For more information about how to invoke a program on your platform, see Running the Configuration Tool (Interactive Mode). For Windows, you launch the tool from a command prompt.

4. Usage and Parameters are:

   Usage:

   Report_Fetch_Test -f {function} -u {userid} -p {password} -r {repositorydefinitionname} -t {reporttypemask} -L {lowerpagenum} -H {upperpagenum} -h {reporthandle} -F {filename} -l {logfilename} -b -o {timeoutvalue}
   

   Parameters:

   The following are the command parameters for retrieving reports.

   Note: All parameters that include spaces or special characters such as % or $ are enclosed in quotes.

   -f

   Indicates the function the command performs:

   get

   Gets the report.

   help

   Displays command usage help.

   -u

   (Required for get function) Specifies the user ID for the request.

   -p

   Specifies the password for the request.

   -r

   (Required for get function) Specifies a repository definition entry name that identifies the repository where the report is located.

   -t

   Specifies a report type or a report type mask. Report type is the type of the report in the specified repository.

   Report types are:

   TEXT

   For text reports

   AFP

   For AFP reports

   AFPtoPDF

   For report you want to transform to PDF

   Note: The AFPtoPDF option is only valid if the underlying Output Management product supports the AFP to PDF transformation.

   OTHER

   For other report types (will be treated as binary).

   This parameter is required.

   -h

   Required for get function) Specifies the report handle of the report to retrieve. Enclose the report handle in double quotes.

   -L

   Specifies the lower page range for retrieval of a text report.

   If both pageto and pagefrom are omitted, the first five pages of the report are retrieved. If pageto is specified but pagefrom is not, pagefrom is calculated as five pages lower than the pageto value. If pageto is less than five, pagefrom is the first page of the report. If you specify a pagefrom value that is greater than the number of pages in the report, the command returns no data.

   If the report type is not text, this parameter is ignored.

   -H

   Specifies the upper page range for retrieval of text reports.

   If both pageto and pagefrom are omitted, the first five pages of the report are retrieved. If pagefrom is specified but pageto is not, pageto is calculated as five pages higher than the pagefrom value. If the pageto value is greater than the number of pages in the report, the request stops retrieval at the last page of the report.

   If the report type is not text, this parameter is ignored.

   -F

   (Required for get function) Specifies the name and path of the report after download.

   -l

   Produces a log file for audit purposes and must be specified with a filename for logging purposes.

   -b

   Backs up the specified file (-F), if the file exists, before overwriting the file for the new request.

   -o

   Specifies the number of milliseconds for the code to wait for a response from the web server.

   Default: 10 seconds