🔐 How to Lock and Unlock User Accounts Using HDL in Oracle Fusion HCM (Step-by-Step Guide)

 Step-by-Step Instructions for Administrators

Locking and unlocking user accounts is a common requirement for Oracle Fusion HCM administrators. Whether an employee has left the organization, access must be temporarily restricted, or security compliance requires action, Oracle HCM provides a simple way to lock/unlock accounts using HCM Data Loader (HDL).

In this blog, you’ll learn how to lock and unlock user accounts using HDL, along with the required HDL file format, steps to load it, and the process required to apply changes.

---

✅ Prerequisites

Before you begin, make sure you have:

• Access to perform HDL operations

• Valid Person Numbers for users you want to lock/unlock

• Access to run required ESS process (Send Pending LDAP Requests)

• Admin privileges to verify the user status

---

🔒 Locking a User Account Using HDL

To lock a user account in Oracle Fusion HCM, you need to set the Suspended flag = Y in the User HDL file.

---

Step 1: Prepare the HDL File (User.dat)

Use the following format:

METADATA|User|PersonNumber|Suspended
MERGE|User|<Enter Person Number>|Y

Example:

METADATA|User|PersonNumber|Suspended
MERGE|User|E12345|Y

---

Step 2: Save and Compress the File

1. Save the file as: User.dat

2. Compress it into a ZIP file:

   • Example ZIP name: LockUser.zip

---

Step 3: Upload the HDL File

Navigate to:

My Client Groups → Data Exchange → HCM Data Loader → Import and Load

Then:

1. Click Import File

2. Upload the ZIP file

3. Submit the load

---

Step 4: Run Required Process (Very Important)

After HDL loads successfully, you must run:

✅ Send Pending LDAP Requests

This process applies the account changes to the LDAP directory.

---

Step 5: Verify User is Locked

Go to:

Setup and Maintenance → Create Implementation User

Search using the person number / username and confirm the account is locked.

---

🔓 Unlocking a User Account Using HDL

To unlock a user account, set the Suspended flag = N.

---

Step 1: Prepare the HDL File (User.dat)

METADATA|User|PersonNumber|Suspended
MERGE|User|<Enter Person Number>|N

Example:

METADATA|User|PersonNumber|Suspended
MERGE|User|E12345|N

---

Step 2: Save and Compress the File

1. Save as User.dat

2. Zip it:

   • Example ZIP name: UnlockUser.zip

---

Step 3: Upload the HDL File

Navigate to:

My Client Groups → Data Exchange → HCM Data Loader → Import and Load

1. Click Import File

2. Upload ZIP file

3. Submit

---

Step 4: Run Required Process (Very Important)

After HDL loads successfully, you must run:

✅ Send Pending LDAP Requests

This process applies the account changes to the LDAP directory.

---

Step 5: Verify User is Unlocked

Go to:

Setup and Maintenance → Create Implementation User

Confirm the user is now active/unlocked.

---

⭐ Best Practices and Recommendations

• Always double-check the Person Number before locking/unlocking

• Keep an audit log of user account changes

• Notify users when their account is unlocked (unless security policy says otherwise)

• Regularly review locked accounts to avoid unnecessary access restrictions

• Run Send Pending LDAP Requests after every HDL user suspension change

---

⚠️ Common Issues and Troubleshooting

Issue 1: HDL loads successfully but user is still active

✅ Solution:
Run Send Pending LDAP Requests process.

---

Issue 2: Person number not found

✅ Solution:
Confirm the person exists and has a user account created.

---

Issue 3: Changes not reflecting immediately

✅ Solution:
LDAP sync may take time. Wait 5–10 minutes after process completion.

---

📌 FAQ

1. Can we lock a user account in Oracle Fusion HCM using HDL?

Yes. You can lock a user account using HDL by setting the field Suspended = Y in User.dat.

---

2. What HDL object is used to lock/unlock users?

The HDL object used is:

User

---

3. What does the Suspended flag mean in HDL?

• Y = user is locked/suspended

• N = user is active/unlocked

---

4. Do we need to run any process after loading HDL?

Yes. You must run:

✅ Send Pending LDAP Requests

---

5. Where can we verify if a user is locked/unlocked?

You can verify in:

Setup and Maintenance → Create Implementation User

---

6. Can we lock multiple users in one HDL file?

Yes. Add multiple MERGE lines:

METADATA|User|PersonNumber|Suspended
MERGE|User|E1001|Y
MERGE|User|E1002|Y
MERGE|User|E1003|Y

---

7. Is locking a user same as terminating an employee?

No. Locking only disables login access. Termination affects employment and HR records.

---

✅ Conclusion

Locking and unlocking user accounts using HDL is one of the fastest and cleanest methods available for Oracle Fusion HCM administrators. By updating the Suspended flag and running Send Pending LDAP Requests, you can manage user access securely and efficiently.

HDL Template to Absence Entry of Worker

✅ Oracle HCM HDL: Load Worker Absence Entry (PersonAbsenceEntry.dat) – Template + Examples

Absence management is one of the most common business requirements in Oracle Fusion HCM. If you need to load absence entries for employees in bulk (Sick leave, Earned leave, Casual leave, etc.), Oracle provides the HDL object:

👉 PersonAbsenceEntry (and its child object PersonAbsenceEntryDetail)

This post provides a complete HDL template with real working examples, along with prerequisites, common issues, and FAQ.

---

⭐ What is PersonAbsenceEntry in Oracle HDL?

PersonAbsenceEntry is an HDL business object used to create or update worker absence entries in Oracle Fusion HCM.

It supports:

• Absence Type (Sick, Annual Leave, etc.)

• Absence dates and time

• Absence status + approval status

• Assignment-level detail (via PersonAbsenceEntryDetail)

---

✅ Prerequisites (Important)

Before loading absence entry using HDL, verify:

1) Worker must exist

The PersonNumber must be valid.

2) Absence Plan must be enrolled first

If the worker is not enrolled in the absence plan, the absence entry load may fail.

✅ Example errors:

• Plan not enrolled

• Absence type not eligible

• No accrual available

3) Absence Type must exist

Absence Type should be configured in:
Absence Administration → Absence Types

4) Employer / Legal Entity should match worker

Use correct employer name.

---

📂 HDL File Name

📌 File Name:
PersonAbsenceEntry.dat

---

🧾 HDL Sample Template: PersonAbsenceEntry

This is the main absence entry record.

METADATA|PersonAbsenceEntry|Employer|PersonNumber|AbsenceType|AbsenceReason|AbsenceStatus|ApprovalStatus|StartDatetime|EndDatetime|StartDate|StartTime|EndDate|EndTime|SourceSystemOwner|SourceSystemId
MERGE|PersonAbsenceEntry|US3 Legal Entity|XXTEST2|Sick||SUBMITTED|APPROVED||2021/07/12 08:00:00|2021/07/12|08:00|2021/07/12|16:30|XXTEST|XXTEST2_SICK1

---

🔍 Explanation of Key Fields

• AbsenceType: Example: Sick, Annual Leave, etc.

• AbsenceStatus: Usually SUBMITTED

• ApprovalStatus: APPROVED / PENDING

• StartDatetime / EndDatetime: Used for date+time entry

• StartDate / EndDate: Used for date only entries

• SourceSystemOwner / SourceSystemId: Must be unique per absence record

---

🧾 HDL Sample Template: PersonAbsenceEntryDetail 

This object is used when you want to load daily/time details and connect absence to assignment.

METADATA|PersonAbsenceEntryDetail|AbsenceDate|Employer|PersonNumber|AbsenceType|AssignmentNumber|AbsenceStartDate|AbsenceStartTime|RowSeq|StartTime|EndTime|SourceSystemOwner|SourceSystemId
MERGE|PersonAbsenceEntryDetail|2021/07/12|US3 Legal Entity|XXTEST2|Sick|XXTEST_ASSIGN2-1|2021/07/12|08:00|1|06:00|16:30|XXTEST|XXTEST2_SICK1

---

⭐ Why PersonAbsenceEntryDetail is required?

You should use PersonAbsenceEntryDetail when:

✅ Absence is hourly
✅ Absence spans multiple dates
✅ You need assignment-level mapping
✅ You want exact daily breakdown

---

🧠 Recommended HDL Zip Structure

Your zip should look like this:

AbsenceEntryLoad.zip
 └── PersonAbsenceEntry.dat

Upload from:

Data Exchange → HCM Data Loader → Import and Load

---

⚠️ Common Errors and Fixes

❌ Error: Worker is not enrolled in absence plan

✅ Fix: Enroll the worker first in the plan.

---

❌ Error: Invalid Absence Type

✅ Fix: Verify Absence Type spelling and configuration.

---

❌ Error: SourceSystemId already exists

✅ Fix: Use unique SourceSystemId for each absence entry.

---

❌ Error: AssignmentNumber invalid

✅ Fix: Confirm assignment number from Person Management.

---

🔗 Internal Links 

• HDL Load Worker Data (Person/Assignment)

• HDL Assignment Supervisor Template

• HDL Bank → Branch → External Bank Account → Personal Payment Method

• HDL Assigned Payroll Template

• HDL Element Entry Template

• HDL For Seniority Dates

---

💬 Feedback & Comments

If this absence entry HDL template helped you, drop your feedback in the comment section 🙌

If you face any issue, share:

• HDL error message

• Absence Type name

• Whether plan enrollment exists

• Your sample Worker.dat snippet (remove sensitive data)

---

❓ FAQ

Q1. Can we load absence entries using HDL in Oracle HCM?

Yes. You can load worker absences using the HDL objects PersonAbsenceEntry and PersonAbsenceEntryDetail.

---

Q2. Is absence plan enrollment required before loading absence entry?

Yes. In most cases, the worker must be enrolled in the absence plan first.

---

Q3. Which file is used to load absence entry in HDL?

The commonly used HDL file is PersonAbsenceEntry.dat.

---

Q4. What is the purpose of PersonAbsenceEntryDetail?

It provides daily/hourly absence details and connects the absence entry to assignment.

---

Q5. Can we load hourly absences using HDL?

Yes. Hourly absences are supported by providing StartTime and EndTime in PersonAbsenceEntryDetail.

---

Q6. What should be the AbsenceStatus and ApprovalStatus?

Typically:

• AbsenceStatus = SUBMITTED

• ApprovalStatus = APPROVED (or PENDING depending on workflow)

HDL Template to Accrual Plan Enrollment of Worker

HDL Template to Accrual Plan Enrollment of Worker

Please find the below sample template :

File Name - PersonAccrualPlanEnrollment.dat

METADATA|PersonAccrualPlanEnrollment|PersonNumber|WorkTermAsgNum|PlanName|EnrtStDt|SourceSystemId|SourceSystemOwner

MERGE|PersonAccrualPlanEnrollment|XXTEST22|XXTEST_WRKTERM22|Sick|2021/01/01|XXTEST_SICK1|XXTEST

HDL Template for Salary of Worker

How to Load Worker Salary in Oracle Fusion HCM Using HDL (Salary.dat)

Learn how to create or update worker salary in Oracle Fusion HCM using HDL Salary.dat. Step-by-step guide with sample template, required fields, salary basis, action codes, approval flag, and common error fixes.

Oracle Fusion HCM allows you to load or update worker salary using HCM Data Loader (HDL).
This is useful when you need to migrate salary data during:

• New implementation (initial data load)

• Bulk salary updates

• Salary corrections

• Salary changes during hiring

In this blog, you will learn:

✅ Salary HDL file name and structure
✅ Required attributes
✅ Salary basis and approval flag
✅ Sample Salary.dat template
✅ Common errors and troubleshooting

You can see step by step video to load Salary data using this Click Here

---

📌 HDL File Used

To load salary data, use:

✅ Salary.dat

---

✅ Prerequisites (Very Important)

Before loading salary using HDL, make sure:

1) Worker & Assignment already exist

Salary is always tied to an assignment.

So these must exist first:

• Worker record

• AssignmentNumber

---

2) Salary Basis must exist

SalaryBasisName should already be configured.

Example:

• US1 Annual Salary

• Monthly Salary

• Hourly Rate

Navigation:
My Client Groups → Salary → Salary Basis

---

3) Worker must have valid payroll / employment info

Salary often fails if assignment is missing:

• legislation code

• grade

• payroll details (in some setups)

---

✅ Salary.dat Template (Sample)

Use the below sample:

METADATA|Salary|AssignmentNumber|DateFrom|DateTo|SalaryAmount|SalaryBasisName|ActionCode|SalaryApproved
MERGE|Salary|ORACLE_ASG12|1991/01/01||10000|US1 Annual Salary|HIRE|Y

---

✅ Field Explanation (Salary HDL)

1) AssignmentNumber

This is the unique assignment number of the worker.

Example:

ORACLE_ASG12

---

2) DateFrom / DateTo

• DateFrom = salary effective start date

• DateTo = keep blank unless you want to end-date salary

Example:

1991/01/01

---

3) SalaryAmount

Salary amount to load.

Example:

10000

---

4) SalaryBasisName

This must match exactly with configured Salary Basis.

Example:

US1 Annual Salary

---

5) ActionCode

Defines why salary is being loaded.

Common values:

• HIRE

• SALARY_CHANGE

• PROMOTION

• TRANSFER

Example:

HIRE

---

6) SalaryApproved

Salary approval flag.

Values:

• Y = approved

• N = not approved

Example:

Y

---

✅ Step-by-Step: Load Salary Using HDL

Step 1: Create Salary.dat file

Create a .dat file and add metadata + merge line.

---

Step 2: Create .zip file

Create a zip file:

Example:

Salary.zip

Inside zip:

Salary.dat

---

Step 3: Upload in HDL

Navigate to:

My Client Groups → Data Exchange → HCM Data Loader

Steps:

1. Import and Load Data

2. Upload Salary.zip

3. Submit

---

Step 4: Monitor HDL Status

Check:

• Import Status

• Load Status

• Completed Successfully / Error

---

Step 5: Validate Salary in UI

Navigate to:

My Client Groups → Person Management → Search Worker → Salary

Confirm:

• Salary Amount

• Salary Basis

• Effective date

---

⭐ Example: Load Salary for Multiple Workers

METADATA|Salary|AssignmentNumber|DateFrom|DateTo|SalaryAmount|SalaryBasisName|ActionCode|SalaryApproved

MERGE|Salary|ORACLE_ASG12|1991/01/01||10000|US1 Annual Salary|HIRE|Y
MERGE|Salary|ORACLE_ASG13|1991/01/01||12000|US1 Annual Salary|HIRE|Y
MERGE|Salary|ORACLE_ASG14|1991/01/01||15000|US1 Annual Salary|HIRE|Y

---

🔥 Common HDL Errors & Fixes

❌ 1) Salary basis not found

Error:
SalaryBasisName is invalid

✅ Fix:

• Verify Salary Basis exists

• Match exact name (case-sensitive)

---

❌ 2) Assignment number not found

Error:
AssignmentNumber doesn’t exist

✅ Fix:

• Confirm assignment is created successfully

• Load worker/assignment first

---

❌ 3) Salary overlaps existing salary

Error:
Overlapping salary records

✅ Fix:

• End-date previous salary using DateTo

• Or use correct DateFrom

---

❌ 4) Salary not approved

Error:
Salary not visible in UI

✅ Fix:

• Set SalaryApproved = Y

• Ensure approvals not required in workflow

---

🔗 Internal Links 

• Load Worker Data using HDL (Worker.dat)

• Load Personal Payment Method using HDL

• HDL Common Errors and Solutions

• HCM Extract Changes Only Mode

• Oracle Fusion HCM Technical Interview Questions

• Oracle eText Template BIP Report 

• Oracle Benefit Participant Load using HDL

---

⭐ FAQs 

Q1. Which file is used to load salary using HDL?

Salary is loaded using Salary.dat in Oracle Fusion HCM.

Q2. What is required before loading salary using HDL?

Worker and Assignment must exist, and Salary Basis must be configured.

Q3. Can we update salary using MERGE?

Yes, MERGE can create or update salary records depending on the effective date.

Q4. What is SalaryApproved in Salary.dat?

SalaryApproved is a flag that indicates whether the salary record is approved (Y) or not approved (N).

Q5. What is the most common reason salary HDL fails?

The most common reasons are invalid SalaryBasisName and incorrect AssignmentNumber.

HDL Template for Global Temporary Transfer of Worker

For this use Worker.dat

Please find the below sample template :

METADATA|WorkRelationship|PersonNumber|LegalEmployerName|DateStart|ActualTerminationDate|PrimaryFlag|WorkerNumber|WorkerType|RehireRecommendationFlag|OnMilitaryServiceFlag|ActionCode|ReasonCode|DateOfDeath

MERGE|WorkRelationship|XXTEST9|US1 Legal Entity|2018/01/01||Y|XXTEST9|E|Y|N|GLB_TEMP_ASG||

MERGE|WorkRelationship|XXTEST9|UK Legal Entity|2019/01/01||N|XXTEST9|E|Y|N|GLB_TEMP_ASG||

METADATA|WorkTerms|ActionCode|PersonNumber|LegalEmployerName|DateStart|WorkerType|AssignmentNumber|EffectiveStartDate|EffectiveEndDate|EffectiveLatestChange|EffectiveSequence|AssignmentType|PersonTypeCode|AssignmentStatusTypeCode|BusinessUnitShortCode|PrimaryWorkTermsFlag|SystemPersonType|ReasonCode

MERGE|WorkTerms|GLB_TEMP_ASG|XXTEST9|US1 Legal Entity|2018/01/01|E|XXTEST_WRKTERM9|2019/01/01|4712/12/31|Y|1|ET|Employee|SUSPEND_PROCESS|US1 Business Unit|Y|EMP|

MERGE|WorkTerms|GLB_TEMP_ASG|XXTEST9|UK Legal Entity|2019/01/01|E|XXTEST_WRKTERM9-2|2019/01/01|4712/12/31|Y|1|ET|Employee|ACTIVE_PROCESS|UK Business Unit|Y|EMP|

METADATA|Assignment|ActionCode|PersonNumber|LegalEmployerName|DateStart|WorkerType|AssignmentNumber|WorkTermsNumber|EffectiveStartDate|EffectiveEndDate|EffectiveLatestChange|EffectiveSequence|AssignmentType|PersonTypeCode|AssignmentStatusTypeCode|BusinessUnitShortCode|GradeCode|JobCode|LocationCode|DepartmentName|ManagerFlag|LabourUnionMemberFlag|ReasonCode

MERGE|Assignment|GLB_TEMP_ASG|XXTEST9|US1 Legal Entity|2018/01/01|E|XXTEST_ASSIGN9|XXTEST_WRKTERM9|2019/01/01|4712/12/31|Y|1|E|Employee|SUSPEND_PROCESS|US1 Business Unit|XXTEST_GRADE1|XXTEST_CFO|XXTEST_LOC12|XXTEST Department1|Y|N|

MERGE|Assignment|GLB_TEMP_ASG|XXTEST9|UK Legal Entity|2019/01/01|E|XXTEST_ASSIGN9-2|XXTEST_WRKTERM9-2|2019/01/01|4712/12/31|Y|1|E|Employee|ACTIVE_PROCESS|UK Business Unit|XXTEST_GRADE1|ADM|XXTEST_LOC12|XXTEST Department1|Y|N|

 

Oracle Fusion HCM HDL Candidate.dat File – Load Candidate, Address, Phone, Name & Profile (Sample Template)

 

🧾 Oracle Fusion HCM – Load Candidate Data using HDL (Candidate.dat)

If you want to load candidate details into Oracle Fusion Recruiting, you can use HCM Data Loader (HDL) with the file Candidate.dat.

This blog covers:

✅ Candidate basic data
✅ Candidate address
✅ Candidate phone
✅ Candidate name
✅ Candidate profile (Degree / Certifications etc.)
✅ Sample Candidate.dat file format

---

📌 Prerequisites

Before loading Candidate HDL:

• You must have access to HCM Data Loader

• CandidateNumber must be unique

• Use valid codes for:

  • Country (US, IN, etc.)

  • LegislationCode

  • AddressType

  • PhoneType

---

🎥 Step-by-Step Video Reference

You can see step by step video to load Candidate data using this Link:
👉  Link

---

📂 Candidate.dat File – Full Sample Template

1️⃣ Candidate (Basic Candidate Record)

📌 HDL Metadata

METADATA|Candidate|CandidateNumber|CandPrefLanguageCode|StartDate|ConfirmedFlag|CountryOfBirth|DateOfBirth|RegionOfBirth|Source|SourceMedium|TownOfBirth|VisibleToCandidateFlag
✅ Sample Data

MERGE|Candidate|CT123|US|2019/03/20|Y||1980/08/05||direct Source|||Y

---

2️⃣ CandidateAddress

📌 HDL Metadata

METADATA|CandidateAddress|CandidateNumber|EffectiveStartDate|AddressLine1|AddressType|AddressLine2|Country|PostalCode|Region2|Region1|TownOrCity|EffectiveEndDate
✅ Sample Data

MERGE|CandidateAddress|CT123|2019/03/20|1257 Test1|HOME|Test|US|12576|NC|Wayne|Pikeville|

---

3️⃣ CandidatePhone

📌 HDL Metadata

METADATA|CandidatePhone|CandidateNumber|DateFrom|PhoneType|PhoneNumber|CountryCodeNumber|AreaCode|DateTo|Extension|LegislationCode|SpeedDialNumber|Validity|GUID
✅ Sample Data

MERGE|CandidatePhone|CT123|2019/03/20|H1|9605804|1|262|4712/12/31||US|||

---

4️⃣ CandidateName

📌 HDL Metadata

METADATA|CandidateName|EffectiveStartDate|EffectiveEndDate|CandidateNumber|NameType|LegislationCode|FirstName|LastName
✅ Sample Data

MERGE|CandidateName|2019/03/20||CT123|GLOBAL|US|Amar|Test

---

5️⃣ CandidateProfile (Degree / Profile Items)

CandidateProfile is used for things like:

• Degree

• Certifications

• Skills

• Previous employment

• Education details

📌 HDL Metadata

METADATA|CandidateProfile|CandidateNumber|ContentType|ContentItem|SectionContext|DateFrom|ItemDate7|ItemNumber9|ItemText2401|CountryGeographyCode|CountryCountryCode|ProfileItemId

✅ Sample Data

MERGE|CandidateProfile|CT123|DEGREE|BA - Bachelor of Arts|PERSON_DEGREE|2019/03/20|2019/03/20|||US|US|122

---

✅ Best Practices (Important)

✔ Always Follow this Order in Candidate.dat

Recommended sequence:

1. Candidate

2. CandidateName

3. CandidateAddress

4. CandidatePhone

5. CandidateProfile

---

✔ Date Format

Use:

• YYYY/MM/DD
  Example:

• 2019/03/20

---

✔ Effective End Date

Use:

• 4712/12/31

---

❌ Common Errors & Fixes

1) Candidate already exists

Error: Duplicate candidate number
✅ Fix: Use unique CandidateNumber

---

2) Invalid country / legislation code

Error: Invalid CountryCode or LegislationCode
✅ Fix: Use valid values like:

• Country: US, IN

• LegislationCode: US, IN

---

3) AddressType invalid

Error: AddressType HOME not valid
✅ Fix: Use correct address type based on setup:

• HOME

• MAILING

• WORK

---

4) ProfileItemId issue

Error: Profile item not created
✅ Fix: Ensure ProfileItemId exists OR remove ProfileItemId for new inserts.

---

🔗 Internal Links 

Add these links at the bottom or inside the blog:

• HDL Load Worker Data (Complete Guide)

• HDL Template – Benefit Enrollments

• HDL Template – Person Contact

• eText BIP Report

• Common HDL Errors and Fixes

---

⭐ FAQ 

Q1. Which file is used to load candidate data in HDL?

Candidate.dat is used to load candidate records in Oracle Fusion Recruiting.

Q2. Can we load Candidate Address using HDL?

Yes, using CandidateAddress in Candidate.dat.

Q3. How to load candidate education or degree in Oracle HDL?

Use CandidateProfile with ContentType like DEGREE,Education etc.

Q4. What is the best Effective End Date in HDL?

Most implementations use 4712/12/31.

HDL Template for Documents Of Record

 For this use DocumentsOfRecord.dat file.

You can see step by step video to load Documents Of Record using this Link

Please find the below sample template :

METADATA|DocumentsOfRecord|SourceSystemOwner|SourceSystemId|DocumentsOfRecordId|PersonNumber|DocumentTypeId|DocumentType|Country|DocumentCode|DocumentName|DocumentNumber|DateFrom|DateTo|IssuingAuthority|IssuedDate|IssuingCountry|IssuingLocation|Comments|Publish|PublishDate|Status|VerifiedBy|VerifiedDate

MERGE|DocumentsOfRecord|XXTEST|XXTEST_DOCREC01||XXTEST2||Passport||XXTEST_DOCREC01|Passport|XXTEST2123|||||US|||||||

METADATA|DocumentAttachment|SourceSystemOwner|SourceSystemId|PersonNumber|DocumentType|Country|DocumentCode|DataTypeCode|Title|URLorTextorFileName|File

MERGE|DocumentAttachment|XXTEST|XXTEST_DOCREC01|XXTEST2|Passport||XXTEST_DOCREC01|passport.png|passport.png|FILE|passport.png

 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.