Friday, 23 April 2021

Sample Templates for eText BI Publisher Reports (Delimiter & Fixed Position)

 Sample Templates for eText BI Publisher Reports (Delimiter & Fixed Position)

Introduction to eText BI Publisher Reports

Oracle BI Publisher (BIP) provides eText report templates to generate text-based output files such as .txt, .dat, or interface files required for integrations with external systems.

Unlike PDF or Excel outputs, eText reports are mainly used when:

  • Data must follow a specific layout

  • Files are consumed by external payroll, banking, or legacy systems

  • Strict formatting rules (delimiter or fixed length) are required

In this blog, we’ll cover:

  • What eText BI Publisher reports are

  • how to create eText report in BI Publisher

  • Differences between Delimiter-Based and Fixed Position-Based eText

  • BI Publisher eText report example

  • how to create fixed position eText report

  • common errors in BI Publisher eText report


Difference Between Delimiter & Fixed Position eText

Delimiter VS Fixed Position eText


You can see step by step video to develop eText BIP Report using this Link



🔹 Sample 1: Delimiter-Based eText Template

This template generates output with values separated by a delimiter (for example, |).

You can see step by step video to develop eText BIP Report using this Link

<TEMPLATE TYPE>

DELIMITER_BASED

<OUTPUT CHARACTER SET>

iso-8859-1

<CASE CONVERSION>

UPPER

<NEW RECORD CHARACTER>

Carriage Return

 

<LEVEL>

DATA_DS

<MAXIMUMLENGTH>

<FORMAT>

<DATA>

<COMMENTS>

<NEW RECORD>

TableHeader

20

Alpha

'Person Id'

 

1

Alpha

'|'

 

20

Alpha

'Title'

 

1

Alpha

'|'

 

20

Alpha

'First Name'

 

1

Alpha

'|'

 

20

Alpha

'Last Name'

 

 

<LEVEL>

G_1

<MAXIMUMLENGTH>

<FORMAT>

<DATA>

<COMMENTS>

<NEW RECORD>

CLRDAta

20

Alpha

PERSON_ID

 

1

Alpha

'|'

 

20

Alpha

TITLE

 

1

Alpha

'|'

 

20

Alpha

FIRST_NAME

 

1

 

'|'

 

20

Alpha

LAST_NAME

 

<END LEVEL>

G_1

 

<END LEVEL>

DATA_DS

 This format is useful when the target system expects delimiter-separated text files.


🔹 Sample 2: Fixed Position-Based eText Template

Fixed Position eText templates generate files where each field occupies a predefined position and length.

eText Template Configuration

You can see step by step video to develop Fixed Position eText BIP Report using this Link

<TEMPLATE TYPE>

FIXED_POSITION_BASED

<OUTPUT CHARACTER SET>

iso-8859-1

<CASE CONVERSION>

UPPER

<NEW RECORD CHARACTER>

Carriage Return

 

<LEVEL>

DATA_DS

<POSITION>

<LENGTH>

<FORMAT>

<PAD>

<DATA>

<COMMENTS>

<NEW RECORD>

TABLE_HEADER

1

15

Alpha

R, ' '

'Person Id'

 

16

3

Alpha

R, ' '

'|'

 

19

15

Alpha

R, ' '

'Title'

 

35

3

Alpha

R, ' '

'|'

 

39

50

Alpha

R, ' '

'First Name'

 

90

3

Alpha

R, ' '

'|'

 

94

20

Alpha

R, ' '

'Last Name'

 

<LEVEL>

G_1

<POSITION>

<LENGTH>

<FORMAT>

<PAD>

<DATA>

<COMMENTS>

<NEW RECORD>

TABLE_HEADER

1

15

Alpha

R, ' '

PERSON_ID

 

16

3

Alpha

R, ' '

'|'

 

19

15

Alpha

R, ' '

TITLE

 

35

3

Alpha

R, ' '

'|'

 

39

50

Alpha

R, ' '

FIRST_NAME

 

90

3

Alpha

R, ' '

'|'

 

94

20

Alpha

R, ' '

LAST_NAME

 

<END LEVEL>

G_1

<END LEVEL>

DATA_DS

 

This format is commonly used for legacy systems and strict interface requirements.


✅ When to Use Which Template?

eText Template Usage


etext-bi-publisher-delimiter-fixed-position-templates

Common Mistakes & Best Practices

❌ Common Mistakes

  • Incorrect field length causing data truncation

  • Misaligned positions in fixed position templates

  • Missing group levels (G_1)

  • Not validating output using sample XML

  • Ignoring character set requirements

✅ Best Practices

  • Always test with maximum field length data

  • Validate output using XML Publisher Preview

  • Use UPPER case conversion if required by the target system

  • Document field positions clearly for fixed position reports

  • Maintain a sample output file for reference


❓ Frequently Asked Questions (FAQs)

🔹 What is an eText report in BI Publisher?

An eText report in Oracle BI Publisher is a text-based output format used to generate files such 

as .txt or .dat. It is mainly used for data integrations, payroll interfaces, and legacy system file transfers where specific formatting is required.


🔹 What are the types of eText templates in BI Publisher?

BI Publisher supports two types of eText templates:

  1. Delimiter-Based eText Template

  2. Fixed Position-Based eText Template

Each format is used based on the target system’s file layout requirements.


🔹 What is a delimiter-based eText report?

A delimiter-based eText report separates fields using a delimiter such as pipe (|), comma (,), or tab.
It is easy to read, flexible, and commonly used for data extracts and reporting purposes.


🔹 What is a fixed position-based eText report?

A fixed position-based eText report assigns each field a predefined position and length in the output file.
This format is widely used for payroll processing and legacy system integrations that require strict file layouts.


🔹 Which eText format should I use in BI Publisher?

  • Use Delimiter-Based eText for:

    • Easy debugging

    • Data extracts

    • Reporting

  • Use Fixed Position-Based eText for:

    • Payroll interfaces

    • Banking files

    • Legacy systems with strict file requirements


🔹 How do I debug eText BI Publisher reports?

To debug eText reports:

  • Validate output using XML Publisher Preview

  • Test with maximum field length data

  • Verify field positions in fixed position templates

  • Check delimiter consistency in delimiter-based templates


🔹 What are common errors in eText BI Publisher reports?

Common issues include:

  • Incorrect field length causing data truncation

  • Misaligned positions in fixed position templates

  • Missing group levels (G_1)

  • Character set mismatch

  • Incorrect case conversion settings


🔹 Can I generate both header and data records in an eText report?

Yes, BI Publisher eText templates allow you to generate:

  • Header records

  • Detail (data) records

  • Trailer records
    by defining multiple <NEW RECORD> sections within the template.


🔹 What character set should I use for eText BI Publisher reports?

The commonly used character set is iso-8859-1, but the correct choice depends on the target system’s requirements. Always confirm encoding expectations before deployment.


🔹 Can eText BI Publisher reports be scheduled?

Yes, eText BI Publisher reports can be:

  • Scheduled

  • Bursted

  • Delivered via FTP/SFTP
    just like other BI Publisher reports.

Conclusion + Call to Action

eText BI Publisher reports are essential for Oracle Fusion and BI Publisher integrations where text-based output files are required.

Understanding the difference between Delimiter-Based and Fixed Position-Based eText templates helps you choose the right format and avoid common errors during implementation.

📌 If you found this blog helpful:

  • Share it with your Oracle technical community

  • Bookmark it for future reference

  • Drop your questions or scenarios in the comment section

👉 For more Oracle BI Publisher and Fusion technical blogs, stay tuned!

🎓 Oracle HCM Technical Training  

If you want to learn Oracle Fusion HCM Technical in a structured way, I also provide Oracle HCM Technical with real-time practical examples.

If you want Oracle HCM Technical Training, you can contact me here: Link

6 comments:

  1. Hi I am using exactly the same template as you have mentioned, the output is returning only 1 row of data. It is returning 1 Header and then 1 row of data ..
    Can you help what could be the issue.

    Also, I am using HCM Extract for xml creation and creating this integration

    ReplyDelete
    Replies
    1. It means issue is with loop if XML is generating more than one records.
      Please check the data group loops in your template.
      Try to import the xml in rtf template and view output in word only if output is as expected then upload rtf to fusion

      Delete
  2. Is it possible to have multiple data headers and data sections to use it for returning two sections on the output file?

    ReplyDelete
  3. Excellent example. I saw your YouTube video tutorial but my Report output is showing blank result

    ReplyDelete

HDL vs HSDL in Oracle HCM Cloud

  ✅ HSDL vs HDL in Oracle HCM Cloud – What’s the Difference? (Complete Guide) If you work on Oracle HCM Cloud , you’ve definitely heard abo...