BI Beans Quick Reference

Oracle Corporation provides downloadable tutorials and samples to help you learn how to develop business intelligence applications using BI Beans. Tutorials walk you through the entire development process, step by step, while samples explore a particular functional area in greater detail or demonstrate more complex coding situations.

The following sections show which samples, tutorials or help topics you should refer to learn how to perform various programming tasks with BI Beans.

Calculation
Catalog
Connection
Crosstab
Frame
Graph
Integration with Oracle Portal
Presentation
Query
Querybuilder
Servlet
Integration with Apache Struts

Calculation

1. How do I create a calculation using the Calcbuilder wizard and add it to a query?

• Refer to the BICalc.runCalcBuilder method in the Creating Calculations Java Client sample

2. How do I create a calculation programmatically and add it to a query?

• Refer to the BICalc.insertYearAgo method in the Creating Calculations Java Client sample

Catalog

1. How do I copy objects from the local catalog to the remote Catalog?

• Refer to the steps illustrated in the Using the Local and Remote BI Beans Catalog sample

2. How do I create users and groups in the Catalog?

• Refer to the commands used in the Using the Local and Remote BI Beans Catalog sample

3. How do I apply object access rights to users and groups in the Catalog?

• Refer to how the BI Explorer is used in the Using the Local and Remote BI Beans Catalog sample

4. How do I create folders in the Catalog programmatically?

• Refer to the BICatalog.createFolderStructures method in the Applying BI Beans Catalog Features Java Client sample

5. How do I create a JTree displaying the objects in the Catalog?

• Refer to the BIMetadata.createMetadataTree method in the Retrieving Metadata from Oracle9i OLAP and the BI Beans Catalog Java Client sample

6. How do I use a PersistenceObjectChooser panel to allow user to select an object in the Catalog?

• Refer to the BICatalog.openObjectChooser method in the Applying BI Beans Catalog Features Java Client sample

7. How do I retrieve associated information with objects in the Catalog (e.g. hierarchy associated with each dimension)?

• Refer to the BIMetadata.getChildren, BIMetadata.handleRadioButtonEvent methods in the Retrieving Metadata from Oracle9i OLAP and the BI Beans Catalog Java Client sample

8. How do I retreive object properties from the Catalog?

• Refer to the BIMetadata.showProperties method in thewser.html">Retrieving Metadata from Oracle9i OLAP and the BI Beans Catalog Java Client sample

9. How do I export the entire Catalog contents into a XML file?

• Refer to the BICatalog.exportCatalog method in the Applying BI Beans Catalog Features Java Client sample

10. How do I programmatically import or export objects between Catalogs (whether file-based or database)?

• Refer to the BIImportExport.mnuImport_ActionPerformed, BIImportExport.mnuExport_ActionPerformed methods in the Importing and Exporting Objects Between Catalogs Java Client sample

11. How do I integrate the BI Explorer with an application?

• Refer to the BICatalog.showExplorer method in the Applying BI Beans Catalog Features Java Client sample

12. How do I store custom application settings in the Catalog ?

• Refer to the ApplicationSettings class in the Applying BI Beans Catalog Features Java Client sample

13. How do I cache presentations with data in the Catalog?

• Refer to the CacheUpdate class in the Portal Integration HTML Client sample

14. How do I synchronize the Catalog with users and groups in a LDAP server?

• Refer to the steps illustrated in the BI User Community Synchronization with LDAP sample

15. How do I synchronize the Catalog with users and groups in a RDBMS?

• Refer to the steps illustrated in the BI User Community Synchronization with RDBMS sample

Connection

1. How do I connect to the OLAP Catalog based on an XML configuration file?

• For Java client applications, Refer to the BIFrame.connect method in the Connecting to Oracle9i OLAP and BI Beans Catalog Java Client sample
• For HTML client applications, looks at the BIHttpSession.connect method in the Connecting to Oracle9i OLAP and BI Beans Catalog HTML Client sample

2. How do I connect to the BI Beans Catalog programmatically?

• Refer to the BIImportExport.connect method in the Importing and Exporting Objects Between Catalogs Java Client sample java client sample

Crosstab

1. How do I format a crosstab based on cell value?

• For Java Client applications, Refer to the BIRules.applyGreenStoplightFormatting, BIRules.applyRedStoplightFormatting, BIRules.applyYellowStoplightFormatting methods in the Using Rules to Format Crosstabs Java Client sample
• For HTML Client Applications, Refer to the Developing a JSP Application Overview Tutorial under Customizing Crosstab Properties-> Add a conditional cell image

2. How do I format a crosstab based on a Qualifying Data Reference (e.g. measure or dimension value)?

• Refer to the BIRules.applyCurrencyFormatting, BIRules.applyDivisionFormatting, BIRules.applyHeaderFormatting, BIRules.applySingleCellFormatting, BIRules.applyStoplightFormatting methods in the Using Rules to Format Crosstabs Java Client sample

3. How do I add an image to a cell in a crosstab?

• Refer to the Developing a JSP Application Overview Tutorial under Customizing Crosstab Properties-> Add a conditional cell image

4. How do I use the BI Beans Print, Page Setup, and Preview dialogs to print crosstabs?

• Refer to the BIPrint.showPrintDialog, BIPrint.showPageSetupDialog, BIPrint.showPreviewDialog methods in the Printing Crosstabs Java Client sample

Frame

1. How do I build a HTML frame-based application using the BI Beans JSP tags?

• Refer to the ExplorerTree, ExplorerDetail tags in the Using Frames HTML Client sample

Graph

1. How do I use the Graph panels in a querybuilder wizard?

• Refer to the BIGraph._showGraphWizard method in the Creating and Formatting Graphs Java Client sample

2. How do I use a Graph panel by itself?

• Refer to the BIGraph._showGraphTypeDialog, _showLegendDialog, _showTitleDialog, _showPlotAreaDialog, _showXAxisDialog, _showY1AxisDialog, _showY2AxisDialog, _showLayoutDialog methods in the Creating and Formatting Graphs Java Client sample or the Developing a Java-Client Application Tutorial under Customizing BI Objects->Adding a graph title customizer to the application

3. How do I create an image map over a graph component in HTML applications?

• Refer to the Developing a JSP Application Overview Tutorial under Customizing Graph Properties->Add links and tooltips to components

4. How do I use graph with a non-olap data source?

• Refer to the BI Beans Help Contents in JDeveloper under Presenting Data->Presenting Data in Graphs->Creating Graphs->Specifying Data for Graphs->Specifying Data Through the setTabularData Method

Oracle Portal

1. How do I integrate a BI Beans application with Oracle Portal?

• Refer to the Portal Integration HTML Client sample

Presentation

1. How do I create a presentation wizard for building new presentations?

• Refer to the wizardSelectionChanged class in the New Presentation Wizard Java Client sample

2. How do I open a presentation or its XML definition from the BI Beans Catalog?

• Refer to the BICatalog.openComponent method in the Applying BI Beans Catalog Features Java Client sample

Query

1. How do I build a query programmatically?

• Refer to the BI Beans Help Contents in JDeveloper under Retrieving Data->Building Queries->Building Queries Programmatically

2. How do I create dimension listbox

• Refer to the BIDimList.createDimList method in the Using Dimension List Panel Java Client sample

3. How do I modify a query using a dimension listbox

• Refer to the BIDimList.applyDimListSelection method in the Using Dimension List Panel Java Client sample

• Refer to the QueryTool.handleQueryEvent method in the QueryTool - Creating a Custom ViewTool HTML Client sample

• Refer to the BIQuery.createCrosstab method in the Using QueryBuilder Capabilities Java Client sample

6. How do I assign multiple presentation to share the same query (i.e. completely link multiple presentations)?

• Refer to the BIViewServlet.initializeThinBeans method in the Creating Linked Views HTML Client sample or the Developing a JSP Application Overview Tutorial under Handling Multiple Presentations-> Link the crosstab to the graph or the Developing a Java-Client Application Tutorial under Linking Presentations-> To add custom code to support the linking of presentations in a dual report

• Refer to the LinkedViewPanel.updateLinks method in the Linking Presentations Java Client sample

• Refer to the BIViewServlet class in the Creating Linked Views HTML Client sample or the Developing a JSP Application Overview Tutorial under Handling Multiple Presentations-> Allow presentations to handle more than 25 dimension members in page control boxes

Querybuilder

1. How do I customize the Querybuilder wizard?

• Refer to the BIQuery.initQueryBuilder method in the Using QueryBuilder Capabilities Java Client sample or the Developing a Java-Client Application Tutorial under Customizing BI Objects-> Customizing the QueryBuilder

2. How do I modify a query using a Queybuilder dialog?

• Refer to the BIQuery.insertProductMembers or BIQuery.insertGeographyFavorite methods in the Using QueryBuilder Capabilities Java Client sample

3. How do I use a Querybuilder panel from the wizard by itself?

• L Refer to the BIQuery.insertProductMembers or BIQuery.insertGeographyFavorite methods in the Using QueryBuilder Capabilities Java Client sample

Servlet

1. How do I handle state in a Java Servlet application?

• Refer to the BIStateServlet class in the State Handling HTML Client sample

2. How do I use the ViewToolbar in a Java Servlet application?

• Refer to the BIToolbarServlet class in the QueryTool - Creating a Custom ViewTool HTML Client sample

3. How do I create a multi-page Java Servlet application?

• Refer to the BIMultiplePageServlet class in the Multiple-Page Application HTML Client sample

Struts

1. How do I build a BI Beans application within the Apache Struts framework?

• Refer to the Struts Integration HTML Client sample