Add custom authentication header to SOAP Webservice

AndrÃ© LuÃs Oliveira · March 18, 2016

I'm using BIRT 4.3.1 and my datasource is a Webservice. Authentication is done by Josso and JOSSOID is available at my report.
I've tried to call this Webservice by SoapUi adding JOSSOID in the header. But I need to know how to do it by BIRT. I use a BIRTEclipse to edit/view the report itself.
I've searched something about WSSE but this protocol needs the username and password and I have just JOSSOID.
How could I add a custom header to this HTTP Request?

Clement Wong · March 18, 2016

Since you have not included your report design or a sample design, I'm assuming that you are using the "Web Services Data Source".
 
When you define your Data Set, in the step where you define the "SOAP Request", you'll have the opportunity to change the SOAP request and add a header, for example. Then, you can select "Edit Parameter..." from the same dialog box to bind these to the appropriate parameter variables.
 
For example, here I'm using the Actuate IDAPI getFolderItems SOAP (reference @ <a data-ipb='nomediaparse' href='http://developer.actuate.com/be/documentation/ihub2-web/iHub/serverapi/using-encyc.06.31.html).'>http://developer.actuate.com/be/documentation/ihub2-web/iHub/serverapi/using-encyc.06.31.html).</a>
 
I have added a <SOAP-ENV:Header> section to the SOAP Request, where I have included two dynamic parameters.
<pre class="_prettyXprint">
<?xml version="1.0"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP-ENV:Header>
 <AuthId>&?authId?&</AuthId>
 <TargetVolume>&?TargetVolume?&</TargetVolume>
 <Locale>en_US</Locale>
 </SOAP-ENV:Header>
 <SOAP-ENV:Body>
 <m:GetFolderItems xmlns:m="http://schemas.actuate.com/actuate11">
 <m:FolderName>&?Folder?&</m:FolderName>
 <m:ResultDef>
 <m:String>Name</m:String>
 <m:String>TimeStamp</m:String>
 <m:String>Description</m:String>
 <m:String>FileType</m:String>
 </m:ResultDef>
 </m:GetFolderItems>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></pre>

gangadhar15 · April 13, 2017

Dear Clement,
 
 I have made it work with web service to get the data and populating in reports. But I am hardcoding the webservice address in report, which is wrong because every time i have change for UAT and Production separately.
 
 Please provide me any example or way how to externalize in webserive address from property file and read it in report.
 
:Thanks in Advance

Clement Wong · April 13, 2017

What Data Source type are you using? Scripted Data Source, or Web Services Data Source?
 
How about use it as a parameter so that when it's in production, you won't need the extra step of reading a file before each execution? It is possible to read a file, but it will require scripting.
 
For Web Services Data Source, first create a parameter, and give it a default value for now of 'UAT'.
 
Then, in the Edit Data Source dialog, click on Property Binding in the left pane.
 
Next, for the SOAP Endpoint, create a new expression like this:
<pre class="_prettyXprint _lang-">
if (params["env"].value == '') 'http://production-endpoint';
else 'http://uat-endpoint';
</pre>

gangadhar15 · June 7, 2017

Dear Clement,
 
 Sorry for the late reply.
 
 I am using Webserive data source and made it work with Profiling. I have first exported the datasource and have that as a base file for property. And copied that property file in the server and made it work.
 
And also the above solution will be not accepted by many customers for security reasons. Because customer while checking the xml of the rptdeisgn they dont want to expose the webserive address in the rptdesign.
 
 
 
Thank you for the help.

Add custom authentication header to SOAP Webservice

Comments

Categories