When you create a template Excel adds the file extension?
Skip Headers
This chapter covers the following topics: Show
IntroductionAn Excel template is a report layout that you design in Microsoft Excel for retrieving and formatting your enterprise reporting data in Excel. Excel templates provide a set of special features for mapping data to worksheets and for performing additional processing to control how your data is output to Excel workbooks. Features of Excel TemplatesWith Excel templates you can:
Limitations of Excel TemplatesThe following are limitations of Excel templates:
PrerequisitesFollowing are prerequisites for designing Excel templates:
Supported OutputExcel templates generate Excel binary (.xls) output only. Desktop ToolsBI Publisher provides a downloadable add-in to Excel that enables you to preview your template with sample data. This facilitates design by enabling you to test and edit your template without having to upload it to the BI Publisher catalog first. The Template Builder for Excel is installed automatically when you install the Template Builder for Word. The tools can be downloaded from the Home page of Oracle Business Intelligence Publisher or Oracle Business Intelligence Enterprise Edition, as follows: Under the Get Started region, click Download BI Publisher Tools. Sample Excel TemplatesThe Template Builder includes sample Excel templates. To access the samples from a Windows desktop: Click Start, then Programs, then Oracle BI Publisher Desktop, then Samples, then Excel. This will launch the folder that contains the Excel sample templates. ConceptsSimilar to RTF template design, Excel template design follows the paradigm of mapping fields from your XML data to positions in the Excel worksheet. Excel templates make use of features of Excel in conjunction with special BI Publisher syntax to achieve this mapping. In addition to direct mapping of data elements, Excel templates also utilize a special sheet (the XDO_METADATA sheet) to specify and map more complex formatting instructions. Identifying Data Field Placeholders and GroupsExcel templates use named cells and groups of cells to enable BI Publisher to insert data elements. Cells are named using BI Publisher syntax to establish the mapping back to the XML data. The cell names are also used to establish a mapping within the template between the named cell and calculations and formatting instructions that are defined on the XDO_METADATA sheet. Your template content and layout must correspond to the content and hierarchy of the XML data file used as input to your report. Each group of repeating elements in your template must correspond to a parent-child relationship in the XML file. If your data is not structured to match the desired layout in Excel it is possible to regroup the data using XSLT preprocessing or the grouping functions. However, for the best performance and least complexity it is recommended that the data model be designed with the report layout in mind. Note: See Preprocessing the Data Using an XSL Transformation (XSLT) File and Grouping Functions for more information about these options. Use of Excel Defined NamesThe Excel defined names feature is used to identify data fields and repeating elements. A defined name in Excel is a name that represents a cell, range of cells, formula, or constant value. Tip: To learn more about defined names and their usage in Microsoft Excel 2007, see the Microsoft help topic: "Define and use names in formulas." The defined names used in your Excel template must use the syntax described in this chapter, as well as follow the Microsoft guidelines described in the Microsoft Excel help document. Note that BI Publisher defined names are within the scope of the template sheet. About the XDO_ Defined NamesThe BI Publisher defined names are Excel defined names identified by the prefix "XDO_". Marking up the placeholders in the template files creates the connection between the position of the placeholders in the template and the XML data elements, and also maintains the ability to dynamically grow data ranges in the output reports, so that these data ranges can be referenced by other formula calculations, charts, and macros. Using Native Excel FunctionsYou can use the XDO_ defined names in Excel native formulas as long as the defined names are used in a simple table. When a report is generated, BI Publisher will automatically adjust the region ranges for those named regions so that the formulas calculate correctly. However, if you create nested groups in your template, the cells generated in the final report within the grouping can no longer be properly associated to the correct name. In this case, the use of XDO_ defined names with native Excel functions cannot be supported. About the XDO_METADATA SheetEach Excel template requires a sheet within the template workbook called "XDO_METADATA". Use this sheet to identify your template to BI Publisher as an Excel template. This sheet is also used to specify calculations and processing instructions to perform on fields or groups in the template. BI Publisher provides a set of functions to provide specific report features. Other formatting and calculations can be expressed in XSLT. It is recommended that you hide the XDO_METADATA sheet before you upload your completed template to the BI Publisher catalog. This will prevent report consumers from seeing it in the final report output. Note: For more information see Format of the XDO_METADATA Sheet and Defining BI Publisher Functions. Building a Simple TemplateThis section will demonstrate the concepts of Excel templates by walking through the steps to create a simple Excel template and testing it with the Excel Template Builder. This procedure will follow these steps:
Step 1: Obtain sample XML data from your data modelYou need sample data in order to know your field names and the hierarchical relationships to properly mark up the template. For information on saving sample data from your report data model, see the topic "Testing Data Models and Generating Sample Data" in the Oracle Fusion Middleware Data Modeling Guide for Oracle Business Intelligence Publisher. If you do not have access to the report data model, but you can access the report, you can alternatively save sample data from the report viewer. To save data from the report viewer:
The sample data for this example is a list of employees by department. Note that employees are grouped and listed under the department.
Step 2: Open the BlankExcelTemplate.xls file and save as your template nameNote: It is recommended that you install the Template Builder for Excel. For information on downloading the tool, see Desktop Tools. The Template Builder installation includes a set of sample Excel templates, including a sample blank Excel template called BlankExcelTemplate.xls. This template file contains a blank Sheet1 and the XDO_METADATA sheet. It is recommended that you either start with this provided template or copy the XDO_METADATA sheet into your own Excel workbook. Tip: If you are building a new template from an existing template, be sure to clear any existing defined names in the template sheet. To open the BlankExcelTemplate.xls:
Step 3: Design the layout in ExcelIn Excel, determine how you want to render the data and create a sample design, as shown in the following figure: The design shows a department name and a row for each employee within the department. You can apply Excel formatting to the design, such as font style, shading, and alignment. Note that this layout includes a total field. The value for this field is not available in the data and will require a calculation. Step 4: Assign the BI Publisher defined namesTo code this design as a template, mark up the cells with the XDO_ defined names to map them to data elements. The cells must be named according to the following format:
Applying a Defined Name to a Cell
After you have entered all the fields, you can review the names and make any corrections or edits using the Name Manager feature of Excel. Access the Name Manager from the Formulas tab in Excel as shown: After you have named all the cells for this example, the Name Manager dialog will appear as shown: You can review all your entries and update any errors through this dialog. Understanding GroupsA group is a set of data that repeats for each occurrence of a particular element. In the sample template design, there are two groups:
In other words, the employees are "grouped" by department and each employee’s data is "grouped" by the employee element. To achieve this in the final report, add grouping tags around the cells that are to repeat for each grouping element. Note that your data must be structured according to the groups you want to create in your template. The structure of the data for this example
establishes the grouping desired for the report. To Create Groups in the Template
The following figure shows the XDO_GROUP_ defined named entered for the Employees group. Note that just the row of employee data is highlighted. Do not highlight the headers. Note also that the total cell XDO_?TOTAL_SALARY? is not highlighted. To define the department group, include the department name cell and all the employee fields beneath it (A5-E9) as shown in the following figure: Enter the name for this group as: XDO_GROUP_?DEPT? to match the group in the data. Note that the XDO_?TOTAL_SALARY? cell is included in the department group to ensure it repeats at the department level. Step 5: Prepare the XDO_METADATA SheetBI Publisher requires the presence of a sheet called "XDO_METADATA" to process the template. This sheet must follow the specifications defined here. Format of the XDO_METADATA SheetThe XDO_METADATA sheet must have the format shown in the following figure: The format consists of two sections: the header section and the data constraints section. Both sections are required. In the header section, all the entries in column A must be listed, but a value is required for only one: Template Type, as shown. The Data Constraints section does not require any content, but also must be present as shown. This procedure describes how to set up the sheet for this sample Excel template to run. For the detailed description of the functionality provided by the XDO_METADATA sheet see Defining BI Publisher Functions. Creating the XDO_METADATA SheetIf you copied the XDO_METADATA sheet in Step 2, skip this section and proceed to Adding the Calculation for the XDO_?TOTAL_SALARY? Field; otherwise, set up the hidden sheet as follows:
Adding the Calculation for the XDO_?TOTAL_SALARY? FieldEarlier in this procedure you assigned the defined named XDO_?TOTAL_SALARY? to the cell that is to display the total salaries listed in the SALARY column. In this step, you will add the calculation to the Data Constraints section of the XDO_METADATA sheet and map the calculation to the XDO_?TOTAL_SALARY? field.
The completed XDO_METADATA sheet is shown in the following figure: Step 6: Test the templateIf you have installed the Template Builder for Excel, the BI Publisher tab will appear on the ribbon menu as shown in the following figure: To preview your report using sample data:
Formatting DatesExcel cannot recognize canonical date format. If the date format in your XML data is in canonical format, that is, YYYY-MM-DDThh:mm:ss+HH:MM, you must apply a function to display it properly. One option to display your date is to use the Excel REPLACE and SUBSTITUTE functions. This option will retain the full date and timestamp. If you only require the date portion in your data (YYY-MM-DD), another option is to use the DATEVALUE function. The following example shows how to use both options. Example: Formatting a Canonical Date in Excel Using the Employee by Department template and data from the first example, assume you want to add the HIRE_DATE element to the layout to and display the date as shown in Column E of the following figure: To format the date as shown above, follow these steps:
Defining BI Publisher FunctionsBI Publisher provides a set of functions to achieve additional reporting functionality. You define these functions in the Data Constraints region of the XDO_METADATA sheet. The functions make use of Columns A, B, and C in the XDO_METADATA sheet as follows: Use Column A to declare the function or to specify the defined name of the object to which to map the results of a calculation or XSL evaluation. Use Column B to enter the special XDO-XSL syntax to describe how to control the data constraints for the XDO function, or the XSL syntax that describes the special constraint to apply to the XDO_ named elements. Use Column C to specify additional instructions for a few functions. The functions are described in the following three sections:
Reporting FunctionsThe following functions can be added to your template using the commands shown and a combination of BI Publisher syntax and XSL. A summary list of the commands is shown in the following table. See the corresponding section for details on usage.
Splitting the Report into Multiple SheetsNote: Images are not supported across multiple sheets. If the template sheet includes images, when the data is split into multiple sheets, the images will show only on the first sheet. Use the this set of commands to define the logic to split the report data into multiple sheets:
XDO_SHEET_? must refer to an existing high-level node in your XML data. The example will create a new sheet for each occurrence of If your data is flat you cannot use this command unless you first preprocess the data to create the desired hierarchy. To preprocess the data, define the transformation in an XSLT file, then specify this file in the Preprocess XSLT File field of the header section of the XDO _METADATA sheet. For more information, see Preprocessing the Data Using an XSL Transformation (XSLT) File. Use XDO_SHEET_NAME_? to define the name to apply to the sheets. In Column B enter the XSL expression to derive the new sheet name. The expression can reference a value for an element or attribute in the XML data, or you can use the string operation on those elements to define your final sheet name. This example:
will name each sheet using the value of DEPARTMENT_NAME concatenated with "-" and the count of employees in the DEPT group. The original sheet name entry in Column C tells BI Publisher on which sheet to begin the specified sheet naming. If this parameter is not entered, BI Publisher will apply the naming to the first sheet in the workbook that contains XDO_ names. You would need to enter this parameter if, for example, you have a report that contains summary data in the first two worksheets and the burst data should begin on Sheet3. In this case, you would enter in Column C. Example: Splitting the data into multiple sheets Using the employee data shown in the previous example. This example will:
The entries are shown in the following figure: The following figure shows the generated report. Each department data now displays on its own sheet, which shows the naming convention specified: Declaring and Passing ParametersTo define a parameter, use the XDO_PARAM_?n? function to declare the parameter, then use the $parameter_name syntax to pass a value to the parameter. A parameter must be defined in your data model. To declare the parameter, use the following command:
To use the value of the parameter directly in a cell, refer to the parameter as $parameter_name in the definition for the XDO_ defined name, as follows:
You can also refer to the parameter in other logic or calculations in the XDO_METADATA sheet using $parameter_name. Example: Defining and passing a parameter In this example, declare and reference a parameter named Country.
Defining a LinkUse the XDO_LINK_? command to define a hyperlink for any data cell.
Example: Defining a Link Assume your company generates customer invoices. The invoices are stored in a central location accessible by a Web server and can be identified by the invoice number (INVOICE_NO). You can generate a report that creates a dynamic link to each invoice as follows:
The report output will display as shown in the following figure. The logic defined in the XDO_METADATA sheet will be applied to create a hyperlink for each INVOICE_NO entry: Importing and Calling a SubtemplateUse these commands to declare XSL subtemplates that you can then call and reference in any of the XDO_ commands. Note: The Template Builder for Excel does not support preview for templates that import subtemplates. To import the subtemplate, enter the following command:
To call the subtemplate, declare the cell name for which the results should be returned in Column A, then enter the call-template syntax with any other XSL processing to be performed:
For more information on XSL subtemplates and creating the subtemplate object in the catalog, see Designing XSL Subtemplates. Example: Importing and Calling a Subtemplate Assume you have the following subtemplate uploaded to the BI Publisher catalog as PaymentsSummary-SubTemplate.xsb. This subtemplate will evaluate the value of a parameter named pPayType and based on the value, return a string that indicates the payment type:
In your Excel template, you have defined a field with the XDO Defined Name XDO_?TYPE?, which will be populated based on the string returned from code performed in the subtemplate, as shown in the following figure: Enter the following in the Data Constraints region:
The XDO_SUBTEMPLATE_?1? function imports the subtemplate from the BI Publisher catalog. The XDO_?TYPE? cell entry maps the results of the subtemplate processing entered in Column B. Referencing Java Extension LibrariesYou can include the reference to a Java extension library in your template and then call methods from this library to perform processing in your template. Use this command to reference the Java extension libraries:
You can have multiple extension libraries defined in a single template file. Example: Calling a Java Extension Library Assume the extension library includes the following two methods that you want to call in your template:
After you have declared the library as shown above, specify the cell to which you want to apply the method by entering the XDO defined name in Column A and calling the function in Column B. For example:
The entries in the XDO_METADATA sheet to declare and call the Java extension libraries are shown in the following figure: Formatting Functions That Rely on Specific Data Attribute ValuesThe following commands require that specific formatting attributes be present in the XML data file. A summary list of the commands is shown in the following table. See the corresponding section for details on usage.
Defining Border and Underline StylesWhile you can define a consistent style in the template using Excel formatting, the XDO_STYLE command enables you to define a different style for any data cell dynamically based on the XML data. With the XDO_STYLE command you specify the cell to which to apply the style, the logic to determine when to apply the style, and the style type to apply. The style value must be present in the XML data.
BI Publisher supports the following normal Excel style types and values:
You can also set a color using one of the following types:
BI Publisher also supports the underline type with the following values:
You can have multiple underline styles defined for a single cell. Example: Defining Styles To apply a style in a template, the style value must be present in the data. In this example, a border style and an underline style will be applied to the DEPT_TOTAL_SALARY field shown in the Excel template. For this example, the following data is used. Note that the DEPT_TOTAL_SALARY element in the data has these attributes defined:
The value of each of these attributes will be used to apply the defined style based on logic defined in the template.
The following figure shows the three entries in the Data Constraints region: When you run the report, the style commands will be applied to the XDO_?DEPT_TOTAL_SALARY? cell, as shown in the following figure: Skipping a RowUse the XDO_SKIPROW command to suppress the display of a row of data in a table when the results of an evaluation defined in Column B return the case insensitive string "True".
Example: Skipping a Row Based on Data Element Attribute In this example, the Excel template will suppress the display of the row of employee data when the EMPLOYEE_ID element includes a "MANAGER" attribute with the value "True". Assume data as shown below. Note that the EMPLOYEE_ID element for employee Michael Hartstein has the MANAGER attribute with the value "True". The other EMPLOYEE_ID elements in this set do not have the attribute.
To suppress the display of the row of the employee data when the MANAGER attribute is set to "True", enter the following in the Data Constraints section:
The output from this template is shown in the following figure. Note that the employee Michael Hartstein is not included in the report: Grouping FunctionsUse these functions to create groupings of data in the template.
Grouping the dataUse the XDO_GROUP command to group flat data when your layout requires a specific data grouping, for example, to split the data across multiple sheets.
Define the XSL statements to be placed at the beginning and ending of the section of the group definition marked up by XDO_?cell object name?. You can mark multiple groups nested in the template, giving each the definition appropriate to the corresponding group. Regrouping the DataThe XDO_REGROUP regroups the data by declaring the structure using the defined names. It does not require the XSLT logic.
The following shows an example of how to create three nested groupings:
In the above definition, the most outer group is defined as PAYMENTSUMMARY_Q1, and it is grouped by PAY_TYPE_NAME
The above definition creates a second outer group. The group is assigned the name COUNTRY_GRP and it is grouped by the element COUNTRY.
This definition creates the inner group STATEGRP and it includes a sortByName parameter: STATE. Preprocessing the Data Using an XSL Transformation (XSLT) FileFor the best performance, you should design your data model to perform as much of the data processing as possible. When it is not possible to get the required output from data engine, you can preprocess the data using an XSLT file that contains the instructions to transform the data. Some sample use cases may be:
Note: The Template Builder for Excel does not support preview for templates that require XSLT preprocessing. To use an XSLT preprocess file:
Using the Template Viewer to Debug a TemplateIf your template preview is not generating the results expected, you can use the Template Viewer to enable trace settings to view debug messages. The Template Viewer also enables you to save and view the intermediate XSL file that is generated after the sample data and template are merged in the XSL-FO processor. If you are familiar with XSL this can be a very useful debugging tool. The Template Viewer is installed when you install the Template Builder for Word; see Desktop Tools for more information. To preview with the Template Viewer and view log messages:
To view the generated XSL:
Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved. What is it called when you create a chart on the same sheet as your worksheet?embedded chart. A chart that is inserted into the same worksheet that contains the data used to create the chart. Chart sheet. A separate worksheet used to display an entire chart.
What is an Excel file that contains one or more worksheets?A workbook is a file that contains one or more worksheets to help you organize data. You can create a new workbook from a blank workbook or a template.
Which items in the File tab are used to save Excel workbooks in various file formats?Save to Different File Formats. Click the File tab.. Click Save As.. Click the Save as type list arrow. The default file type is an XLSX Excel file, but you can choose from plenty of other file formats in this menu.. Select the desired format.. Click Save.. Which of the following are some frequently and commonly used file formats for Excel?The most common data formats used to store data in files that can be read data into Excel are:. Existing Excel workbook or worksheet with extension .xls. ... . Existing Excel workbook or worksheet with extension .xlsx. ... . Comma-separated values text file with extension .csv. ... . Text file, often with extension .txt or extension .asc.. |