Dynamic parametes from application.

Hi All,

I have integrated the birtreports with java application. Currently I am selecting the report generation criteria
from a jsp and then building the URL based on the criteria selected to generate the report. ie passing the already known parameters dynamically.

My current requirement is to build my jsp based on the already designed report(example.rptdesign)

I need to access those parameters in example.jsp from the application which is built in Java(JSF) ,

Ie : I have 2 reports viz report1.rptdesign
and report2.rptdesign

On click of report1 I should read the selection parameters from report1 and display in example.jsp
if report1.rptdesign has 2 selection criteria : Employee Name and Age , This must only be displayed.
if report2.rptdesign had 1 selection criteria : Salary , This must only be displayed.

Can anyone help me in this !! this is my ID dhruva.vasudevarao@arisglobal.co.in
Its urgent.!!!!!

Find more posts tagged with

Comments

JasonW

Can you write a servlet and add it to your app? Here is a generic command line class that iterates all the parameter information for a report:

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.logging.Level;

import org.eclipse.birt.core.framework.Platform;
import org.eclipse.birt.report.engine.api.EngineConfig;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask;
import org.eclipse.birt.report.engine.api.IParameterDefnBase;
import org.eclipse.birt.report.engine.api.IParameterGroupDefn;
import org.eclipse.birt.report.engine.api.IParameterSelectionChoice;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportEngineFactory;
import org.eclipse.birt.report.engine.api.IReportRunnable;
import org.eclipse.birt.report.engine.api.IScalarParameterDefn;
import org.eclipse.birt.report.model.api.CascadingParameterGroupHandle;
import org.eclipse.birt.report.model.api.ScalarParameterHandle;

public class ReportParameters {

@SuppressWarnings("unchecked")
static void executeReport() throws EngineException
{
HashMap parmDetails = new HashMap();
IReportEngine engine=null;
EngineConfig config = null;
try{

config = new EngineConfig( );
config.setBIRTHome("C:\\birt\\birt-runtime-2_6_2\\birt-runtime-2_6_2\\ReportEngine");
config.setLogConfig(null, Level.OFF);
Platform.startup( config );
IReportEngineFactory factory = (IReportEngineFactory) Platform
.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
engine = factory.createReportEngine( config );
}catch( Exception ex){
ex.printStackTrace();
}

//Open a report design
IReportRunnable design = engine.openReportDesign("reports/parameters.rptdesign");

IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( design );
Collection params = task.getParameterDefns( true );

//task.getSelectionListForCascadingGroup();
Iterator iter = params.iterator( );
while ( iter.hasNext( ) )
{
IParameterDefnBase param = (IParameterDefnBase) iter.next( );

if ( param instanceof IParameterGroupDefn )
{
IParameterGroupDefn group = (IParameterGroupDefn) param;
System.out.println( "Parameter Group: " + group.getName( ) );

// Do something with the parameter group.
// Iterate over group contents.

Iterator i2 = group.getContents( ).iterator( );
while ( i2.hasNext( ) )
{
IScalarParameterDefn scalar = (IScalarParameterDefn) i2.next( );
//System.out.println("\t" + scalar.getName());
parmDetails.put( scalar.getName(), loadParameterDetails( task, scalar, design, group));
}

}
else
{

IScalarParameterDefn scalar = (IScalarParameterDefn) param;
//System.out.println(param.getName());
parmDetails.put( scalar.getName(),loadParameterDetails( task, scalar, design, null));

}
}

task.close();
engine.destroy();
Platform.shutdown();
System.out.println("Finished");
}

private static HashMap loadParameterDetails(IGetParameterDefinitionTask task, IScalarParameterDefn scalar, IReportRunnable report, IParameterGroupDefn group){

HashMap parameter = new HashMap();

if( group == null){
parameter.put("Parameter Group", "Default");
}else{
parameter.put("Parameter Group", group.getName());
}
parameter.put("Name", scalar.getName());
parameter.put("Help Text", scalar.getHelpText());
parameter.put("Display Name", scalar.getDisplayName());
//this is a format code such as > for UPPERCASE
parameter.put("Display Format", scalar.getDisplayFormat());

if( scalar.isHidden() ){
parameter.put("Hidden", "Yes");
}else{
parameter.put("Hidden", "No");
}
if( scalar.isHidden() ){
parameter.put("Hidden", "Yes");
}else{
parameter.put("Hidded", "No");
}
if( scalar.isRequired() ){
parameter.put("Is Required", "Yes");
}else{
parameter.put("Is Required", "No");
}
if( scalar.isValueConcealed() ){
parameter.put("Conceal Entry", "Yes"); //ie passwords etc
}else{
parameter.put("Conceal Entry", "No");
}

switch (scalar.getControlType()) {
case IScalarParameterDefn.TEXT_BOX: parameter.put("Type", "Text Box"); break;
case IScalarParameterDefn.LIST_BOX: parameter.put("Type", "List Box"); break;
case IScalarParameterDefn.RADIO_BUTTON: parameter.put("Type", "List Box"); break;
case IScalarParameterDefn.CHECK_BOX: parameter.put("Type", "List Box"); break;
default: parameter.put("Type", "Text Box");break;
}

switch (scalar.getDataType()) {
case IScalarParameterDefn.TYPE_STRING: parameter.put("Data Type", "String"); break;
case IScalarParameterDefn.TYPE_FLOAT: parameter.put("Data Type", "Float"); break;
case IScalarParameterDefn.TYPE_DECIMAL: parameter.put("Data Type", "Decimal"); break;
case IScalarParameterDefn.TYPE_DATE_TIME: parameter.put("Data Type", "Date Time"); break;
case IScalarParameterDefn.TYPE_BOOLEAN: parameter.put("Data Type", "Boolean"); break;
default: parameter.put("Data Type", "Any"); break;
}

ScalarParameterHandle parameterHandle = ( ScalarParameterHandle ) scalar.getHandle();

parameter.put("Default Value", scalar.getDefaultValue());
parameter.put("Prompt Text", scalar.getPromptText());
parameter.put("Data Set Expression", parameterHandle.getValueExpr());

if(scalar.getControlType() != IScalarParameterDefn.TEXT_BOX)
{
//System.out.println("dynamic parameter");

if ( parameterHandle.getContainer( ) instanceof CascadingParameterGroupHandle ){
Collection sList = Collections.EMPTY_LIST;
if ( parameterHandle.getContainer( ) instanceof CascadingParameterGroupHandle )
{

String groupName = parameterHandle.getContainer( ).getName( );
//used for Cascading parms see IGetParameterDefinitionTask.java code for comments
//task.evaluateQuery( groupName );

//Need to load this for calls to get next level.
//This just gets the first level
Object [] keyValueTmp = new Object[1];
sList = task.getSelectionListForCascadingGroup( groupName, keyValueTmp );

for ( Iterator sl = sList.iterator( ); sl.hasNext( ); )
{
IParameterSelectionChoice sI = (IParameterSelectionChoice) sl.next( );

Object value = sI.getValue( );
Object label = sI.getLabel( );
System.out.println( label + "--" + value);

}

}
}else{
Collection selectionList = task.getSelectionList( scalar.getName() );

if ( selectionList != null )
{
HashMap dynamicList = new HashMap();

for ( Iterator sliter = selectionList.iterator( ); sliter.hasNext( ); )
{
IParameterSelectionChoice selectionItem = (IParameterSelectionChoice) sliter.next( );

Object value = selectionItem.getValue( );
String label = selectionItem.getLabel( );

//System.out.println( label + "--" + value);
//Display label unless null then display value. Value is the what should get passed to the report.
dynamicList.put(value,label);

}
parameter.put("Selection List", dynamicList);
}
}

}

Iterator iter = parameter.keySet().iterator();
System.out.println("======================Parameter =" + scalar.getName());
while (iter.hasNext()) {
String name = (String) iter.next();
if( name.equals("Selection List")){
HashMap selList = (HashMap)parameter.get(name);
Iterator selIter = selList.keySet().iterator();
while (selIter.hasNext()) {
Object lbl = selIter.next();
System.out.println( "Selection List Entry ===== Key = " + lbl + " Value = " + selList.get(lbl));
}

}else{
System.out.println( name + " = " + parameter.get(name));
}
}
return parameter;

}

/**
* @param args
*/
public static void main(String[] args) {
try
{
executeReport( );
}
catch ( Exception e )
{
e.printStackTrace();
}
}

}

Jason

dhruvavrao

<blockquote class='ipsBlockquote' data-author="'JasonW'" data-cid="81059" data-time="1312388580" data-date="03 August 2011 - 09:23 AM">
Can you write a servlet and add it to your app? Here is a generic command line class that iterates all the parameter information for a report: 
 
 
 
 
 
import java.util.Collection; 
import java.util.Collections; 
import java.util.HashMap; 
import java.util.Iterator; 
import java.util.logging.Level; 
 
import org.eclipse.birt.core.framework.Platform; 
import org.eclipse.birt.report.engine.api.EngineConfig; 
import org.eclipse.birt.report.engine.api.EngineException; 
import org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask; 
import org.eclipse.birt.report.engine.api.IParameterDefnBase; 
import org.eclipse.birt.report.engine.api.IParameterGroupDefn; 
import org.eclipse.birt.report.engine.api.IParameterSelectionChoice; 
import org.eclipse.birt.report.engine.api.IReportEngine; 
import org.eclipse.birt.report.engine.api.IReportEngineFactory; 
import org.eclipse.birt.report.engine.api.IReportRunnable; 
import org.eclipse.birt.report.engine.api.IScalarParameterDefn; 
import org.eclipse.birt.report.model.api.CascadingParameterGroupHandle; 
import org.eclipse.birt.report.model.api.ScalarParameterHandle; 
 
public class ReportParameters { 
 
@SuppressWarnings("unchecked") 
static void executeReport() throws EngineException 
{ 
HashMap parmDetails = new HashMap(); 
IReportEngine engine=null; 
EngineConfig config = null; 
try{ 
 
config = new EngineConfig( ); 
config.setBIRTHome("C:\\birt\\birt-runtime-2_6_2\\birt-runtime-2_6_2\\ReportEngine"); 
config.setLogConfig(null, Level.OFF); 
Platform.startup( config ); 
IReportEngineFactory factory = (IReportEngineFactory) Platform 
.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY ); 
engine = factory.createReportEngine( config ); 
}catch( Exception ex){ 
ex.printStackTrace(); 
} 
 
 
//Open a report design 
IReportRunnable design = engine.openReportDesign("reports/parameters.rptdesign"); 
 
IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( design ); 
Collection params = task.getParameterDefns( true ); 
 
 
//task.getSelectionListForCascadingGroup(); 
Iterator iter = params.iterator( ); 
while ( iter.hasNext( ) ) 
{ 
IParameterDefnBase param = (IParameterDefnBase) iter.next( ); 
 
if ( param instanceof IParameterGroupDefn ) 
{ 
IParameterGroupDefn group = (IParameterGroupDefn) param; 
System.out.println( "Parameter Group: " + group.getName( ) ); 
 
 
// Do something with the parameter group. 
// Iterate over group contents. 
 
Iterator i2 = group.getContents( ).iterator( ); 
while ( i2.hasNext( ) ) 
{ 
IScalarParameterDefn scalar = (IScalarParameterDefn) i2.next( ); 
//System.out.println("\t" + scalar.getName()); 
parmDetails.put( scalar.getName(), loadParameterDetails( task, scalar, design, group)); 
} 
 
} 
else 
{ 
 
IScalarParameterDefn scalar = (IScalarParameterDefn) param; 
//System.out.println(param.getName()); 
parmDetails.put( scalar.getName(),loadParameterDetails( task, scalar, design, null)); 
 
 
} 
} 
 
task.close(); 
engine.destroy(); 
Platform.shutdown(); 
System.out.println("Finished"); 
} 
 
private static HashMap loadParameterDetails(IGetParameterDefinitionTask task, IScalarParameterDefn scalar, IReportRunnable report, IParameterGroupDefn group){ 
 
 
 
HashMap parameter = new HashMap(); 
 
if( group == null){ 
parameter.put("Parameter Group", "Default"); 
}else{ 
parameter.put("Parameter Group", group.getName()); 
} 
parameter.put("Name", scalar.getName()); 
parameter.put("Help Text", scalar.getHelpText()); 
parameter.put("Display Name", scalar.getDisplayName()); 
//this is a format code such as > for UPPERCASE 
parameter.put("Display Format", scalar.getDisplayFormat()); 
 
if( scalar.isHidden() ){ 
parameter.put("Hidden", "Yes"); 
}else{ 
parameter.put("Hidden", "No"); 
} 
if( scalar.isHidden() ){ 
parameter.put("Hidden", "Yes"); 
}else{ 
parameter.put("Hidded", "No"); 
} 
if( scalar.isRequired() ){ 
parameter.put("Is Required", "Yes"); 
}else{ 
parameter.put("Is Required", "No"); 
} 
if( scalar.isValueConcealed() ){ 
parameter.put("Conceal Entry", "Yes"); //ie passwords etc 
}else{ 
parameter.put("Conceal Entry", "No"); 
} 
 
 
switch (scalar.getControlType()) { 
case IScalarParameterDefn.TEXT_BOX: parameter.put("Type", "Text Box"); break; 
case IScalarParameterDefn.LIST_BOX: parameter.put("Type", "List Box"); break; 
case IScalarParameterDefn.RADIO_BUTTON: parameter.put("Type", "List Box"); break; 
case IScalarParameterDefn.CHECK_BOX: parameter.put("Type", "List Box"); break; 
default: parameter.put("Type", "Text Box");break; 
} 
 
 
switch (scalar.getDataType()) { 
case IScalarParameterDefn.TYPE_STRING: parameter.put("Data Type", "String"); break; 
case IScalarParameterDefn.TYPE_FLOAT: parameter.put("Data Type", "Float"); break; 
case IScalarParameterDefn.TYPE_DECIMAL: parameter.put("Data Type", "Decimal"); break; 
case IScalarParameterDefn.TYPE_DATE_TIME: parameter.put("Data Type", "Date Time"); break; 
case IScalarParameterDefn.TYPE_BOOLEAN: parameter.put("Data Type", "Boolean"); break; 
default: parameter.put("Data Type", "Any"); break; 
} 
 
 
ScalarParameterHandle parameterHandle = ( ScalarParameterHandle ) scalar.getHandle(); 
 
parameter.put("Default Value", scalar.getDefaultValue()); 
parameter.put("Prompt Text", scalar.getPromptText()); 
parameter.put("Data Set Expression", parameterHandle.getValueExpr()); 
 
if(scalar.getControlType() != IScalarParameterDefn.TEXT_BOX) 
{ 
//System.out.println("dynamic parameter"); 
 
if ( parameterHandle.getContainer( ) instanceof CascadingParameterGroupHandle ){ 
Collection sList = Collections.EMPTY_LIST; 
if ( parameterHandle.getContainer( ) instanceof CascadingParameterGroupHandle ) 
{ 
 
String groupName = parameterHandle.getContainer( ).getName( ); 
//used for Cascading parms see IGetParameterDefinitionTask.java code for comments 
//task.evaluateQuery( groupName ); 
 
//Need to load this for calls to get next level. 
//This just gets the first level 
Object [] keyValueTmp = new Object[1]; 
sList = task.getSelectionListForCascadingGroup( groupName, keyValueTmp ); 
 
 
for ( Iterator sl = sList.iterator( ); sl.hasNext( ); ) 
{ 
IParameterSelectionChoice sI = (IParameterSelectionChoice) sl.next( ); 
 
 
Object value = sI.getValue( ); 
Object label = sI.getLabel( ); 
System.out.println( label + "--" + value); 
 
} 
 
} 
}else{ 
Collection selectionList = task.getSelectionList( scalar.getName() ); 
 
if ( selectionList != null ) 
{ 
HashMap dynamicList = new HashMap(); 
 
for ( Iterator sliter = selectionList.iterator( ); sliter.hasNext( ); ) 
{ 
IParameterSelectionChoice selectionItem = (IParameterSelectionChoice) sliter.next( ); 
 
Object value = selectionItem.getValue( ); 
String label = selectionItem.getLabel( ); 
 
//System.out.println( label + "--" + value); 
//Display label unless null then display value. Value is the what should get passed to the report. 
dynamicList.put(value,label); 
 
} 
parameter.put("Selection List", dynamicList); 
} 
} 
 
} 
 
 
 
Iterator iter = parameter.keySet().iterator(); 
System.out.println("======================Parameter =" + scalar.getName()); 
while (iter.hasNext()) { 
String name = (String) iter.next(); 
if( name.equals("Selection List")){ 
HashMap selList = (HashMap)parameter.get(name); 
Iterator selIter = selList.keySet().iterator(); 
while (selIter.hasNext()) { 
Object lbl = selIter.next(); 
System.out.println( "Selection List Entry ===== Key = " + lbl + " Value = " + selList.get(lbl)); 
} 
 
}else{ 
System.out.println( name + " = " + parameter.get(name)); 
} 
} 
return parameter; 
 
} 
 
/** 
* @param args 
*/ 
public static void main(String[] args) { 
try 
{ 
executeReport( ); 
} 
catch ( Exception e ) 
{ 
e.printStackTrace(); 
} 
} 
 
} 
 
Jason </blockquote>
 
 
 
 
Thanks JasonW

Will try it and let you all know on my success

dhruvavrao

<blockquote class='ipsBlockquote' data-author="'dhruvavrao'" data-cid="81077" data-time="1312433379" data-date="03 August 2011 - 09:49 PM">
Thanks JasonW

Will try it and let you all know on my success

</blockquote>
 
 
Can you help me download the required API's for this??

Datta

can anyone send me a one simple complete project regarding the above post!! pls !! its urgent

Thanks in advance

JasonW

Create a new workspace in eclipse and import the project in the attached zip file.
Update the build path to the location of your runtime download and set birt home in the code (Unless you are using 3.7).

Jason

Datta

<blockquote class='ipsBlockquote' data-author="'JasonW'" data-cid="81111" data-time="1312472892" data-date="04 August 2011 - 08:48 AM">
Create a new workspace in eclipse and import the project in the attached zip file. 
Update the build path to the location of your runtime download and set birt home in the code (Unless you are using 3.7). 
 
Jason </blockquote>
Thankz alot Jason.I will follow the steps and let u know aboout how it worked:) 
Thank you, 
Datta