Post-Installation and Configuration Tasks › Verify Installation › Retrieve a List of Reports › Running the Report List Test Tool

Running the Report List Test Tool

The report list tool gives you a list of reports in a particular repository.

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

   USS/Unix/Linux Default:

   /usr/local/CA_OM_Web_Services/utilities

   USS (Installed by SMP/E):

   /cai/om_web_services/utilities

   Other:

   <CA OM Web Services Install Location>/utilities

3. Invoke the Report_List_Test command.

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

4. Usage and parameters are:

   Usage:

   Report_List_Test -f {function} -u {userid} -p {password} -r {repositorydefinitionname} -n {reportnamemask} -d {doctypemask} -h -l -b -c {recipient} -m {mailcode} -o {timeoutvalue}
   

   Note: To redirect the output to a file add the following to the end of the command:

   Text:

   > filename.txt

   Parameters:

   The following are the parameters for generating report lists.

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

   -f

   Indicates the function to be performed by the command:

   list

   Retrieves a list of field attributes for each report.

   help

   Displays command usage help.

   -u

   Specifies the user ID for the request and is required.

   -p

   Specifies the password for the request.

   -r

   Specifies a repository definition entry name that identifies the repository with the reports to be listed.

   Required for the reportlist.bat command.

   -n

   Specifies a report name or report name mask (one or more characters followed by an asterisk). The report name is the name of a report in the specified repository and is case sensitive. Specifying "a*" matches all reports with report names starting with a. Specifying "A" matches all reports with report names starting with an upper case A.

   This parameter is not required; if omitted, all report names are selected.

   -d

   (Optional) Specifies a report type or a report type mask. Report type is the type of the report in the specified repository. Report types include "TEXT" for text reports and "AFP" for AFP reports. Binary reports are generally listed as period followed by extension in capitals: .XLS or .DOC. Wildcard * may also be used. For example, ".DOC*" will return both ".DOC" and ".DOCX" files.

   This parameter is not required; if omitted, all reports types are selected.

   -h

   Displays the report’s handle with each report.

   -l

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

   -c

   Specifies the recipient ID for requests accessing CA Dispatch™ repositories.

   Required if accessing CA Dispatch™.

   -m

   Specifies the mailcode for requests accessing CA Bundl® repositories.

   Required if accessing CA Bundl®.

   -b

   Saves the specified file, if it exists, before overwriting 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