Hiding Data Sets in the BIRT Report Studio

rmurphy
edited February 11, 2022 in Analytics #1
When designing BIRT Templates for use in BIRT Report Studio (the web based designer for BIRT Reports), you sometimes need access to a data set for parameter gathering or to display other pieces of data within the template. In these instances, many times you do not want the BIRT Report Studio user to be allowed to use this data to design their reports.<br />
To prevent specific data sets from being available to end users, you can apply a "user-property" to the data set that will tell BIRT Report Studio not to allow users to use data from this data source. This is done by adding the following XML to the report template's XML Source.<br />
<br />
< oda-data-set extensionID="org.eclipse.birt.report.data.oda.jdbc.JdbcSelectDataSet" name="ThisDataSetShouldBeHidden" id="291" ><br />
< list-property name="userProperties" ><br />
< structure ><br />
< property name="name" >UsageInBRS< /property ><br />
< property name="type" >string< /property ><br />
< property name="isVisible" >true< /property ><br />
< /structure ><br />
< /list-property ><br />
< property name="UsageInBRS" >excluded< /property ><br />
<br />
For Example, if you have a data set named "CustomerList" that you are using to supply data to a parameter used by the "CustomerOrders" data set, and you only want users to see the "CustomerOrders" data set, you can open the XML source of the report template and search for the CustomerList data set. When found insert the XML code as shown here:<br />
<br />
Before:<br />
< oda-data-set extensionID="org.eclipse.birt.report.data.oda.jdbc.JdbcSelectDataSet" name="CustomerList" id="291" ><br />
< structure name="cachedMetaData" ><br />
< list-property name="resultSet" ><br />
< structure ><br />
< property name="position" >1< /property ><br />
< property name="name" >CUSTOMERNUMBER< /property ><br />
< property name="dataType" >integer< /property ><br />
< /structure ><br />
< structure ><br />
< property name="position" >2< /property ><br />
< property name="name" >CUSTOMERNAME< /property ><br />
...<br />
After:<br />
< oda-data-set extensionID="org.eclipse.birt.report.data.oda.jdbc.JdbcSelectDataSet" name="CustomerList" id="291" ><br />
< list-property name="userProperties" ><br />
< structure ><br />
< property name="name" >UsageInBRS< /property ><br />
< property name="type" >string< /property ><br />
< property name="isVisible" >true< /property ><br />
< /structure ><br />
< /list-property ><br />
< property name="UsageInBRS" >excluded< /property ><br />
< structure name="cachedMetaData" ><br />
< list-property name="resultSet" ><br />
< structure ><br />
< property name="position" >1< /property ><br />
< property name="name" >CUSTOMERNUMBER< /property ><br />
< property name="dataType" >integer< /property ><br />
< /structure ><br />
< structure ><br />
< property name="position" >2< /property ><br />
< property name="name" >CUSTOMERNAME< /property ><br />
...<br />
<br />
The attached sample template was created using the Actuate BIRT Report Designer Professional version 10 (Built on Eclipse BIRT 2.3.2).<br />
<br />
For a high level overview of designing templates for use in the BIRT Report Studio, please refer to the following:<br />
<br />
http://www.birt-exchange.org/devshare/interactive-reporting/359-creating-and-publishing-birt-report-studio-templates/