Click the WSDL link on the RWWebService Web page to view the Oracle Reports

19-6 Publishing Reports to the Web with Oracle Reports Services ■ runJob

19.3.1.1 getAPIVersion

The getAPIVersion operation returns the version details of the Reports Server in XML format. This operation takes no parameters. To view the getAPIVersion response:

1. Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3

in Section 19.3.1, Using Oracle Enterprise Manager to Test RWWebService .

2. From the Operation drop-down list, select getAPIVersion.

The Test page does not display any parameters.

3. 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.orgsoapenvelope xmlns:xsi=http:www.w3.org2001XMLSchema-instance xmlns:xsd=http:www.w3.org2001XMLSchema SOAP-ENV:Body ns1:getAPIVersionResponse xmlns:ns1=http:oracle.reports.rwclientRWWebService.wsdl SOAP-ENV:encodingStyle=http:schemas.xmlsoap.orgsoapencoding return xsi:type=xsd:string11.1.1.1.0return ns1:getAPIVersionResponse SOAP-ENV:Body SOAP-ENV:Envelope

19.3.1.2 getServerInfo

The getServerInfoString 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 usernamepassword, must be specified for a secured server. This parameter is ignored for a non-secure server. To view the getServerInfo response:

1. Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3

in Section 19.3.1, Using Oracle Enterprise Manager to Test RWWebService .

2. From the Operation drop-down list, select getServerInfo.

The Test page displays the relevant parameter fields in the Input Arguments section. 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. Using the Oracle Reports Web Service 19-7 3. Enter the Reports Server name arg0 and authId arg1.

4. 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 hostincq246bchost processId2588processId startTime27-May-2003 10:09:34startTime 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

19.3.1.3 getJobInfo

The getJobInfoInteger 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 usernamepassword, must be specified for a secured server. For a non-secure server this parameter is ignored. To view the getJobInfo response:

1. Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3

in Section 19.3.1, Using Oracle Enterprise Manager to Test RWWebService .

2. From the Operation drop-down list, select getJobInfo.

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

4. 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 nametest.rdfname typereporttype status code=4Finished successfullystatus 19-8 Publishing Reports to the Web with Oracle Reports Services ownerRWUserowner serverrepservserver destination desTypecachedesType desFormathtmldesFormat file21748116.htmfile file217481161.jpgfile file217481160.jpgfile destination timingInfo queued27-May-2003 10:21:50queued started27-May-2003 10:21:50started finished27-May-2003 10:21:51finished timingInfo job serverQueues

19.3.1.4 killJob

The killJobInteger 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 usernamepassword, must be specified for a secured server. For a non-secure server this parameter is ignored. To view the killJob response:

1. Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3

in Section 19.3.1, Using Oracle Enterprise Manager to Test RWWebService .

2. From the Operation drop-down list, select killJob.

The Test page displays the relevant parameter fields. 3. Enter the jobId arg0, Reports Server name arg1, and authId arg2.

4. 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 nametest.rdfname typereporttype status code=7Canceled upon user requeststatus ownerRWUserowner serverrepservserver destination desTypecachedesType desFormathtmldesFormat destination timingInfo queued27-May-2003 10:21:50queued started27-May-2003 10:21:50started Using the Oracle Reports Web Service 19-9 finished27-May-2003 10:22:00finished timingInfo job serverQueues

19.3.1.5 runJob

The runJobString commandLine, Boolean synchronous operation runs a job to the Reports Server specified as part of the commandLine parameter. 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=scotttigeroraDB ■ synchronous: A Boolean object to indicate if the job should be run synchronously. To view the runJob response:

1. Navigate to the Test Web Service page in Oracle Enterprise Manager. See steps 1-3

in Section 19.3.1, Using Oracle Enterprise Manager to Test RWWebService .

2. From the Operation drop-down list, select runJob.

The Test page displays the relevant parameter fields. 3. Enter the command line syntax arg0, whether the job should run synchronously TF, YN arg1.

4. 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 nametest.rdfname typereporttype status code=1Waiting in the queuestatus ownerRWUserowner serverrepservserver destination desTypefiledesType desNameoutput.pdfdesName desFormatpdfdesFormat destination Note: Oracle Reports Web service does not return the job output or the actual report. 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.