Oracle HCM BI Publisher Guide

Share

Oracle HCM BI Publisher: Complete Guide for Reports & Templates

Introduction

Oracle HCM BI Publisher is one of the most critical reporting tools used in Oracle Fusion Cloud HCM for generating formatted, pixel-perfect reports such as payslips, offer letters, HR letters, and compliance documents. In real implementations, consultants rely heavily on BI Publisher to meet business reporting requirements that cannot be fulfilled using OTBI alone.

If you are working in Oracle Fusion HCM, understanding BI Publisher is not optional—it is a core skill. From generating employee data extracts to designing complex payroll reports, BI Publisher plays a central role in every project.

What is Oracle HCM BI Publisher?

BI Publisher (formerly XML Publisher) is a reporting and document generation tool used in Oracle Fusion Cloud to:

  • Extract data from HCM tables and views
  • Format it using templates (RTF, Excel, PDF, etc.)
  • Deliver reports in structured formats

In Oracle HCM, BI Publisher is commonly used for:

  • Payroll reports (Payslips, Payroll Registers)
  • HR letters (Experience letters, Offer letters)
  • Compliance reports
  • Data extracts for integrations

Unlike OTBI (which is more analytical), BI Publisher is layout-driven and document-focused.

Key Features of Oracle HCM BI Publisher

1. Template-Based Reporting

  • Uses RTF, Excel, and PDF templates
  • Designed using Microsoft Word with BI Publisher plugin

2. Multiple Output Formats

  • PDF
  • Excel
  • HTML
  • CSV
  • XML

3. Data Model Driven

  • Reports are built on Data Models (SQL queries, HCM Extracts, etc.)

4. Bursting Capability

  • Send reports to multiple recipients automatically
  • Example: Payslips emailed to employees

5. Secure Role-Based Access

  • Reports can be restricted based on user roles

Real-World Implementation Use Cases

Use Case 1: Employee Payslip Generation

A global company needed:

  • Monthly payslips
  • Secure email delivery
  • Country-specific formats

Solution:

  • BI Publisher template designed using RTF
  • Data sourced from Payroll tables
  • Bursting used for email delivery

Use Case 2: Offer Letter Automation

HR team wanted:

  • Dynamic offer letters
  • Candidate-specific details
  • PDF output

Solution:

  • BI Publisher template integrated with Recruiting module
  • Dynamic fields like salary, role, joining date mapped

Use Case 3: Employee Master Data Extract

Integration team needed:

  • Daily employee data file
  • CSV format
  • Sent to external system

Solution:

  • BI Publisher Data Model with SQL query
  • Scheduled job to generate and deliver file

Architecture / Technical Flow

The BI Publisher reporting process follows this structure:

  1. Data Model
    • Defines data source (SQL, HCM Extract, etc.)
  2. Template
    • Defines layout and formatting
  3. Report
    • Combines Data Model + Template
  4. Bursting (Optional)
    • Distributes report outputs
  5. Scheduling
    • Automates report execution

Prerequisites

Before working with BI Publisher, ensure:

  • Required roles:
    • BI Administrator
    • BI Author Role
  • Access to:
    • Reports and Analytics
  • Basic knowledge of:
    • SQL
    • XML structure
    • Oracle HCM tables

Step-by-Step Build Process

Step 1 – Navigate to BI Publisher

Navigation Path:

Navigator → Tools → Reports and Analytics

Click → Browse Catalog

Step 2 – Create a Data Model

  1. Go to:
    • New → Data Model
  2. Define Data Source:
    • SQL Query
  3. Example Query:
 
SELECT
person_number,
full_name,
date_of_birth,
hire_date
FROM
per_persons
 
  1. Save Data Model

Step 3 – Create Template (RTF)

  1. Download sample XML data
  2. Open Microsoft Word
  3. Install BI Publisher plugin
  4. Insert fields like:
 
<?PERSON_NUMBER?>
<?FULL_NAME?>
<?HIRE_DATE?>
 
  1. Save as .rtf

Step 4 – Create Report

  1. Go to:
    • New → Report
  2. Select Data Model
  3. Upload Template
  4. Configure Output Format

Step 5 – Configure Report Properties

  • Output format: PDF / Excel
  • Layout selection
  • Parameter configuration (if any)

Step 6 – Save and Run Report

  • Click “Run”
  • Validate output

Testing the BI Publisher Report

Example Test Case

Scenario: Employee Data Report

Input:

  • No parameters

Expected Output:

  • List of employees with:
    • Person Number
    • Name
    • Hire Date

Validation Checklist

  • Data accuracy
  • Format correctness
  • Alignment in template
  • Performance (execution time)

Common Implementation Challenges

1. SQL Performance Issues

  • Complex joins can slow reports

Solution:

  • Use optimized queries
  • Avoid unnecessary joins

2. Template Formatting Issues

  • Misaligned fields in PDF

Solution:

  • Use tables in RTF
  • Avoid manual spacing

3. Data Security Issues

  • Users accessing unauthorized data

Solution:

  • Apply data roles
  • Use secured views

4. Bursting Configuration Errors

  • Emails not triggered

Solution:

  • Validate bursting query
  • Check email server setup

Best Practices

1. Use HCM Secured Views

Always use secured views instead of base tables.

2. Keep SQL Simple

Avoid overly complex queries unless necessary.

3. Use Naming Standards

Example:

  • XXHR_EMPLOYEE_REPORT_DM
  • XXHR_EMPLOYEE_REPORT

4. Test with Real Data

Always validate with production-like data.

5. Version Control Templates

Maintain versions of RTF templates.

6. Use Bursting Carefully

Test email delivery thoroughly before production.

Expert Consultant Tips

  • Always download XML sample before designing template

  • Use conditional formatting in RTF:

     
    <?if:salary > 10000?>
    High Salary
    <?end if?>
     
  • Use Excel templates for tabular reports
  • Avoid hardcoding values in templates
  • Reuse Data Models across reports

Frequently Asked Questions (FAQs)

1. What is the difference between OTBI and BI Publisher?

OTBI is used for analytical reports, while BI Publisher is used for formatted documents like payslips and letters.

2. Can BI Publisher be used for integrations?

Yes, BI Publisher can generate XML/CSV files used in integrations.

3. What template formats are supported?

  • RTF (most common)
  • Excel
  • PDF
  • eText

Summary

Oracle HCM BI Publisher is a powerful reporting tool used extensively in real-world implementations. Whether it’s generating payslips, HR letters, or integration extracts, BI Publisher enables consultants to deliver highly customized and formatted outputs.

Mastering BI Publisher requires:

  • Strong SQL knowledge
  • Template design skills
  • Understanding of HCM data structures

If you are working in Oracle HCM projects, BI Publisher is one skill that directly impacts your effectiveness as a consultant.

For more details, refer to Oracle documentation:
https://docs.oracle.com/en/cloud/saas/index.html


Share

Leave a Reply

Your email address will not be published. Required fields are marked *