The Web Services

The services that the OM Web Services provide are:

Report List
Report Data
Index List
Ping

The Report List Web Service returns report attributes for one or more reports in a repository of Host Output Management product system. The input request specifies the desired attributes that are returned and the selection criteria that is used to select the reports.

The Report Data Web Service returns a report. If the report is a text report the entire report or selected pages are retrieved. If the report is AFP or binary, the entire report is returned. If the report is AFP retrieval by an index the entire section of the report matching the index is retrieved and page selection is not supported. If the report is AFP retrieval with a report type AFP2PDF for transformer support, then the PDF report is retrieved and returned as an attachment. The AFP2PDF report type is only valid if the underlying Output Management product supports the AFP to PDF transformation. The Report Data Web Service retrieves report data for processing and does not provide display facilities.

The Index List Web Service returns index information for repositories and reports. Index list requests are only valid if the underlying Output Management product supports indexing. For example, CA Dispatch does not provide indexing; Index List requests are not performed if the repository specified is for CA Dispatch. The Index List Web Service request supports two types of indexes—cross-report indexes and regular indexes. To return cross-report index information, the underlying repository must support them. In this case, CA View is the only application that supports cross-report indexing. The Index List request returns the cross-report index names for a repository, the reports that match a particular cross-report index value, index names for a report and the sections of a report that match a particular index value.

The Ping Web Service returns a string indicating the Web Service has started. Ping Web Service is the simplest Web Service, provided to test for the correct Web Service operation and setup.