Understanding the Web Services › The Report List Web Service › Input Parameters

Input Parameters

A Report List request returns report information for reports that are assigned or accessible to the user ID in the Host Output Management product. If the user ID can view only a particular report, only information for that report gets retrieved.

Userid

Specifies the user ID associated with the request. The userid specifies a user ID defined to the Host Output Management product where the report is stored. A Report List request requires the userid parameter.

Password

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.

Repository

Specifies the name of an entry in the repository definition file and identifies a specific repository in the Host Output Management product. The Report List Request retrieves information for reports that are held in that repository only. If information is required for reports on other repositories, make secondary requests. This case-sensitive parameter 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.

Returnas

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 List Web Service are:

• Vector data is returned as a vector. The client code supports the vector data types. If a vector is specified as a returnas value. Java supports Vector data.
• StringArray data is returned as a string array. The client code supports the data that is returned as string arrays. Java and the Visual Basic client code support a string array.
• XMLString data is returned as a single string containing the data retrieved by the Web Service request. The string is a fully formatted XML document.
• XMLAttachment data is returned as a file attachment. The file is in XML format and contains the data that is retrieved by the Web Service request.

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".

Fields

Specifies the attributes (fields) to be returned and is based on the requirements of the application being developed. This parameter must pass at least one attribute (field name) or the request fails. The fields parameter that is passed to the Web Service is a list of the attributes indicating the information to be returned for each report in a repository. In Java, each field would be delimited with double quotation marks and separated by commas. For more information about the attributes that can be specified in the fields parameter, see the appendix "Customizing the Report List Web Service" in this guide.

Selection criteria

Specifies a series of rules to determine the reports (in the specified repository) for which information is retrieved. If selection criteria are omitted from the parameter list, all of the reports accessible by the user ID in the repository are selected. For example, selection criteria can be specified to return information for a specific report name, such as the number of lines in the report named "creditcardsummary".

Selection criteria are name-value pairs; the name is a field name (uses same field name keywords as specified for the field parameter) and the value is the value that must be matched. Values in the parameters are specified as character strings; numeric data values, dates, and times are specified as numeric values, such as "1", "01/01/01", "12:00:00:00".

Use the following name-value pair to return the number of lines for a report named "creditcardsummary":

The keyword RID designates the report name field and creditcardsummary is the report name in the repository.

There are several special rules for the selection criteria specification:

1. If the field is comprised of characters, the value that is specified must be an exact match or a partial match using an "*" or "?" character to create a mask character:

"c*" returns information for all reports whose report names begin with c.

1. If the field is numeric, date or time, the value must be an exact match:

Specifying "50" for the LINES criteria returns information for all reports that have 50 lines. Specifying "09/05/2003" for the ARCDATE criteria retrieves information for reports that are archived on September 5, 2003.

1. If the field is numeric, date or time, the value can be in a range of values:

Specifying "50,100" for the LINES criteria returns information for all reports that have from 50 to 100 lines inclusive. Specifying "01/01/2003, 09/05/2004" for the ARCDATE criteria retrieves information for reports that are archived between January 1, 2004 and September 5, 2004.

1. CRXNAME, CRXVALUE are special criteria names that relate to cross-report index names and value specification rather than report information fields. For the Report List request, specifying a CRXNAME requires also specifying a CRXVALUE.

   Note: CRXNAME and CRXVALUE are only supported for CA View. CRXNAME specifies one to eight parts of a cross-report index name. CRXVALUE specifies a cross-report index value. If the CRXNAME criteria specify a two-part index, then the CRXVALUE must specify two values to match.

   For example, a group of reports can support a three-part cross-report index (ACCOUNT#, MONTH, YEAR). To retrieve information for all March 2004 reports for account number 12345, the CRXNAME and CRXVALUE are:

To retrieve information for all reports for account number 12345 for all months of all years, the CRXNAME for specific index names and CRXVALUE with wildcards are:

1. Specify dates values as DD/MM/YYYY.
2. Specify time values as HH:MM:SS:nn or HH:MM:SS which is the same value as HH:MM:SS:00.
3. Specify a selection criteria that specifies a recipient using the RECIPIENT field, if the Host Output Management Product is CA Dispatch.
4. Specify a selection criteria that specifies a mailcode using the MAILCODE field, if the Host Output Management Product is CA Bundl.