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

Index List Web Service Input Parameters

Userid

Specifies the user ID associated with the request. Userid specifies a user ID defined to the Host Output Management product where the report is stored. The Host Output Management product is defined by the repository definition file entry for the repository that is specified as the repository parameter to the Index List request. The userid parameter is required for an Index List request. An Index List request only returns index information for reports that are assigned or accessible to the user ID in the Host Output Management product. If the user ID can view a single report, only information for that report gets retrieved, even if other parameters are specified on the Index List request.

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. The repository definition file is created during the post-installation of the Web Service or when the Host Output Management product is changed (such as applying a service pack, installing a new release of the product, or adding, changing or removing repositories for the product).

The repository definition entry identifies a specific repository in the Host Output Management Product. The Index List Web Service retrieves information for reports that are held on that repository only. If you require information for reports on other repositories, make secondary requests. The repository parameter is case-sensitive and must match the case of the repository entry exactly.

Returnas

Allows the client application to specify the format of the data returned. For example, a returnas value of "xmlattachment" returns the data from the Index List request as a file attachment in XML format. Returnas values that are supported for the Index List Web Service are:

• Vector data is returned as a vector. The client code supports vector data types if 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 the string arrays.
• 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.

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

Type

Specifies the type of index list being requested. Index List types include CROSSREPORTNAMES, CROSSREPORTVALUES, INDEXNAMES, and INDEXVALUES. The following table describes each Index List type:

CROSSREPORTNAMES

Request is to return cross-report index names for a repository.

CROSSREPORTVALUES

Request is to return the report handles for cross-report names matching cross-report values.

INDEXNAMES

Request is to return index names for a report in a repository.

INDEXVALUES

Request is to return the report handles for sections of a report with index names matching index values.

The type parameter is not case-sensitive; it can be upper, lower, or mixed case. This parameter is required.

Selection Criteria

Specifies a series of rules that are used when determining the reports (in the specified repository) for which index information is retrieved.

The selection criteria are name-value pairs, where the name is a field name (that uses a selected set of field name keywords) and the value is the value that must be matched (to select reports for which index information is to be returned). Values 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".

For the selection criteria specification, the special rules are as follows:

1. If the field consists of characters, the value that is specified must be an exact match or a partial match when 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 a sequence number of 50. 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/2003" for the ARCDATE criteria retrieves information for reports that are archived between January 1, 2003 and September 5, 2003.

1. CRXNAME and CRXVALUE are special criteria names relating to cross-report index names and value specification.
   • The CROSSREPORTNAMES type requires the CRXNAME selection criteria. The value that is specified selects cross-report index names for a repository. For example, if a CRXNAME with a value of A* is specified, all cross-report index names that begin with A are returned. The CRXNAME criteria name specifies one to eight parts of a cross-report index name. CA View supports an index name of up to eight parts.
   • The CROSSREPORTVALUES type requires CRXNAME and CRXVALUE selection criteria. CRXNAME specifies a cross-report name. The CRXVALUE criteria indicate the values to match for selecting sections of one or more reports matching the cross-report index and value. If the CRXNAME criteria specify a two-part index, then the CRXVALUE specifies two values to match. For example, to locate the reports for travel agency’s names beginning with the letter A in the city of Dallas, specify a CRXNAME of "AGENCY", "CITY" and the CRXVALUE of "A*", "DALLAS".

     Note: Wildcard search cannot be used for both CRXNAME and CRXVALUE at the same time.

2. IDXNAME and IDXVALUE are special criteria names relating to index names and value specification.
   • If the type is INDEXNAMES then the selection criteria IDXNAME is required. The value that is specified is used to select index names for a report.

   For example, if an IDXNAME with a value of A* is specified, all of the index names for the specified report beginning with A are returned. The IDXNAME criteria name specifies one to eight parts of an index name; CA View supports an index name of up to eight parts.

   • The INDEXVALUES type requires the IDXNAME and IDXVALUE selection criteria. IDXNAME specifies an index name. The IDXVALUE criteria indicate the values to match for selecting sections of a report that match the index name and value. If the IDXNAME criteria specify a two-part index, then the IDXVALUE specifies two values to match.

     For example, to locate the portions of a report for names of travel agencies beginning with the letter A in the city of Dallas, specify IDXNAME of "AGENCY", "CITY" and the IDXVALUE of "A*", "DALLAS". A report handle selection criteria, also required, specifies the report to use for locating the index information.

     • The INDEXNAMES type requires the RPT_HANDLE selection criteria. RPT_HANDLE specifies a valid report handle for a report in the repository that the specified user ID can access.
     • The INDEXVALUES type requires the RPT_HANDLE selection criteria. RPT_HANDLE specifies a valid report handle for a report in the repository that the specified user ID can access.
3. If the type is CROSSREPORTNAMES or CROSSREPORTVALUES, the valid selection criteria fields are RID, GEN, VERSION, ARCDATE, CRXNAME, and CRXVALUE. Specifying any other selection criteria fields generates an error. Specification of the RID, GEN, VERSION, and the ARCDATE parameters is optional; if specified, they improve the performance.
4. Specify date values as DD/MM/YYYY.
5. Specify time values as HH:MM:SS:nn or HH:MM:SS which is the same value as HH:MM:SS:00.