BIRT Connector Configuration Help

1. Installation

1. Download Latest BIRT “Runtime Release”

(http://download.eclipse.org/birt/downloads/)
2. Unzip to a folder, such as D:\birt-runtime-2_2_0. Give “Full Control” access to
“Everyone”.
3. Load Cordys Eclipse BIRT Integration 1.0.isvp.
4. Add all the jar files present in the folder “D:\birt-runtime-VERSION\ReportEngine\lib” to
the “bcp.classpath” file.
Sample Jar files List:
chartengineapi.jar, chartexamplescoreapi.jar, chartitemapi.jar,
com.ibm.icu_4.2.1.v20100412.jar, commons-cli-1.0.jar, coreapi.jar, crosstabcoreapi.jar,
dataadapterapi.jar, dataaggregationapi.jar, dataextraction.jar, dteapi.jar,
emitterconfig.jar, engineapi.jar, flute.jar, js.jar, modelapi.jar, modelodaapi.jar,
odadesignapi.jar, org.apache.commons.codec_1.3.0.v20100518-1140.jar,
org.eclipse.emf.common_2.6.0.v20100914-1218.jar,
org.eclipse.emf.ecore.xmi_2.5.0.v20100521-1846.jar,
org.eclipse.emf.ecore_2.6.1.v20100914-1218.jar,
org.w3c.css.sac_1.3.0.v200805290154.jar, scriptapi.jar, BIRT.jar,
5. Restart Cordys monitor
2. Service Container Configuration

1. Attach the method set “Method Set BIRT Reports” to BIRT Connector Service Group.
Note: In BOP-4 we need to attach method set manually.
2. Add “CORDYS_INSTALL_DIR/birt/BIRT. Jar” in JRE configuration class path.
3. Create a soap processor for the BIRT Report connector and specify the Report
engine Directory “D:\birt-runtime-VERSION\ReportEngine”in BIRT Run Time
directory Value.
Note: BIRT Run Time directory should contain above jar files in lib folder
4. Specify BIRT Report design files location in BIRT Report Repository.
 5. If you are using JDBC Data Source connection in rptdesign specify related driver jar
files in bcp.classpath.
Ex: sqljdbc.jar required in bcp.classpath in case JDBC Data Source using sql driver in
rptdesign.

3. Generating Report from CORDYS

“GetReport” web service available under BIRT Report Connector.

GetReport Web service SOAP Request:

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Body>
<GetReport SAMLart="" xmlns="http://schemas.cordys.com/BIRT/">
<ReportName>/BirtSpace/employees.rptdesign</ReportName>
<OutputFormat>html</OutputFormat>
<Embeddable>false</Embeddable>
<OutputToFile>true</OutputToFile>
<EncodeFile>true</EncodeFile>
<PARAMS>
<PARAM>
<Name>DEPARTMENT_ID</Name>
<Value>IT</Value>
</PARAM>
<PARAM>
<Name>LOCATION_CODE</Name>
<Value>USA</Value>
</PARAM>
</PARAMS>
</GetReport>
</SOAP:Body>
</SOAP:Envelope>
 Parameter Description Mandatory Default
ReportName 1.rptdesign file path should be available under BIRTReport Repository Yes
directory specified in BIRT Connector Properties Page.
Ex: <ReportName>/BirtSpace/employees.rptdesign </ReportName>
Connector checks “>/BirtSpace/employees.rptdesign” file under “D:\\
BIRT Report Repository”

2. Adding file extension .rptdesign is not mandatory.

SAMLart 1. To Suppress Cordys Login popup while opening Sub Report from No
viewreport.htm.
2. To provide access to BIRT eclipse to invoke Cordys web services.

OutputFormat BIRT Connectors support all types support by BIRT Eclipse. No html
Input Values: xls, pdf, doc, html
Embeddable Whether the report is going to be embedded in another html page No false
or not. If Yes, the response report html will not contain html, body
tags.
Input Values: true/false
OutputToFile Whether the report content has to be in the response or does it No true
need to be stored in a file. When the output format is other than
“html”, the value for this parameter is ignored. Meaning the
output will always be written to a file.
Input Values: true/false
EncodeFile Connector return Bases64 encoded text No false
Input Values: true/false
PARAMS Root tag contains Input PARAM(s) xml tags. No
PARAM Xml tag contains Name and Value xml nodes of Report Parameter No
PARAM/Name Name of the Input Parameter using in rptdesign No
PARAM/Value Value of the Input Parameter using in rptdesign No

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Body>
<GetReport xmlns="http://schemas.cordys.com/BIRT/" SAMLart="">
<ReportName>/BirtSpace/employees.rptdesign</ReportName>
<OutputFormat>html</OutputFormat>
<Embeddable>false</Embeddable>
<OutputToFile>true</OutputToFile>
<EncodeFile>true</EncodeFile>
<PARAMS>
<PARAM>
<Name>DEPARTMENT_ID</Name>
<Value>IT</Value>
</PARAM>
<PARAM>
<Name>LOCATION_CODE</Name>
 <Value>USA</Value>
</PARAM>
</PARAMS>
</GetReport>
</SOAP:Body>
</SOAP:Envelope>

SOAP Response:

Case 1: OutputToFile is false.

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Header>
</SOAP:Header>
<SOAP:Body>
<GetReportResponse xmlns="http://schemas.cordys.com/BIRT/">
<REPORT_CONTENT>
<![CDATA[<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
</html>]]>
</REPORT_CONTENT>
</GetReportResponse>
</SOAP:Body>
</SOAP:Envelope>

The complete HTML report will be available in the REPORT_CONTENT tag.

Case 2: OutputToFile is true

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Header>
</SOAP:Header>
<SOAP:Body>
<GetReportResponse xmlns="http://schemas.cordys.com/BIRT/">
<HyperLink>
<![CDATA[/cordys/birt/reports/reportFiles/1169740114332.pdf]]>
</HyperLink>
<PhysicalLink>
<![CDATA[C:\Program Files\Cordys/web/birt/reports/reportFiles/1169740114332.pdf]]>
</PhysicalLink>
</GetReportResponse>
</SOAP:Body>
</SOAP:Envelope>

You will get both the Hyperlink and physical link to the file in the file system
4. Using Cordys Web Service in rptdesign

We need to provide Soap end point and SAMLart to rptdesign to avoid Authentication problem.
SAMLart: This can be passed from SAMLart attribute
Soap End Point: Connector will prepare SOAP_END_POINT parameter dynamically and passed to
rptdesign as request parameter.
Note: As shown in below image
1. Add SOAP_END_POINT as Input Parameter
2. Do Property binding for Data Source Soap End Point.

5. Report Drill drown feature.

Connector will use SAMLart attribute Value passed by user in GetReport Request to generate sub Report. In
case SAMLart not providing or session was expired then user need to provide Credentials to view Report.

Connector supporting Drill down for html, xls, pdf and doc.