Scheduling a JasperServer Report via SOAP & Python

cialowicz · May 15, 2009

I was able to figure out how to run reports, download files, list folders, etc. on a JasperServer using Python with SOAPpy and xml.dom minidom.

Here's an example execute report request, which works:

 repositoryURL = 'http://user@pass:myjasperserver:8080/jasperserver/services/repository'
 repositoryWSDL = repositoryURL + '?wsdl'
 server = SOAPProxy(repositoryURL, repositoryWSDL)
 print server._ns(repositoryWSDL).runReport('''
 <request operationName="runReport" locale="en">
 <argument name="RUN_OUTPUT_FORMAT">PDF</argument>
 <resourceDescriptor name="" wsType="" uriString="/reports/baz">
 <label>null</label>
 <parameter name="foo">bar</parameter>
 </resourceDescriptor>
 </request>
 ''')

However, I'm having trouble formatting my requests properly for the "ReportScheduler" section of the server. I've consulted the documentation located here (jasperforge.org/espdocs/docsbrowse.php), and have tried model my requests after their samples with no luck (see page 27).

Here are two examples that I've tried, which both return the same error:

 schedulingURL = 'http://user@pass:myjasperserver:8080/jasperserver/services/ReportScheduler'
 schedulingWSDL = schedulingURL + '?wsdl'
 server = SOAPProxy(schedulingURL, schedulingWSDL)

 # first request
 print server._ns(schedulingWSDL).scheduleJob('''
 <request operationName="scheduleJob" locale="en">
 <job>
 <reportUnitURI>/reports/baz</reportUnitURI>
 <label>baz</label>
 <description>baz</description>
 <simpleTrigger>
 <startDate>2009-05-15T15:45:00.000Z</startDate>
 <occurenceCount>1</occurenceCount>
 </simpleTrigger>
 <baseOutputFilename>baz</baseOutputFilename>
 <outputFormats>
 <outputFormats>PDF</outputFormats>
 </outputFormats>
 <repositoryDestination>
 <folderURI>/reports_generated</folderURI>
 <sequentialFilenames>true</sequentialFilenames>
 <overwriteFiles>false</overwriteFiles>
 </repositoryDestination>
 <mailNotification>
 <toAddresses>my@email.com</toAddresses>
 <subject>test</subject>
 <messageText>test</messageText>
 <resultSendType>SEND_ATTACHMENT</resultSendType>
 </mailNotification>
 </job>
 </request>''')

 # second request (trying different format here)
 print server._ns(schedulingWSDL).scheduleJob('''
 <ns1:scheduleJob soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://www.jasperforge.org/jasperserver/ws">
 <job xsi:type="ns1:Job">
 <reportUnitURI xsi:type="xsd:string">/reports/baz</reportUnitURI>
 <username xsi:type="xsd:string" xsi:nil="true"/>
 <label xsi:type="xsd:string">baz</label>
 <description xsi:type="xsd:string">baz</description>
 <simpleTrigger xsi:type="ns1:JobSimpleTrigger">
 <timezone xsi:type="xsd:string" xsi:nil="true"/>
 <startDate xsi:type="xsd:dateTime">2008-10-09T09:25:00.000Z</startDate>
 <endDate xsi:type="xsd:dateTime" xsi:nil="true"/>
 <occurrenceCount xsi:type="xsd:int">1</occurrenceCount>
 <recurrenceInterval xsi:type="xsd:int" xsi:nil="true"/>
 <recurrenceIntervalUnit xsi:type="ns1:IntervalUnit" xsi:nil="true"/>
 </simpleTrigger>
 <calendarTrigger xsi:type="ns1:JobCalendarTrigger" xsi:nil="true"/>
 <parameters soapenc:arrayType="ns1:JobParameter[4]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
 </parameters>
 <baseOutputFilename xsi:type="xsd:string">test</baseOutputFilename>
 <outputFormats soapenc:arrayType="xsd:string[1]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
 <outputFormats xsi:type="xsd:string">PDF</outputFormats>
 </outputFormats>
 <outputLocale xsi:type="xsd:string" xsi:nil="true"/>
 <repositoryDestination xsi:type="ns1:JobRepositoryDestination">
 <folderURI xsi:type="xsd:string">/reports_generated</folderURI>
 <sequentialFilenames xsi:type="xsd:boolean">false</sequentialFilenames>
 <overwriteFiles xsi:type="xsd:boolean">false</overwriteFiles>
 </repositoryDestination>
 <mailNotification xsi:type="ns1:JobMailNotification" xsi:nil="true"/>
 </job>
 </ns1:scheduleJob>''')

Each of these requests result in errors:

 SOAPpy.Types.faultType: <Fault soapenv:Server.userException: org.xml.sax.SAXException:
 Bad types (class java.lang.String -> class com.jaspersoft.jasperserver.ws.scheduling.Job):
 <SOAPpy.Types.structType detail at 14743952>: {'hostname': 'myhost'}>

Any help/guidance would be appreciated. Thank you.

cialowicz · May 18, 2009

Any ideas? Thanks...

jmario · May 22, 2009

hi

same problem here....

any solution yet?

cialowicz · May 22, 2009

I've tried fiddling with the XML, but still no luck. Misery, I tell you... =/

Post Edited by cialowicz at 05/22/2009 13:44

lucianc · May 27, 2009

With ZSI you can generate client stubs and types via wsdl2py. Then you would programatically call web service operations.

I'm attaching code that I used to test this approach, consisting of wsdl2py generated code plus some test code that I've written (my first Python application, so ignore the style).

Regards,

Lucian

amosunfemi · September 3, 2009

As anyone tried ZSI to call runreport method?

i tried list web method with ZSI it was ok, but runReport method gave this error

"xml.parsers.expat.ExpatError not well formed (invalid token) line 2, line 6"

here are my requests and responses:

List

Request:

'''<request operationName="list" locale="en">

</resourceDescriptor>

</request>'''

Response:<?xml version="1.0" encoding="UTF-8"?>

<label><![CDATA

]></label>

</resourceProperty>

</resourceProperty>

</resourceProperty>

</resourceProperty>

</resourceDescriptor>

</resourceProperty>

</resourceProperty>

</resourceProperty>

</resourceProperty>

</resourceDescriptor>

</resourceProperty>

</resourceProperty>

</resourceProperty>

</resourceProperty>

</resourceDescriptor>

</operationResult>

RunReport

Request:

'''<request operationName="runReport" locale="en">

<resourceDescriptor name="" wsType=""

uriString="/reports/custacct/custacctbal"

isNew="false">

</resourceDescriptor>

</request>'''

Response:

------=_Part_54_16191831.1252564510371

Content-Type: text/xml; charset=UTF-8

Content-Transfer-Encoding: binary

Content-Id: <1128FB0E70D5884145245EA68D95A8ED>

<?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><ns1:runReportResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://axis2.ws.jasperserver.jaspersoft.com"><runReportReturn xsi:type="xsd:string"><?xml version="1.0" encoding="UTF-8"?>

</operationResult>

</runReportReturn></ns1:runReportResponse></soapenv:Body></soapenv:Envelope>

------=_Part_54_16191831.1252564510371

Content-Type: text/html

Content-Transfer-Encoding: binary

Content-Id: <report>

<html>

<tr>

</tr>

</tr>

</tr>

</tr>

<td colspan="18" style="text-align: center;">Customer Account Balance</td>

</tr>

</tr>

</tr>

</tr>

<td colspan="2" style="background-color: #999999; ">Branch Code</td>

<td style="background-color: #999999; ">Branch Name</td>

<td colspan="2" style="background-color: #999999; ">Customer </td>

<td colspan="4" style="background-color: #999999; ">Account </td>

<td style="background-color: #999999; ">Customer </td>

<td style="background-color: #999999; ">Currency</td>

<td colspan="4" style="background-color: #999999; ">Account Class</td>

<td colspan="3" style="background-color: #999999; ">Description</td>

<td colspan="3" style="background-color: #999999; ">Local Currency </td>

<td colspan="6" style="background-color: #999999; ">Account Curr Avail Balance</td>

</tr>

<td>EBN LAGOS - SURULERE</td>

<td colspan="4">AGWU - IBIAM</td>

<td colspan="4">SAIND</td>

<td colspan="3">SAVINGS </td>

</tr>

</tr>

</tr>

</tr>

</table>

</td><td width="50%"> </td></tr>

</table>

</body>

</html>

------=_Part_54_16191831.1252564510371--

ddaly · October 6, 2009

Have you got any further with using ZSI to run a report?

It seems that the problem with using ZSI is that the response from runReport is multipart.

I am working on a patch for ZSI's client.py which would allow it to receive the multipart response from jasperserver.

Daryl.

marco159 · November 8, 2010

Have you created the patch for ZSI?
I need to read a multipart/related response and with standard ZSI it's not possible ...

Thanks

ddaly · November 8, 2010

Here is my customized client.py. It is based on ZSI svn source revision 1495. There is not much to my change. The ReceiveSOAP parses out the multi-part payloads then Receive returns the payloads. There is an API change because Receive either returns the normal reply or, if there are additional payloads, the normal reply plus the payloads. Because of this, it may break other usages of this routine.

Sign In

Scheduling a JasperServer Report via SOAP & Python

Recommended Posts

cialowicz

Link to comment

Share on other sites

Top Posters In This Topic

Popular Days

Top Posters In This Topic

Popular Days

cialowicz

Link to comment

Share on other sites

jmario

Link to comment

Share on other sites

cialowicz

Link to comment

Share on other sites

lucianc

Link to comment

Share on other sites

amosunfemi

Link to comment

Share on other sites

ddaly

Link to comment

Share on other sites

marco159

Link to comment

Share on other sites

ddaly

Link to comment

Share on other sites

Create an account or sign in to comment

Create an account

Sign in

Activity

Products

Explore