WhitePaper_FBLBatchLoadSummary

An Oracle White Paper

December 2013

Oracle Fusion Human Capital Management 11g Release 7 (11.1.7)

Batch Load Summary Report for Fusion HCM File-Based Loader


Introduction ....................................................................................... 1

Batch Load Summary Extract ............................................................ 2

Getting Started .................................................................................. 2

Step 1: Create a Copy of the Seeded Extract ................................ 3

Step 2: Generate and Compile the Fast Formulas ......................... 3

Step 3: Modify the Parameter Attributes for the Extract ................. 4

Run the Extract .............................................................................. 6

Extract Output – Next Steps .......................................................... 8

Summary ..................................................................................... 11


1

Introduction

This white paper provides background and usage of the seeded System Extract template

“Batch Load Summary”.

This seeded template enables File-Based Loader (FBL) integrators to extract details of any

errors that occur during batch load. The report can be extracted in the XML or BI Publisher

format.

Audience

This document is not particularly technical in nature, and is mainly of interest to integration

architects and developers needing to understand how to extract FBL error reports.


2

Batch Load Summary Extract

This extract details the business object instance that was in error. It reports the object GUID, its

Fusion ID, and the detailed error that occurred for each row during the batch load process.

Batch Load Summary is delivered as a seeded extract which reports on the

HRC_LOADER_BATCH_LINES table with the line status as “Error in Row”.

PARAMETER DESCRIPTION

Zip File Name Name of the file from which the batch is loaded. It is populated in the

PARAM_VALUE column of HRC_XFER_JOB_PARAMS table. You can find

the value by looking at the Content ID column in File Import and Export

screen

Batch Name Name of the batch that gets generated on submission of a batch to load. It is

populated in the BATCH_NAME column of

HRC_LOADER_BATCH_HEADER table.

Batch Id The Batch Loader Id that gets assigned to the Batch.

Line Status The status of the Batch as per the HRC_LOADER_BATCH_LINES table. This

parameter can take any of the following values: -

Error in Row

Ignore

New

Pending Action

Ready to Process

Successful

This parameter is currently defaulted to “Error in Row” in order to pick up only

batch lines in error.

Getting Started

Oracle recommends that you make a copy of the seeded System Extract “Batch Load Summary” to use

this functionality. Adopting this approach gives you more flexibility when defining output options and

formatting choices. This white paper will lead you through the steps required to copy the extract and

then modify it to obtain the desired functionality.

The basic steps are as follows: -

1. Create a copy of the seeded extract.


3

2. Generate and Compile the Fast Formula used by the extract.

3. Modify the parameter attributes for the copied extract.

4. Define the BI Publisher Report.

5. Run the Extract.

Step 1: Create a Copy of the Seeded Extract

1. Navigate to the Data Exchange work area.

2. In the Tasks section, click Manage HCM Extract Definitions.

3. Search for Batch Load Summary.

4. Select the extract and click the copy icon.

5. Specify a new name for the extract.

Figure 1. Creating a Copy of the Seeded Extract

Step 2: Generate and Compile the Fast Formulas

You must now compile the Fast Formula for the System Extract Batch Load Summary copy created in

the previous step.

1. In the Data Exchange work area, search for the copied extract and click the edit icon.

2. In the object tree browser, click Header Details within the Batch Header block.


4

3. From the Actions menu, select Generate Formula and then select Compile.

4. Repeat step 3 for Error Details and Error Stack within the Batch Errors block.

5. Save and Close changes and then re-query.

Confirmation of successful compilation of formula is indicated by green tick in the Extract Records

for both the Batch Header and Batch Errors blocks.

A summary of these steps is show in Figure 2 and Figure 3.

Figure 2. Generating Formula for Batch Header Details Block

Figure 3. Verifying Successful Compilation of Fast Formula

Step 3: Modify the Parameter Attributes for the Extract

1. Navigate to the Refine HCM Extracts task in the Data Exchange work area and search for the copy

of the extract created in the previous step.

2. Navigate to the Parameters tab and make the following changes to the Flow Parameters.


5

3. Save and submit the changes.

[Note: The parameters below are presented to the user each time the extract is run. The sequence

number change ensures that the relevant parameters are displayed in the correct order.]

FLOW PARAMETER CHANGES

PARAMETER COLUMN TO CHANGE NEW VALUE

Batch Id Sequence 70

Batch Name Sequence 60

Effective Date Display

Parameter Basis

Basis Value

No – we will default this to the system date.

Context Bind

System Date

Start Date Display No – a start date is not needed for this extract so we can hide it.

Line Status Parameter Basis

Basis Value

Sequence

Constant Bind

Error in Row

80

Zip File Name Sequence 50

Process Configuration Group Sequence 90

Figure 4. Modifying Parameters for Copied Extract [Note: Payroll Flow Patterns is underlying UI]


6

Run the Extract

1. Navigate to the Data Exchange work area.

2. In Tasks Pane, select Submit an HCM Process and Search /Select the extract defined earlier.

The Enter Parameters page appears.

a. Provide a name in the Payroll Flow field for the extract you want to create [Note:

This name is referred to when running the subsequent report.]

b. Enter a value for one or more of the following parameters [details of each provided

earlier in this document].

Zip File Name

Batch Name

Batch Id

c. Leave the default value Error in Row in the Line Status field [details earlier in this

document].

Figure 5. Providing the Extract Details

3. Click Next until you see the Schedule page.

4. Provide the desired schedule parameter, review, and submit

The Payroll Flow checklist page provides status information on the submitted extract.


7

Figure 6. Results of Selected Extract Displayed in the Checklist

Note: If the status shows an error, navigate to Schedule Processes in the Tools section and review the

log.

You can use the Go to Task link to view the extract if a BIP Template and Delivery Options has

optionally been configured in the System Extract definition. For more details, please refer to one of

the following guides available on MOS. The Extract Guide is the main reference whereas the other

guides you through the steps to create a simple extract.

Oracle Fusion HCM Extracts Guide – MOS Note ID 155912701

Defining a Simple HR Outbound Interface Using HCM Extracts – MOS Note ID 1429892.1

System Extract Parameter – Process Configuration Group

You can use the System Extract parameter, Process Configuration Group, for debugging.

Payroll process configuration groups provide sets of payroll action parameters, primarily related to

logging and performance, for your processes and reports [System Extract falls in this category]. When

you run a process, you can select a process configuration group. If you do not select a process

configuration group, the application uses the parameter values in the default group, which means

logging would normally be off [unless this has been modified by the customer].

Normal operation for this extract is to leave the parameter blank.

If it is required to debug an issue with this extract and the underlying data, then a Process

Configuration Group should be supplied which has had logging enabled.

Follow these steps:-


8

1. Navigate to the Manage Payroll Process Configuration task from the Setup and Maintenance work

area.

2. Create a new group giving it a meaningful name, Save and Close.

3. Select the newly created group and in the “Configuration Group Details” window below, edit

Logging Category and put in the value GF, Save and Exit

4. Resubmit your extract adding in this group when prompted in the Extract Parameters page.

The log can then be found in the System Extract Log File which is available in the Schedule Process

UI or in the Payroll Checklist UI.

Figure 7. Reviewing an Extract Submission Using the Payroll Checklist UI

For more details, refer to the section Manage Payroll Process Configuration in the Fusion Applications

Workforce Deployment Implementation Guide.

Extract Output – Next Steps

The previous steps detailed above simply enable extract data to be generated per supplied parameters.

However, depending on your own requirements you will then need to define a report so the error

report can be acted on.

The steps below describe how to create a simple report which makes available the basic XML data

from the extract.

1. Navigate to the Reports and Analytics work area

2. Click Create and select Report from the sub menu. [Ensure that popup is enabled for your browser.]


9

Figure 8. Creating Report from Reports and Analytics Work Area

3. Select Data Model, and then select /Shared Folders/Human Capital Management/Payroll/Data

Models

4. Select globalReportsDataModel.xdm and click OK.

Figure 9. Selecting the Data Model for the BI Publisher Report Definition

5. Select the Use Report Editor option and click Finish.


10

6. Save the report as XX Batch Error Report under Shared Folders/Custom/Human Capital

Management/

7. Click the Save icon on the top right.

Figure 10. Saving the Report Layout

8. Click the View Report button.

9. Provide the Flow name from the previously submitted extract .

10. Click Apply to view the XML report.


11

Figure 11. Viewing the XML Output from Batch Error Report System Extract

Summary

A basic outline on how to generate an xml output from the System Extract has been provided in the

previous steps. The reader is free to generate the output in whichever format is suitable for

consumption by the source system. Full details on how to write different outputs is provided in

documentation for BI Publisher.

Batch Load Summary Report for Fusion HCM

File-Based Loader

December 2013

Author: Vinod Viswanathan

Contributing Authors: Bill Kerr

Oracle Corporation

World Headquarters

500 Oracle Parkway

Redwood Shores, CA 94065

U.S.A.

Worldwide Inquiries:

Phone: +1.650.506.7000

Fax: +1.650.506.7200

oracle.com

Copyright © 2013, Oracle and/or its affiliates. All rights reserved.

This document is provided for information purposes only, and the contents hereof are subject to change without notice. This

document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in

law, including implied warranties and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any

liability with respect to this document, and no contractual obligations are formed either directly or indirectly by this document. This

document may not be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without our

prior written permission.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and

are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are

trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0113

Documents

WhitePaper_FBLBatchLoadSummary