This tutorial mainly covers how Oracle BI Publisher is integrated with Oracle Business Intelligence Enterprise Edition (Oracle BI EE) 10.1.3.2, and how this integration enables you to create highly formatted reports in Oracle BI Publisher by using Oracle BI Answers and Oracle BI Server metadata.
Approximately 1 hour
This tutorial covers the following topics:
Place the cursor over this icon to load and view all the screenshots for this tutorial.
(Caution: This action loads all screenshots simultaneously, so response
time may be slow depending on your Internet connection.)
Note: Alternatively, you can place the cursor over each individual icon in the following steps to load and view only the screenshot associated with that step.
About Oracle Business Intelligence Enterprise Edition:
Oracle Business Intelligence Suite Enterprise Edition (Oracle BI EE) offers an integrated, comprehensive, standards-based BI platform that provides the best foundation for building enterprise wide BI solutions. It leverages the Oracle's existing data warehousing and business intelligence tools, with a new stack of products listed here.
Oracle Business Intelligence Enterprise Edition specifically consists of:
| Oracle BI Server: Centralized data access and calculation via a logical Common Enterprise Information Model through to the end-user products and other SQL-based tools | |
| Oracle BI Interactive Dashboards: Personalized, highly intuitive, guided and fully interactive access to cockpits of live analyses | |
| Oracle BI Answers: Self-service ad hoc capabilities allowing end users to easily create charts, pivot tables, reports, and visually appealing dashboards, all of which are fully interactive and drillable |
|
| Oracle BI Delivers: Proactive intelligence solution providing alerts that can reach users via multiple channels (e-mail, dashboards, and mobile devices), as well as workflow integration | |
| Oracle BI Disconnected Analytics: Full business intelligence functionality for the mobile professional, enabling fully interactive dashboards and ad hoc analysis while disconnected from the corporate network |
|
| Oracle BI Publisher: High-fidelity report templates that are created and published via common personal productivity applications delivered directly or through Interactive Dashboards to end users |
In this tutorial, you start by opening an existing BI Answers request and modify that to add more fields. You connect to BI Publisher from MS Word and save the BI Answers request that you created as a BI Publisher report. You will open a simple RTF file and create a layout for the report with charts and table using the wizards in MS Word. You will publish this template for the BI Publisher report, and also, you will publish a BI Publisher report on a BI Dashboard. You will also be guided to create a BI Publisher report based on from BI Server subject area and view the data.
This OBE uses the sales history metadata repository SH.rpd, based on the Sales History (SH) sample schema of Oracle Database. To continue with the steps listed in the topics, you should have installed the required software, and set up the SH.rpd metadata repository, as mentioned in the topic titled "Prerequisites."
Before starting this tutorial, you should:
| 1. | Have access to or installed Oracle Database 10g (preferably version 10.2 )
|
| 2. | Have access to or have installed the SH sample schema. This OBE uses the SH schema included in the Oracle10g Database.
|
| 3. | Have access to or have installed Oracle BI EE 10.1.3.2 including Oracle BI Publisher and Oracle BI Publisher Desktop 10.1.3.2.
|
| 4. | Have created an ODBC connection to the Oracle database, and set up the SH.rpd metadata repository, following the steps listed in the OBE "Creating Interactive Dashboards and Using Oracle Business Intelligence Answers". Also, it is strongly recommended that you go through this tutorial to know the steps involved in creating an Answers request, creating a dashboard page, and so on.
|
| 5. | Have set up the integration between BI Publisher, and Oracle BI EE:
If the integration with Presentation Services is not set up at the time of Oracle BI EE installation, you can also set up this integration from BI Publisher as follows:
|
| 6. | Have installed BI Publisher Desktop by clicking the Template Builder link in BI Publisher:
When you install BI Publisher Desktop, it adds the BI Publisher menu in MS Word.
|
| 7. | Have downloaded the Category Sales and Profits. rtf template file provided with this OBE from here . |
Note: All the seven steps listed above in the prerequisites are mandatory. Without performing this setup, you will not be able to proceed with the steps listed in the topics below.
|
|
| 8. | In addition to the above prerequisites, it is suggested that the learner go through the OBE "Creating a Repository using Oracle Business Intelligence Administration Tool " |
In this topic, you will connect to Oracle BI Presentation Services, open a pre-created BI Answers request, modify it as appropriate, and save it.
Follow the steps listed in each of the subtopics below:
| Logging In to Oracle BI Presentation Services | ||
The interactive Web analytics components of Oracle BI EE, such as Oracle BI Interactive Dashboards, Oracle BI Answers, Oracle BI Delivers, Oracle BI Publisher, and Oracle BI Disconnected Analytics are collectively known as Oracle BI Presentation Services. These components make it easy for users to gain complete and timely business insight and enable them to drive effective actions and processes.
Logging in to Presentation Services provides you access to all these components. To log in, perform the following steps:
1. |
Select All Programs > Oracle Business Intelligence > Presentation Services from the Start menu (in Windows).
|
2. |
The Log In screen for Presentation Services appears. Enter Administrator as the User ID and Password, and click Log In.
|
| 3. | The BI Interactive Dashboards page appears showing the sample dashboard created using the sales history reports. Click the Answers link to go to the BI Answers page.
|
In BI Answers, you can create a request from one of the subject areas listed on the BI Answers page, or create a request (SQL query) directed to the database. You can also open an existing request saved in folders. In this topic, you will open a pre-created request from the shared folder, and modify it to add more measures or fields.
| 1. | On the BI Answers page, observe the highlighted options in the screenshot below. Click the SH folder in the Shared Folders section (displayed to the left) on the Catalog tabbed page.
|
| 2. | This displays all the pre-created requests in the SH folder. Click the Category Sales for last 12 months link from the list of requests (displayed on the right).
|
| 3. | You can see that the request is shown on the BI Answers page, which displays the chart. Click Modify to modify this request.
|
| 4. | The request is displayed in the Edit mode, showing the Criteria tabbed page.
Similarly, also add the Amount Sold field to the request. (These measures that you have added should be reflected in the Criteria tab as shown in the screen below):
|
| 5. | Click the Save Request
|
In this topic, you connect to BI Publisher from MS Word and save the BI Answers request that you have modified in the previous topic as a BI Publisher report. You will also open a simple RTF file, and add graphs and table in the report template. You will also publish this template and view the data in the report.
To create a BI Publisher report from the BI Answers request Category Sales and Profits for last 12 Months, perform the following steps:
| 1. | Start the MS Word application from the program menu.
From the Oracle BI Publisher menu, select Log On.
Note: The Oracle BI Publisher menu is displayed in MS Word only when you have successfully installed the Oracle BI Publisher Desktop as mentioned in the step 6 of the Prerequisites section. Also, observe the BI Publisher tool bar in MS Word, with the Data, Insert, Preview , Tools, and Help menus. Observe the various options in these menus.
|
| 2. | In the Login screen that appears, enter Administrator as the Username and Password, and click Login.
|
| 3. | This displays the Open Template window.
|
| 4. | This displays the Save As Oracle BI Publisher Report window.
Hint: You can create a folder in BI Publisher (Web UI) by clicking the Create a New Folder link from the Folder and Report Tasks section.
Do not close the rtf file that is open in MS Word or do not log off from BI Publisher to continue with the next topic. |
You have saved the Answers request as the BI Publisher Report in the previous topic. In this topic you will create a template for the report by adding a bar chart, a pie chart, and then a table to display the data. (Use the hints given in the Category Sales and Profits.rtf file to insert the charts and the table in appropriate places).
Follow the steps listed below to create a template for the report:
| 1. | In MS Word select Insert > Chart. Note: When you save the Answer request as BI Publisher Report, its loads the XML data definitions into the RTF template file so that you can define the layout for the report data.
|
| 2. | In the Chart window that appears, define the graph characteristics by following the instructions listed below carefully:
Resize the chart image in MS-Word to fit in the rtf file better.
|
| 3. | Similarly, insert another Pie chart for showing the sales percentages by category.
Resize the chart image in MS-Word to fit in the rtf file better.
|
| 4. | Now select Insert > Table Wizard to define a format for the table data in the report.
|
| 5. | This displays the Table Wizard. Select Table, and click Next.
|
| 6. | Ensure that ROWSET/ROW is selected as the Grouping Field, and click Next.
|
| 7. | Select Calendar. Calendar Month Desc, Calendar. Calendar Month Name, Products. Prod Category,
|
| 8. | Select Calendar. Calendar Month Desc from the Group By drop-down list,
|
| 9. | In this step you can select the sort orders for various fields.
|
| 10. | Edit the labels of the fields Products. Prod Category as Product Category, Sales Facts. Amount Sold as Sales Revenue, Sales Facts. Gross Profit as Profit.
The template file with the table you created looks like this: Important Note: The BI Publisher Desktop Template Builder has just created a table for you. Notice the words and letters with the gray background. These are called form fields. Form fields are Word objects that allow you to reference other data (for example, a mail merge letter). BI Publisher uses form fields in two ways:
If you are curious to know what these instructions are, double-click the form field and view the Help text. It is important to treat these form fields carefully and not accidentally delete or move them. Doing so will change the layout of the table in your report. Also, you can add or modify your own form fields with XSL commands to do more sophisticated things with the table layout.
|
| 11. | Now, you can additionally use the formatting features in MS Word on this template, such as changing the background and text colors, styles, adding an auto layout for the table, aligning the number fields to the right, and so on.
The table looks like this after the above format changes: Note: You can also use the Auto Format feature in MS Word to define a format for the table. To do this, select the table that you have added, and select Table > Table Auto Format menu option in MS Word. Select an auto format for the table from the list of available formats.
|
| 12. | Also, to add an appropriate number format to the Sales Revenue field, double-click the _Sales_Facts.Amount_Sold_ field (highlighted in the screenshot) below the column header Sales Revenue.
|
| 13. | This displays the Text Form Field Options for editing the formats. Enter the Default Number as 99,999,999.99, and select the format that has a $ in the beginning as shown, and click OK. Similarly, add an appropriate number format to the Profit column too.
|
| 14. | You can also add a form field to calculate the profit totals per month. |
| 15. | In the Field window that appears, define the characteristics by following the instructions listed below carefully:
As this is also a number field, add an appropriate number format to it:
|
| 16. | Also add another field in place of <Month name> in the label:
Add appropriate colors to the Month name and Profit total fields (also add new lines where appropriate) so that the table looks like as shown below: Save the rtf file in MS Word. You can add your initials to the file when saving.
|
| 17. | You can also preview how the data in the report looks like.
The charts and the data are shown in the screens below:
Note: The header, footer, and other format changes you have defined in the template are reflected. You can also view the data in other formats such as HTML, RTF, and so on. Also, do not close the MS Word application or log out from BI Publisher to continue with the next topic. |
In the previous topic, you created a template for the BI Publisher report. In this topic, you publish the template created to view the report data in BI Publisher.
You can directly publish a template from MS Word to BI Publisher for a report, provided:
Perform the following steps to publish the template created from MS Word, and then view data for the report in BI Publisher using this template: (Note that the template you have created satisfies all the above criteria.)
| 1. | In MS Word, select the Oracle BI Publisher > Publish Template As option.
Note: If you have not saved the template in RTF format, it may prompt you to save the template in RTF format first before publishing.
|
| 2. | The Upload as new dialog box appears.
After the template is uploaded, it displays the following message. Click OK again.
|
Note: You can also view the data in the BI Publisher report using the template published, by connecting to BI Publisher (Web) as the Administrator.
Navigate to My Folders > Learn, and click the View link below the Category Sales and Profits for last 12 Months report to view the data.
The report is displayed using the template you have created.
|
In this topic, you create a BI Dashboard page, and publish the BI Publisher report that you created from the BI Answers request on BI Interactive Dashboard. Perform the following steps:
| 1. | Log in to Oracle BI Presentation Services as Administrator (password Administrator). When you log in to Presentation Services, the BI Dashboards page is opened displaying the sample dashboard created with the sales trends as shown below:
From the Page Options drop-down list (at the top-right corner of the page), select Edit Dashboard.
|
| 2. | The Dashboard Editor page is displayed. Click the Add Dashboard Page
This displays the Add Dashboard Page screen. Enter My BI Publisher Page as the Page Name, and optionally enter a suitable description. Click OK.
|
| 3. | Drag BI Publisher Report from the Dashboard Objects list to the section on the My BI Publisher Page as shown below: You can see that the BI Publisher Report object is added to the dashboard, click the Properties link on this object (highlighted in the screenshot).
|
| 4. | The BI Publisher Report Properties screen is displayed. Click Browse to browse and specify the path for BI Publisher Report.
|
| 5. | Select the Category Sales and Profits for last 12 Months report that you created earlier, from the path
|
| 6. | This brings you back to the BI Publisher Report Properties screen.
|
| 7. | This will take you back to the Dashboard Editor page, click Save to save the changes you made to the dashboard.
Note that the dashboard now has the additional page that you created.
|
| 8. | Click My BI Publisher Page tab to view the report that you published on this page: Scroll down to see the graphs and the entire report data in PDF format:
|
In this topic, you will create a BI Publisher report from the BI Server Subject Area (Metadata). You will also create an RTF template in MS Word, and associate it with the report to view the data in BI Publisher.
| Creating a BI Publisher Report from BI Server Subject Area | ||
| Creating an RTF Template in MS Word by Logging In to BI Publisher | ||
| Publishing the Template to View the Report Data in BI Publisher | ||
Creating a BI Publisher Report from BI Server Subject Area
| 1. | Log in (if not logged in) to BI Publisher (Web) as Administrator (password Administrator).
The BI Publisher Welcome page is displayed:
|
| 2. | Navigate to My Folders > Learn, and click Create a new report.
|
| 3. | The newly created report is displayed in the BI Publisher. Click the Edit link displayed below the report name to edit the properties.
|
| 4. | The report is displayed in edit mode.
|
| 5. | On the Data Set page that appears, select SQL Query from the Type drop-down list.
|
| 6. | On the Data Set page, select Cache Result. Ensure that Oracle BI EE is selected as the Data Source. (Observe the highlighted options in the screenshot.)
|
| 7. | The Query Builder is opened displaying the SH subject area (metadata repository) objects displayed on the left. Hint: Take the help of the screens below:
Drag Channels to the Model canvas.
Similarly, drag Products and Sales Facts tables to the Model canvas.
|
| 8. | Select the following columns to be displayed in the query from the Model objects (by selecting the check boxes beside the column names): After the column selection, the Query Builder screen should look like this:
|
| 9. | Click the Conditions link.
|
| 10. | Click the Results link to see if the query results are displayed correctly without any error, and click Save to save the query.
|
| 11. | This will take you back to the BI Publisher Data Set page. Observe that the query is displayed in the SQL Query field. Click the Save
Note: A simple SQL query is created here, but you can create more complex queries by defining Sorts, Aliases, Conditions, Group By fields, and so on in the Conditions screen of the Query Builder.
|
| 1. | Start the MS Word application from the program menu. From the Oracle BI Publisher menu, select Log On.
Enter Administrator as the username and password and click Login.
|
| 2. | The Open Template window is displayed. Navigate and select the BI Publisher report that you have created from BI Server metadata from the path: My Folders > Learn > From BI Server, and click Open Report. (This will load the data from the query.)
|
| 3. | In the Word document, select Insert > Chart to define a graph format for the SQL query data.
|
| 4. | This opens the Chart window.
|
| 5. | The graph you defined for the SQL query data is displayed in the Word document as shown: (Observe the graph title that is displayed).
|
| 6. | You can also add a table to represent the SQL query data.
|
| 7. | Ensure that ROWSET/ROW is selected as the Grouping Field, and click Next.
|
| 8. | Click
|
| 9. | Select Channel Desc from the Group By drop-down list; ensure that the Group above option is selected for this field.
Select Prod Category from the Then By drop-down list, and select the Group left option for this field.
|
| 10. | Select Amount Sold from the Sort By drop-down list, select the Descending and Number options, and then click Next.
|
| 11. | Edit the labels for the fields: Change Prod Name to Product Name and Amount Sold to Sales Revenue. Click Finish.
The template that you have defined looks like this along with the table:
|
| 12. | Make the appropriate format changes in MS Word to the table in the template:
|
| 13. | Save the template in RTF format as ProductSalesbyChannel_Templ.rtf.
|
| 14. | You can also preview how the template looks like with the data in MS Word by selecting
The PDF output in preview looks like this:
|
Perform the following steps to publish the template created from MS Word for the BI Publisher report created from BI Server subject area, and then view data for the report in BI Publisher using this template:
| 1. | In MS Word, select the Oracle BI Publisher > Publish Template As option.
Note: If you have not saved the template in RTF format, it may prompt you to save the template in RTF format first before publishing.
|
| 2. | The Upload as new dialog box appears.
After the template is uploaded, it displays the following message. Click OK again.
|
| 3. | ( If not already connected) Now connect to BI Publisher as Administrator. Open the From BI Server report from My Folders > Learn.
Scroll down to see the table data (a portion of the data is shown below):
You can also view the data in other formats such as PDF, RTF, MS Excel, and so on. Note: If you have time , and want to try more hands-on with BI Publisher, continue with the next topic of creating a report with parameters and list of values.
|
In this topic, you will create a report with parameters and list of values using the From BI Server report you created in the previous topic.
Follow the steps listed below to create a report with parameters and list of values:
| 1. | (If not logged in) Log in to BI publisher as Administrator, and navigate to My Folders> Learn.
|
| 2. | This displays additional report actions in the Report and Folder Tasks.
Note: You can directly modify the From BI Server report to add parameters and LOVs too. |
| 3. | Now click the Edit link below the report to open the report in the Edit mode.
Click New Data Set1 found under the Data Model node in the Report pane on the left to edit the SQL Query for the report. (Observe the screen below):
|
| 4. | This displays the SQL Query for the report on the right. select Channels."Channel Desc" as "Channel Desc", Click Save
|
| 5. | Now click the Parameters node in the Report pane on the left and click New to create a parameter.
|
| 6. | This displays the Parameter screen on the right; define the following: Enter chname as the name of the parameter, and select String as the Data Type. Click Save
|
| 7. | Click View to view the report data using the existingTemplate1 in html format .
|
| 8. | You can enter the names of other channels to see the data.
|
| 9. | Now click Edit to edit the report and define a List of Values to be used with this parameter chname.
|
| 10. | In the List of Values screen that appears on the right, ensure that Oracle BI EE is selected as the Data Source, and click Query Builder to define a query for defining a list of values.
|
| 11. | In the Query Builder screen that displays the SH subject area on the left, click Channels to add it to the Model canvas on the right, and select Channel Desc column (by selecting the check box beside it).
This takes you back to the List of Values screen again which displays the query.
|
| 12. | Now click chname found under the Parameters node in the Report pane on the left to edit it and associate it with the List of Values that you have created:
|
| 13. | In the Parameter screen that appears on the right, now select Menu as the Parameter Type.
In the Menu Setting section that appears below the General Settings section, enter Select a Channel Name: in the Display Label field, and ensure that the New List of Values 1 (that you created) is selected from the List of Values drop-down list.
|
| 14. | Now click View to view the report using Template1 in HTML format.
Note: You can select any of the channels from the drop-down list to view the data for that channel or select All to view the data for all channels.
|
In this tutorial, you learned how to:
| Create a BI Publisher report from BI Answers request | ||
| Create a BI Publisher report from BI Server Subject Area | ||
| Create RTF templates in MS Word by logging in to BI Publisher | ||
| Publish the templates for a BI Publisher report | ||
| View data in BI Publisher reports using the templates in various formats supported | ||
| Create a report with parameters and list of values | ||
To learn more about Oracle Business Intelligence, you can refer to:
Additional OBEs on BI EE on the OTN Web site. |
||
| Additional OBEs on BI Publisher on OTN Web site - Coming soon. | ||
Place the cursor over this icon to hide all screenshots.