BI Publisher Trainig

Embed Size (px)

Citation preview

  • 7/28/2019 BI Publisher Trainig

    1/27

    TCS Internal

    Business Intelligence PublisherTraining

  • 7/28/2019 BI Publisher Trainig

    2/27

    2009820

    Contents

    Contents for BI Publisher Training BI XML Publisher and Important Path

    Accessing Business Intelligence Publisher

    Navigating the Reports Repository

    Creating Reports and Layouts

    Defining the Data Model for Your Report

    Building a Data Template

    Creating an RTF TemplateAdministering BI Publisher

    Audience

    Developer, Initial Database knowledge required

    Name of the author

    Preeti

    Sharma

  • 7/28/2019 BI Publisher Trainig

    3/27

    2009820

    Installing BI Publisher and Important path

    Oracle XML Publisher offers you the most efficient, scalablereporting solution available for complex, distributed environments.

    Component - XML Publisher Desktop and the XML PublisherServerXML Publisher Desktop contains XML Publisher Template Builderfor Word which is required for generating RTF Templates.Advantage Browser basedAll the information related to Bi Publisher installed at yourapplication server is available in/oradata/oracle/BIPublisher/BI_Publisher_readme.txtStart Bi Publisher as

    /oraapps/oracle/BIpublisher/oc4j_bi/bin/oc4j start &

  • 7/28/2019 BI Publisher Trainig

    4/27

    2009820

    Accessing Business Intelligence Publisher

    URL -http://Localserver:portnumber/xmlpserver/

  • 7/28/2019 BI Publisher Trainig

    5/27

    2009820

    Navigating the Reports Repository and

    Viewing a Report

    The Reports home page displays two main reports folders.

    Shared Folders contains the reports and folders you have been

    granted access to based on your role

    My Folders contains the reports and folders your administrator has

    assigned to you and the reports you have created (if you have the BI

    Publisher Developer or Administrator role).

  • 7/28/2019 BI Publisher Trainig

    6/27

    2009820

    After Click on Report Folder

    Change parameter values -

    if the report includes parameters, these are

    presented on the View page. To display the report with new parametervalues, enter the values and select View.

    Change the report template - if multiple templates are available Changethe report template - if multiple templates are available.

    Change the output type -

    if multiple output types are available, select

    the desired output type from the list and select View.

    Export the report -

    select the Export button to export the report to the

    default application for its output type.

    Send the report -

    select the Send button to invoke the Destination

    dialog. Select the delivery method (Email, Printer, Fax, FTP or WebFolder) and enter the appropriate information for your choice.

    Note: To Send a report to the Printer or Fax, you must first change the

    output type to PDF and select View. Then select Send.

  • 7/28/2019 BI Publisher Trainig

    7/27

    2009820

    Creating Reports and Layouts

    You must be assigned the BI Publisher Developer role or BI Publisher Administrator role to create or edit reports.

    Creating a new report consists of the following steps:

    Create the report in the desired folder on the Reports page.

    Open the Report Editor.

    Specify the general properties for the report.

    Define the Data Model.

    Your report data may come from a SQL query, an HTTP feed, a Web service, an Oracle BI Answers request, a file,an Oracle Discoverer Worksheet, or BI Publisher's data template.

    Define the parameters that you want users to pass to the query, and define lists of values for users to selectparameter values.

    Test your data model.

    Design the layout template.

    RTF template, load the data to the Template Builder for Word.

    PDF template

    Predesigned PDF form (such as a government form)

    Flash template

    e-Text template

    Upload your templates to the Report Editor.

    (Optional) Enable bursting.

    (Optional) Add translations for your reports.

  • 7/28/2019 BI Publisher Trainig

    8/27

    2009820

    Defining the Data Model for Your Report

    BI Publisher requires XML data to publish reports. For getting XML data, most popular ways areData Template for Data Set and SQL Query and other options are also available.

    SQL Query Steps Edit -> Data Model -> New -> Data Set. Select Type as SQL Query and also

    select data source. Enter the SQL query. Data Template for Data Set Steps Edit -> Data Model -> New ->Data Set. Select Type as Data

    Template. Enter the data template code directly in the Data Template text box, or copy and pastethe data template from another text source.

    Data Template Consist of following Tags

    -Contains Name, Description, Default package ad Version no.

    - Contains name and data type of all the parameters for report

    - Contains one or more sql statement.

    - Contains a sql statement

    - Contains one or more group for mapping with each query

    - Contains group name and source query

    - Contains element name for each value fromsql output.

    Test your Data model.

  • 7/28/2019 BI Publisher Trainig

    9/27

    2009820

    Adding Parameters

    Select Parameters and then select the New icon to define parameters for the

    report.

    Enter a name Identifier and the Data Type (String, Integer, Boolean, Date, orFloat).

    Enter a Default Value for the parameter.

    Select the Parameter Type.

    Click Save

  • 7/28/2019 BI Publisher Trainig

    10/27

    2009820

    Bursting

    Using BI Publisher's bursting feature you can split a single report

    based on a key in the report data and deliver the report based on a

    second key in the report data. Driven by the delivery key, you canapply a different template, output format, delivery method, and locale

    to each split segment of your report. Example implementations

    include:

    Invoice generation and delivery based on customer-specific layouts

    and delivery preference

  • 7/28/2019 BI Publisher Trainig

    11/27

    2009820

    Enabling Report For Bursting

    Open Report In Edit Mode.

    Select Bursting under the report definition.

    Select the Enable Bursting check box.

    Select the Split By and Deliver By elements

    Select the data source for the delivery XML.

    Enter the SQL query to build the delivery XML

  • 7/28/2019 BI Publisher Trainig

    12/27

    2009820

    SQL Query for Bursting (General Query)

    select distinct

    CUSTOMER_ID KEY, --Deliver By element

    CST_TEMPLATE TEMPLATE, --Name of Layout Template to apply

    TMPL_TYPE TEMPLATE_FORMAT, --Format of Layout TemplateCST_LOCALE LOCALE, -- Template Locale, en-US

    CST_FORMAT OUTPUT_FORMAT,

    CST_DEL_CHAN DEL_CHANNEL, -- Ex. Email, Fax, Printer

    CST_EMAIL PARAMETER1, -- To, Printer Group

    '[email protected]' PARAMETER2, -- CC, Printer

    '[email protected]'PARAMETER3, --From, Number of copies

    'Your Invoices' PARAMETER4, -- Subject, Sides

    'Hi'||CUST_FIRST_NAME||chr(13)|| 'Please find attached your invoices.'

    PARAMETER5, --Message Body,Trey'true' PARAMETER6, --Attachment, True/False

    '[email protected]' PARAMETER7, --Reply to

    from customers

  • 7/28/2019 BI Publisher Trainig

    13/27

    2009820

    Adding Layouts to the Report

    Refer slide 7 for Type of Layouts. Creating an RTF Template Prerequisites: Your report data model has been created and runs successfully.

    Microsoft Word version 2000 or later and Microsoft Windows version 2000or later are installed on your client.

    The Template Builder has been downloaded and installed on your client. Navigate to C:\Oracle\BI Publisher\BI Publisher Desktop\Template Builder

    for Word\

    Go to Word Doc -> Tools - Templates and Plug-in and Template Builderand click Ok. Load the XML data generated by your Data Model. Insert data fields into your RTF templates Insert tables, forms, charts, and crosstabs

    Preview your template in multiple outputs Browse and update the content of form fields Validate your template Perform calculations on fields within the template Save This RTF Template file.

  • 7/28/2019 BI Publisher Trainig

    14/27

    2009820

    BI Publisher Desktop

    If BI Publisher Desktop is Installed on User Machine then they can accessTemplate Builder.

  • 7/28/2019 BI Publisher Trainig

    15/27

    2009820

    Conditional Formatting in Layout

    Insert the following syntax to designate the beginning of the

    conditional area.

    Insert the following syntax at the end of the conditional area:

    .

  • 7/28/2019 BI Publisher Trainig

    16/27

    2009820

    Features in Layout

    If then else Statement

    Choose Statements

    For Each Row, Processing

    Conditionally Highlighting Rows and Cell

    Arithmetic Calculations

    Sorting Using Variables

    The Variable use a set and get approach. Use the following syntax to declare andset a variable value.

    To get the variable value

  • 7/28/2019 BI Publisher Trainig

    17/27

    2009820

    Adding Parameter to Layout

    You can pass runtime parameter values into your template. These can then bereferenced throughout the template to support many functions. For example,you can filter data in the template, use a value in a conditional formatting block,

    or pass property values (such as security settings) into the final document. Declare the parameter in the template.

    Use the following syntax to declare the parameter:

    Param@begin: is a required string to push the parameter declaration to the topof the template at runtime so that it can be referred to globally in the template.

    The syntax must be declared in the Help Text field of a form field. The formfield can be placed anywhere in the template.

  • 7/28/2019 BI Publisher Trainig

    18/27

    2009820

    Number Formatting to Layout

    To apply a number format to a form field:

    Go to Text Field Properties in RTF.

    Open the Form Field Options dialog box for the placeholder field.

    Set the Type to Number.

    Select the appropriate Number format from the list of options.

  • 7/28/2019 BI Publisher Trainig

    19/27

    2009820

    Uploading Template

    Upload your layout template file : Return to your report definition in the BI Publisher Report Editor.

    Select Layouts.

    Use the Browse button to locate it in your local file system, then

    select Upload. The template will now appear in the ManageTemplate Files region. You can upload as many templates as youwant to make available to this report.

    Select the New icon to create the definition for the new templateEnter a Name for the layout definition. This name will appear in

    the Template list on the View report page. Select the Template file from the list of uploaded templates to

    correspond to this layout definition.

    Select the appropriate template type: RTF or PDF.

    Select the Output Format types to allow for this layout. Save the report and View.

  • 7/28/2019 BI Publisher Trainig

    20/27

    2009820

    Drill Down Reports

    Create a RTF with Hyperlink

    Specify Complete path of report in Hyperlink

    User can Pass Parameters in to hyperlink Drill report can be open in same window or new window.

  • 7/28/2019 BI Publisher Trainig

    21/27

    2009820

    Scheduling Reports

    To schedule a report:

    Select the Schedule link.

    Report Parameters (if applicable) - if the report definition includes parameters, selectthe desired values for this submission.

    If this report is to be burst, select the Burst Report check box, under J ob Properties. Template - select the layout template to apply to the report. You can apply one

    template per job submission. If you selected Burst Report, this option will not beavailable.

    Format - select the output format. If you selected Burst Report, this option will not be

    available. J ob Name - enter a name for your report run.

    Report Formatting Locale

  • 7/28/2019 BI Publisher Trainig

    22/27

    2009820

    Managing Scheduled Reports

    Navigate to this page by selecting the Schedules tab, and then theSchedules sub tab.

    View current schedules for your private, shared, and publicreports

    Monitor the status of a submitted report

    Delete a scheduled report

    Suspend/Resume a scheduled report View the submission details

  • 7/28/2019 BI Publisher Trainig

    23/27

    2009820

    BI Publisher System Maintenance

    Report Repository :

    Under Report Repository, select File System as the Repository Type. Enter the absolute Path. For example: /home/repository/xmlp Apply your changes and restart your BI Publisher application.

    Server Configuration : Debug Level - Controls the amount of debug information generated by the system. It set to

    Exception (the default setting), only error information is generated. If set to Debug, allsystem output is generated.

    Report Viewer Height - sets the size of the report viewing frame in your browser. Enter a

    value in pixels. The default is 600.

    Report Scalable Threshold - sets the threshold at which data is cached on the disk. Whenthe data volume is very large, caching the data will save memory, but will result in slowerprocessing. Enter a value in kilobytes. The default is 10000000 (10 megabytes).

    Output Formats - select the formats that you want displayed to the user by default for

    every RTF template-based report. This server-level setting is overridden by the OutputFormat types selected in the report definition.

  • 7/28/2019 BI Publisher Trainig

    24/27

    2009820

    BI Publisher System Maintenance Cntd.

    Scheduler Configuration Database Type - Select your database from the list. After you make a

    selection, the Database Driver Class field will automatically update with therecommended driver class.

    Connection String - Enter the connection string for your selected database.Sample strings are provided in the database-specific sections that follow.

    Username & Password - Enter the scheduler user you set up for yourdatabase. The user must have permissions to connect to the database and

    create tables. Database Driver Class - When you select the database type this field isautomatically updated with the recommended driver. If you wish to use anotherdriver, specify it in this field.

    Click Test Connection to ensure that BI Publisher can connect to the

    database. If the connection fails, ensure that you have entered the fields asshown and set up your database appropriately.

    Click Install Schema to install the BI Publisher scheduler schema to yourdatabase.

  • 7/28/2019 BI Publisher Trainig

    25/27

    2009820

    Upload, Download Report

    Go to Report Folder.

    Click on report Icon and Click Download report. Save it.

    Saved file consist of XDO and RTF. It will be a zip file. For uploading a report, go to the report folder, select upload report linkand browse the location and click upload.

    Explicitly user needs to check for overwriting existing report.

    Ad i i i BI P bli h

  • 7/28/2019 BI Publisher Trainig

    26/27

    2009820

    Administering BI Publisher

    Defining a Security Model

    Defining a Local Super user

    Allowing Guest Access

  • 7/28/2019 BI Publisher Trainig

    27/27

    2009820

    THANK YOU!!