nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Error Running Drill-Through Report

bmac

I am attempting to run and render a drill-through, master-detail report from a java application.
In the report designer everything works fine. The hyperlink options are set to produce PDF output.
When the report is run the master displays properly in Adobe Reader, but when I click the link to run the detail report the following error appears:

Firefox can't find the file at /c:/ddt/reports/ingres/run?__report=c:/DDT/reports/BIRT/TriggerDef.rptdesign&TriggerName=[ddt_symbol_rename]&__overwrite=true.

The directory "c:/ddt/reports/ingres" is the output directory for my reports, not the location for the rptdesign files. Everything else on the line is correct. Hovering over the link in the master report display shows "file:///c|/ddt/reports/ingres/run?..." I don't understand what BIRT is trying to do.

Please explain what is happening.

Thanks,
Bmac

Find more posts tagged with

Comments

JasonW

Do you have the viewer deployed or are you only using the RE API?

Jason

bmac

Just the RE API, I think. I am experimenting and learning so things may not be set up properly. 
 
Bmac 
 
<blockquote class='ipsBlockquote' data-author="'JasonW'" data-cid="73966" data-time="1298653014" data-date="25 February 2011 - 09:56 AM">
Do you have the viewer deployed or are you only using the RE API? 
 
Jason </blockquote>

JasonW

If you are just using the API you have to handle the drill throughs yourself. By default it is trying to run the report with the viewer, hence the /run. The links are built by the default impelmentation of the IHTMLActionHandler interface. You can build your own and then set it in the render options like: 
 
HTMLRenderOption options = new HTMLRenderOption(); 
options.setOutputFileName("output/resample/master.html"); 
options.setOutputFormat("html"); 
options.setHtmlRtLFlag(false); 
options.setEnableAgentStyleEngine(true); 
options.setEmbeddable(true); 
options.setBaseURL("<a class='bbc_url' href='http://localhost:8080/birt2.6.1/frameset'>http://localhost:8080/birt2.6.1/frameset"</a>); 
//options.setActionHandler(new HTMLActionHandler()); 
options.setActionHandler(new MyActionHandler()); 
 
In this example it is calling the viewer deployed on Tomcat to run the detail report. MyActionHandler code builds the drill hyperlink: 
 
package REAPI; 
import java.io.File; 
import java.io.UnsupportedEncodingException; 
import java.net.MalformedURLException; 
import java.net.URL; 
import java.net.URLEncoder; 
import java.util.Iterator; 
import java.util.List; 
import java.util.Map; 
import java.util.logging.Logger; 
 
import org.eclipse.birt.report.engine.api.EngineConstants; 
import org.eclipse.birt.report.engine.api.HTMLActionHandler; 
import org.eclipse.birt.report.engine.api.HTMLRenderContext; 
import org.eclipse.birt.report.engine.api.IAction; 
import org.eclipse.birt.report.engine.api.IHTMLActionHandler; 
import org.eclipse.birt.report.engine.api.PDFRenderContext; 
import org.eclipse.birt.report.engine.api.script.IReportContext; 
import org.eclipse.birt.report.model.api.util.ParameterValidationUtil; 
 
import com.ibm.icu.math.BigDecimal; 
 
/** 
* Defines a default action handler for HTML output format 
*/ 
public class MyActionHandler implements IHTMLActionHandler 
{ 
 
/** logger */ 
protected Logger log = Logger 
.getLogger( HTMLActionHandler.class.getName( ) ); 
 
/** 
* Get URL of the action. 
* 
* @param actionDefn 
* @param context 
* @return URL 
*/ 
public String getURL( IAction actionDefn, IReportContext context ) 
{ 
Object renderContext = getRenderContext( context ); 
return getURL( actionDefn, renderContext ); 
} 
 
/* 
* (non-Javadoc) 
* 
* @see org.eclipse.birt.report.engine.api2.IHTMLActionHandler#getURL(org.eclipse.birt.report.engine.api2.IAction, 
* java.lang.Object) 
*/ 
public String getURL( IAction actionDefn, Object context ) 
{ 
if ( actionDefn == null ) 
{ 
return null; 
} 
String url = null; 
switch ( actionDefn.getType( ) ) 
{ 
case IAction.ACTION_BOOKMARK : 
if ( actionDefn.getActionString( ) != null ) 
{ 
url = "#" + actionDefn.getActionString( ); 
} 
break; 
case IAction.ACTION_HYPERLINK : 
url = actionDefn.getActionString( ); 
break; 
case IAction.ACTION_DRILLTHROUGH : 
url = buildDrillAction( actionDefn, context ); 
break; 
default : 
return null; 
} 
return url; 
} 
 
/** 
* builds URL for drillthrough action 
* 
* @param action 
* instance of the IAction instance 
* @param context 
* the context for building the action string 
* @return a URL 
*/ 
protected String buildDrillAction( IAction action, Object context ) 
{ 
String baseURL = null; 
if ( context != null ) 
{ 
if ( context instanceof HTMLRenderContext ) 
{ 
baseURL = ( (HTMLRenderContext) context ).getBaseURL( ); 
} 
if ( context instanceof PDFRenderContext ) 
{ 
baseURL = ( (PDFRenderContext) context ).getBaseURL( ); 
} 
} 
 
if ( baseURL == null ) 
{ 
baseURL = "run"; 
} 
StringBuffer link = new StringBuffer( ); 
String reportName = getReportName( action ); 
 
if ( reportName != null && !reportName.equals( "" ) ) //$NON-NLS-1$ 
{ 
String format = action.getFormat( ); 
if ( !"html".equalsIgnoreCase( format ) ) 
{ 
link.append( baseURL.replaceFirst( "frameset", "run" ) ); //$NON-NLS-1$ //$NON-NLS-2$ 
} 
else 
{ 
link.append( baseURL ); 
} 
 
link 
.append( reportName.toLowerCase( ) 
.endsWith( ".rptdocument" ) ? "?__document=" : "?__report=" ); //$NON-NLS-1$ //$NON-NLS-1$ //$NON-NLS-1$ 
 
try 
{ 
link.append( URLEncoder.encode( reportName, "UTF-8" ) ); //$NON-NLS-1$ 
} 
catch ( UnsupportedEncodingException e1 ) 
{ 
// It should not happen. Does nothing 
} 
 
// add format support 
if ( format != null && format.length( ) > 0 ) 
{ 
link.append( "&__format=" + format ); //$NON-NLS-1$ 
} 
 
// Adds the parameters 
if ( action.getParameterBindings( ) != null ) 
{ 
Iterator paramsIte = action.getParameterBindings( ).entrySet( ) 
.iterator( ); 
while ( paramsIte.hasNext( ) ) 
{ 
Map.Entry entry = (Map.Entry) paramsIte.next( ); 
try 
{ 
String key = (String) entry.getKey( ); 
Object valueObj = entry.getValue( ); 
 
 
if ( valueObj != null ) 
{ 
if ( valueObj instanceof List ) 
{ 
if ( ( (List) valueObj ).size( ) == 1 ) 
{ 
valueObj = ( (List) valueObj ).get( 0 ); 
} 
else 
{ 
valueObj = ( (List) valueObj ).toArray( ); 
} 
} 
 
Object[] values; 
if ( valueObj instanceof Object[] ) 
{ 
values = (Object[]) valueObj; 
} 
else 
{ 
values = new Object[1]; 
values[0] = valueObj; 
} 
 
for ( int i = 0; i < values.length; i++ ) 
{ 
// TODO: here need the get the format from the 
// parameter. 
String value = getDisplayValue( values); 
 
if ( value != null ) 
{ 
link 
.append( "&" + URLEncoder.encode( key, "UTF-8" ) 
+ "=" + URLEncoder.encode( value, "UTF-8" ) ); 
} 
 
} 
} 
 
} 
catch ( UnsupportedEncodingException e ) 
{ 
// Does nothing 
} 
} 
} 
 
// Adding overwrite. 
link.append( "&__overwrite=true" ); //$NON-NLS-1$ 
 
// The search rules are not supported yet. 
if ( /* 
* !"pdf".equalsIgnoreCase( format ) && 
*/action.getBookmark( ) != null ) 
{ 
 
try 
{ 
// In RUN mode, don't support bookmark as parameter 
if ( baseURL.lastIndexOf( "run" ) > 0 ) 
{ 
link.append( "#" ); //$NON-NLS-1$ 
} 
else 
{ 
link.append( "&__bookmark=" ); //$NON-NLS-1$ 
} 
 
link.append( URLEncoder.encode( action.getBookmark( ), 
"UTF-8" ) ); //$NON-NLS-1$ 
} 
catch ( UnsupportedEncodingException e ) 
{ 
// Does nothing 
} 
} 
} 
 
return link.toString( ); 
} 
 
/** 
* Append report design name into a StringBuffer. 
* 
* @param buffer 
* @param reportName 
*/ 
protected void appendReportDesignName( StringBuffer buffer, 
String reportName ) 
{ 
buffer.append( "?__report=" ); //$NON-NLS-1$ 
try 
{ 
buffer.append( URLEncoder.encode( reportName, "UTF-8" ) ); //$NON-NLS-1$ 
} 
catch ( UnsupportedEncodingException e1 ) 
{ 
// It should not happen. Does nothing 
} 
} 
 
/** 
* Append format. 
* 
* @param buffer 
* @param format 
*/ 
protected void appendFormat( StringBuffer buffer, String format ) 
{ 
if ( format != null && format.length( ) > 0 ) 
{ 
buffer.append( "&__format=" + format );//$NON-NLS-1$ 
} 
} 
 
/** 
* Append parameter. 
* 
* @param buffer 
* @param key 
* @param valueObj 
*/ 
protected void appendParamter( StringBuffer buffer, String key, 
Object valueObj ) 
{ 
if ( valueObj != null ) 
{ 
try 
{ 
key = URLEncoder.encode( key, "UTF-8" ); 
String value = valueObj.toString( ); 
value = URLEncoder.encode( value, "UTF-8" ); 
buffer.append( "&" ); 
buffer.append( key ); 
buffer.append( "=" ); 
buffer.append( value ); 
} 
catch ( UnsupportedEncodingException e ) 
{ 
// Does nothing 
} 
} 
} 
 
/** 
* Append bookmark as parameter . 
* 
* @param buffer 
* @param bookmark 
*/ 
protected void appendBookmarkAsParamter( StringBuffer buffer, 
String bookmark ) 
{ 
try 
{ 
if ( bookmark != null && bookmark.length( ) != 0 ) 
{ 
bookmark = URLEncoder.encode( bookmark, "UTF-8" ); 
buffer.append( "&__bookmark=" );//$NON-NLS-1$ 
buffer.append( bookmark ); 
} 
} 
catch ( UnsupportedEncodingException e ) 
{ 
 
} 
} 
 
/** 
* Append bookmark. 
* 
* @param buffer 
* @param bookmark 
*/ 
protected void appendBookmark( StringBuffer buffer, String bookmark ) 
{ 
try 
{ 
if ( bookmark != null && bookmark.length( ) != 0 ) 
{ 
bookmark = URLEncoder.encode( bookmark, "UTF-8" ); 
buffer.append( "#" );//$NON-NLS-1$ 
buffer.append( bookmark ); 
} 
} 
catch ( UnsupportedEncodingException e ) 
{ 
} 
} 
 
/** 
* Get report name. 
* 
* @param action 
* @return 
*/ 
String getReportName( IAction action ) 
{ 
String systemId = action.getSystemId( ); 
String reportName = action.getReportName( ); 
if ( systemId == null ) 
{ 
return reportName; 
} 
// if the reportName is an URL, use it directly 
try 
{ 
URL url = new URL( reportName ); 
if ( "file".equals( url.getProtocol( ) ) ) 
{ 
return url.getFile( ); 
} 
return url.toExternalForm( ); 
} 
catch ( MalformedURLException ex ) 
{ 
} 
// if the system id is the URL, merget the report name with it 
try 
{ 
URL root = new URL( systemId ); 
URL url = new URL( root, reportName ); 
if ( "file".equals( url.getProtocol( ) ) ) 
{ 
return url.getFile( ); 
} 
return url.toExternalForm( ); 
} 
catch ( MalformedURLException ex ) 
{ 
 
} 
// now the root should be a file and the report name is a file also 
File file = new File( reportName ); 
if ( file.isAbsolute( ) ) 
{ 
return reportName; 
} 
 
try 
{ 
URL root = new File( systemId ).toURL( ); 
URL url = new URL( root, reportName ); 
assert "file".equals( url.getProtocol( ) ); 
return url.getFile( ); 
} 
catch ( MalformedURLException ex ) 
{ 
} 
return reportName; 
} 
 
/** 
* Get render context. 
* 
* @param context 
* @return 
*/ 
protected Object getRenderContext( IReportContext context ) 
{ 
if ( context == null ) 
{ 
return null; 
} 
Map appContext = context.getAppContext( ); 
if ( appContext != null ) 
{ 
String renderContextKey = EngineConstants.APPCONTEXT_HTML_RENDER_CONTEXT; 
String format = context.getOutputFormat( ); 
if ( "pdf".equalsIgnoreCase( format ) ) 
{ 
renderContextKey = EngineConstants.APPCONTEXT_PDF_RENDER_CONTEXT; 
} 
return appContext.get( renderContextKey ); 
} 
return null; 
} 
 
/** 
* Get display value. 
* 
* @param value 
* @return 
*/ 
String getDisplayValue( Object value ) 
{ 
if ( value == null ) 
return null; 
 
if ( value instanceof Float || value instanceof Double 
|| value instanceof BigDecimal ) 
{ 
return value.toString( ); 
} 
return ParameterValidationUtil.getDisplayValue( value ); 
} 
 
} 
 
Jason

bmac

Jason, 
 
This is helping but has also raised several new questions. 
<ul class='bbc'><li>Does this mean that the detail report must be rendered in HTML or was this only an example?</li><li>Is Tomcat required?</li><li>When setting BaseURL, where is "frameset"? I cannot locate it in my Tomcat directory tree. However, I have only tried a simple demo report in the viewer and may not have it configured properly.</li></ul>
 
That is probably enough for now. 
Thanks for helping, 
Bmac

JasonW

A Java EE server like Tomcat is required if you want to use the BIRT Viewer. The /frameset servlet mapping is used to run and render a report. If you use the viewer the API is not required. See
http://www.eclipse.org/birt/phoenix/deploy/viewerSetup.php
and
http://www.eclipse.org/birt/phoenix/deploy/viewerUsageMain.php

For more details.

Jason

bmac

HI Jason,

The drill-through is working now. The following is a summary of what happened and my current understanding. If I say something wrong, please correct me.

I was trying to run a drill-through master-detail report from a Java application without using a Java EE server (Tomcat) or the birt-viewer. That is not possible. Plain reports, without drill-through, worked fine.

Drill-through will work in the report designer because the designer seems to contain its own viewer and does not need Tomcat.

The application must set the render options baseURL to the birt-viewer/frameset and also provide its own ActionHandler to build the correct hyperlinks into the master report. The code you provided shows how to do this.

To be able to reference rptdesign files with an absolute path, I edited the birt-viewer web.xml file and set WORKING_FOLDER_ACCESS_ONLY parameter to false. There is probably a way to set this parameter dynamically in the application, but I have not looked for that yet.

So, it is running and I am off to the next problem.

Thanks for your help,
Bmac

JasonW

This is essentially correct. You could get drill through to work in a Java app (standalone) if you implemented the action handler to call the java command line though.

Jason