18.3 Oracle Reports Web Service Operations

Oracle Reports exposes the RWWebService servlet as a Web service with its public interfaces and bindings defined and described using XML. These public interfaces and bindings are published across the network through the WSDL.

18.3.1 Using Oracle Enterprise Manager to Test RWWebService

To test the RWWebservice through Oracle Enterprise Manager, complete the following steps:

Log in to Oracle Enterprise Manager.
Navigate to your WebLogic Domain.
From the WebLogic Domain menu, select Web Services > Test Web Service

The Test Web Service page is displayed.
Enter the URL of a WSDL and click Parse WSDL.
Select the webservice operation that you want to invoke.
Enter valid values in appropriate fields.
Click Test Web Service.

The Webservice Response is displayed.
In case you want to edit the values, click the Request tab and complete the step 6 and 7.

The operations supported by the RWWebService endpoint are:

getAPIVersion
getServerInfo
getJobInfo
killJob
runJob

18.3.1.1 getAPIVersion

The getAPIVersion() operation returns the version details of the Reports Server in XML format. This operation takes no parameters.

Note:

getAPIVersion is the only operation that returns the entire SOAP response along with the result (in a string). The other operations, for example, runJob return the response as an XML block embedded within the SOAP response.

To view the getAPIVersion response:

Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3 in Section 18.3.1, "Using Oracle Enterprise Manager to Test RWWebService".
From the Operation drop-down list, select getAPIVersion.

The Test page does not display any parameters.
Click Test Web Service.

The SOAP response is displayed in the Response tab.

The following is a sample response of a getAPIVersion operation:

<?xml version="1.0" encoding="UTF-8" ?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"   
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SOAP-ENV:Body>
    <ns1:getAPIVersionResponse
      xmlns:ns1="http://oracle.reports.rwclient/RWWebService.wsdl"
      SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <return xsi:type="xsd:string">11.1.1.1.0</return> 
    </ns1:getAPIVersionResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

18.3.1.2 getServerInfo

The getServerInfo(String serverName, String authId) operation takes two parameters and returns the Reports Server information in an XML format.

The valid parameters are :

serverName: A valid non-null server name. This operation returns an error if the specified server is not running in the network.
authId: A string in the form of username/password, must be specified for a secured server. This parameter is ignored for a non-secure server.

To view the getServerInfo response:

Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3 in Section 18.3.1, "Using Oracle Enterprise Manager to Test RWWebService".
From the Operation drop-down list, select getServerInfo.

The Test page displays the relevant parameter fields in the Input Arguments section.
Enter the Reports Server name (arg0) and authId (arg1).
Click Test Web Service.

The SOAP response is displayed in the Response tab.

The following is a sample output of the getServerInfo operation:

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverInfo name="repserv" version="11.1.1.1.0">
   <host>incq246bc</host>
   <processId>2588</processId>
   <startTime>27-May-2003 10:09:34</startTime>
   <queue maxQueueSize="1000"/>
   <engine id="rwEng" activeEngine="1" runningEngine="0"/>
   <engine id="rwURLEng" activeEngine="1" runningEngine="0"/>
   <performance>
      <property name="successfulJobs" value="6"/>
      <property name="currentJobs" value="0"/>
      <property name="futureJobs" value="0"/>
      <property name="transferredJobs" value="0"/>
      <property name="failedJobs" value="0"/>
      <property name="AverageResponseTime" value="2124"/>
      <property name="executionTimeToDate" value=""/>
   </performance>
</serverInfo>

18.3.1.3 getJobInfo

The getJobInfo(Integer jobId, String serverName, String authId) operation returns the job information in XML format.

The valid parameters are:

jobId: JobId of the job for which information is required.
serverName: A valid non-null Server name value must be supplied. This operation returns an error if the specified server is not running in the network.
authId: A string in the form of username/password, must be specified for a secured server. For a non-secure server this parameter is ignored.

To view the getJobInfo response:

Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3 in Section 18.3.1, "Using Oracle Enterprise Manager to Test RWWebService".
From the Operation drop-down list, select getJobInfo.

The Test page displays the relevant parameter fields in the Input Arguments section.
Enter the jobId (arg0), Reports Server name (argm1), and authId (arg2).
Click Test Web Service.

The SOAP response is displayed in the Response tab.

The following is a sample output of a getJobInfo operation for job id=3:

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverQueues>
   <job id="3" queueType="past">
      <name>test.rdf</name>
      <type>report</type>
      <status code="4">Finished successfully</status>
      <owner>RWUser</owner>
      <server>repserv</server>
      <destination>
         <desType>cache</desType>
         <desFormat>html</desFormat>
         <file>21748116.htm</file>
         <file>217481161.jpg</file>
         <file>217481160.jpg</file>
      </destination>
      <timingInfo>
         <queued>27-May-2003 10:21:50</queued>
         <started>27-May-2003 10:21:50</started>
         <finished>27-May-2003 10:21:51</finished>
      </timingInfo>
   </job>
 </serverQueues>

18.3.1.4 killJob

The killJob(Integer jobId, String serverName, String authId) operation kills the job based on the job id specified and returns the status of the operation in XML format.

The valid parameters are:

jobId: JobId of the job for which information is required.
serverName: A valid non-null Server name value must be supplied. This operation returns an error if the specified server is not running in the network.
authId: A string in the form of username/password, must be specified for a secured server. For a non-secure server this parameter is ignored.

To view the killJob response:

Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3 in Section 18.3.1, "Using Oracle Enterprise Manager to Test RWWebService".
From the Operation drop-down list, select killJob.

The Test page displays the relevant parameter fields.
Enter the jobId (arg0), Reports Server name (arg1), and authId (arg2).
Click Test Web Service.

The SOAP response is displayed in the Response tab.

The following is a sample output of a killJob operation for Job ID=3:

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverQueues>
   <job id="3" queueType="past">
      <name>test.rdf</name>
      <type>report</type>
      <status code="7">Canceled upon user request</status>
      <owner>RWUser</owner>
      <server>repserv</server>
      <destination>
         <desType>cache</desType>
         <desFormat>html</desFormat>
      </destination>
      <timingInfo>
         <queued>27-May-2003 10:21:50</queued>
         <started>27-May-2003 10:21:50</started>
         <finished>27-May-2003 10:22:00</finished>
      </timingInfo>
   </job>
</serverQueues>

18.3.1.5 runJob

The runJob(String commandLine, Boolean synchronous) operation runs a job to the Reports Server specified as part of the commandLine parameter.

Note:

Oracle Reports Web service does not return the job output or the actual report.

The valid parameters are:

commandLine: The complete command line syntax for submitting a job. For example:
```
server=repserv report=test.rdf destype=file desname=output.pdf desformat=pdf         userid=scott/tiger@oraDB
```
Note:
The command line parameter cannot include paramform=yes. You have to pass the actual values for the parameter as part of the commandLine argument.
synchronous: A Boolean object to indicate if the job should be run synchronously.

To view the runJob response:

Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3 in Section 18.3.1, "Using Oracle Enterprise Manager to Test RWWebService".
From the Operation drop-down list, select runJob.

The Test page displays the relevant parameter fields.
Enter the command line syntax (arg0), whether the job should run synchronously (T/F, Y/N) (arg1).
Click Test Web Service.

The SOAP response is displayed in the Response tab.

The following is a sample output of a runJob operation:

<?xml version = '1.0' encoding = 'ISO-8859-1' standalone = 'yes'?>
<serverQueues>
   <job id="7" queueType="current">
      <name>test.rdf</name>
      <type>report</type>
      <status code="1">Waiting in the queue</status>
      <owner>RWUser</owner>
      <server>repserv</server>
      <destination>
         <desType>file</desType>
         <desName>output.pdf</desName>
         <desFormat>pdf</desFormat>
      </destination>
      <timingInfo>
         <queued>27-May-2003 10:22:00</queued>
         <started>27-May-2003 10:22:00</started>
         <finished>27-May-2003 10:22:00</finished>
      </timingInfo>
   </job>
</serverQueues>