Specifies the user ID associated with the request. Userid specifies a user ID defined to the Host Output Management product. The Report Data Web Service request requires the userid parameter. The Report Data request returns reports assigned or accessible to the specified user ID through the Host Output Management product. If the user ID can only view a particular report, Report Data requests for a different report fail because the user is not defined for that report in the host product.
Specifies the password that is associated with the user ID for the request. The password matches the password that is associated with the user ID defined to the Host Output Management Product. If no password is assigned, specify null.
Specifies the name of an entry in the repository definition file and identifies a specific repository in the Host Output Management Product. The Report Data request retrieves information for reports that are held on that repository only. If information is required for reports on other repositories, make secondary requests. This parameter is case-sensitive and must match the case of the repository name in the repository definition entry. Contact your System Administrator for the name of the repository definition entry.
Specifies the format of the data returned. (For example, a returnas value of "xmlattachment" returns the data from the report list request as a file attachment in XML format.) The Returnas values that are supported for the Report Data Web Service are:
data is returned as a string array. The client code supports the data that is returned as string arrays. The Java and Visual Basic client code supports the String arrays.
Attachment data is returned as a file attachment. Returning these file attachments is supported for binary and AFP reports, but is not supported for text reports. The attached file holds the report data. An AFP report returns binary data for the report in proprietary AFP formatting and can only be accessed by programs that understand the AFP format. AFP reports can return as PDF reports if the host Output Management product, CA View, supports the AFP transformation. A Binary report holds binary data and based on the initial source of the data it can only be processed by programs that understand the data source. For example, a binary file can be a JPEG image and Microsoft Paint can read and display the file.
The returnas parameter that is specified is not case-sensitive; it can be upper, lower, or mixed case. If, the returnas parameter is omitted its default value is set to "Vector".
Specifies the type of report requested. Supported report types are text, binary, AFP, and AFP2PDF. The type parameter is not case-sensitive; it can be upper, lower, or mixed case.
The following list describes each report type:
The Host Output Management product stores the report being retrieved in text form.
The Host Output Management product stores the report being retrieved as a distributed file. This file can be loaded using the LPD command.
An AFP report that is originally destined for an IBM AFP printer is the report being retrieved.
If the type parameter, is omitted it defaults to "TEXT".
An AFP report transformed to PDF is retrieved as PDF reports if the Host Output Management product supports the AFP to PDF transformation.
Applies to requests where the Type is specified as TEXT or the Type has defaulted to TEXT because the Type was not specified. The TextReportFormat parameter allows the client application to specify the data to be returned for text reports. PAGE and the LINE options are supported. The TextReportFormat parameter is not case-sensitive; it can be upper, lower, or mixed case.
The following table describes the PAGE and LINE options that are supported for the TextReportFormat parameter:
Retrieves the text report as formatted, composed pages. Each page is broken into multiple lines. The original line carriage control is evaluated and used to compose the page.
Retrieves the text report as a row of data. Data that are returned for each row includes:
If the TextReportFormat parameter is omitted, it defaults to "PAGE".
Applies to requests where the Type is specified as TEXT. If the Type is not specified, then the type has defaulted to TEXT. The Pagefrom parameter specifies the lower page range for the report selection. If the Pagefrom parameter is omitted, it defaults to 1. The Pagefrom parameter must be a numeric string whose value is greater than 0. The Pagefrom value must be lower than the Pageto value. If you specify a Pagefrom value higher than the actual number of pages in the report, the request returns no data.
Parameter applies to requests where the Type is specified as TEXT. If the Type is not specified, then the type has defaulted to TEXT. The Pageto parameter specifies the upper page range for the report selection. If the Pageto parameter is omitted, it defaults to 999999999. The Pageto parameter must be a numeric string whose value is greater than 0. When retrieving data, the Pageto value specifies the highest page to be retrieved from the report. Requests that specify a large page range take more time to retrieve. The Pageto value must be greater than the Pagefrom value. If you specify a Pageto value greater than the number of the pages in the report, the request stops after the last page of the report.
Specifies a required parameter for the Report Data requests. The report handle is a string that uniquely identifies every report in a Host Output Management repository. The Report List Web Service request or the Index List Web Service request retrieve report handle and passes them to Report Data requests through this parameter.
|
Copyright © 2013 CA.
All rights reserved.
|
|