About the Catalog and Test Pages
When you compile a web service class, the class compiler generates a convenient catalog page that you can use to examine the web service. This catalog page provides a link to a simple, limited test page (also generated). These pages are disabled by default. Enable them only in a test environment.
Access to the Catalog and Test Pages
If there is no web application for the namespace you are using, you cannot access the catalog and test pages; see InterSystems IRIS Web Service as Part of a Web Application. Also, by default, these pages are inaccessible. To enable access to them, open the Terminal, go to the %SYS namespace, and enter the following commands:
set ^SYS("Security","CSP","AllowClass",webapplicationname,"%SOAP.WebServiceInfo")=1
set ^SYS("Security","CSP","AllowClass",webapplicationname,"%SOAP.WebServiceInvoke")=1
Where webapplicationname is the web application name with a trailing slash, for example, "/csp/mynamespace/".
You can use these pages only if you are logged in as a user who has USE permission for the %Development resource.
Displaying the Catalog and Test Pages
For the catalog page, the URL has the following form, using the <baseURL> for your instance:
https:<baseURL>/csp/app/web_serv.cls
Here /csp/app is the name of the web application in which the web service resides, and web_serv is the class name of the web service. (Typically, /csp/app is /csp/namespace.) For example:
https://devsys/csp/mysamples/MyApp.StockService.cls?WSDL
Notes on These Pages
The catalog page displays the class name, namespace, and service name, as well as the comments for the class and web methods. The Service Description link displays the generated WSDL; for information, see Viewing the WSDL. The page then lists the web methods, with links (if you have the suitable permissions). The link for a given method displays a test page where you can test that method in a limited fashion.
Notes about this test page:
-
It does not enable you to see the SOAP request.
-
It does not test the full SOAP pathway. This means, for example, it does not write to the SOAP log that is discussed later in this topic.
-
It accepts only simple, literal inputs, so you cannot use it to call methods whose arguments are objects, collections, or datasets.
This documentation does not discuss this page further. To test your web service more fully, generate and use a web client as described in Creating Web Clients.
