An Oracle White Paper

December 2014

Oracle Fusion HCM- Automating File-Based Loader

Using FBL Desktop Integrator (FBLdi)
Release 8

Disclaimer
The following is intended to outline our general product direction. It is intended for information purposes
only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code,
or functionality, and should not be relied upon in making purchasing decisions. The development, release,
and timing of any features or functionality described for Oracles products remains at the sole discretion
of Oracle.

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Contents
Overview ........................................................................................... 2
Introduction ....................................................................................... 2
FBLdi Installation ............................................................................... 3
Java Download and System Setup ................................................ 3
FBLdi Download and Installation ................................................... 4
Profile Setup ...................................................................................... 5
Data File Transfer-n-Registration....................................................... 7
UCM Command Line ..................................................................... 7
SFTP Command Line .................................................................... 9
FBL Auto Run .............................................................................. 10
FBLdi Integration Using a Custom Java Program ............................ 11
Executing the Command in a Separate Process .......................... 11
Calling the Functional Methods Directly into Your Java Program . 12
Conclusion ...................................................................................... 13
Related Documentation on My Oracle Support ................................ 13

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Overview
This document provides Oracles recommended guidance for using the File-Based Loader Desktop
Integrator (FBLdi), as part of learning and implementing data conversion using Oracle Fusion HCM
File-Based Loader (FBL). It is assumed that the reader of this document is well aware of Oracle
Fusion HCM File-Based Loader.
This document initially explains the installation and system setup of FBLdi, and then walks you
through the technical details of various commands required to automate FBL using the FBLdi utility.
This document also provides information on automating the FBL processing specifically file upload
and registration using a custom java program.

Introduction
FBL Desktop Integrator (FBLdi) is a standalone desktop application that can assist you with various
steps involved in FBL and data conversion without the need for developing complicated java programs
or going through the lengthy process of posting a file to Oracle Fusion HCM manually.
FBLdi can assist you with file transfer and registration involved in FBL conversion and provide sample
files specifically tailored for your own application. It can be used as a great learning tool if you are
starting up a new project, or conducting a workshop or a training class.
It can also be used to spot-check your Oracle Fusion HCM pod to ensure that it is configured properly
for FBL.

Figure 1 FBL Desktop Integrator

Oracle Fusion HCM Automating File-Based Loader using FBLdi

FBLdi Installation
FBLdi Installation is really simple download the application, unzip/extract the file, and start using!
Since FBLdi is a java application, you must have java installed on your computer. The java download
and FBLdi setup steps are described in detail in the next two sections.

Java Download and System Setup

You must have Java (JRE) installed on your computer to run FBLdi.

Link to download Java SE

Instructions to update PATH environment variable to allow executing the jar file without
typing the full command.

Set the JAVA_HOME environment variable

to point to the directory where java is
installed
1.

Open the System Properties window

from the Control Panel to add a
new environment variable.

2.

On the Advanced tab, click

Environment Variables.

3.

In the User variables section, click

New.

Figure 2 System Properties

4.

Add the new user variable

JAVA_HOME and specify the
directory path where java (java run
time environment) is installed.

Figure 3 New User Variable

Oracle Fusion HCM Automating File-Based Loader using FBLdi

FBLdi Download and Installation

To download and install the FBLdi application, follow these steps:
1.

Download the application from My Oracle Support note - 1616867.1.

2.

Unzip the archived file on your computer.

3.

Double click the FBLdi2.3.4.jar file to start the application.

Technical information about various components:

Database folder- Sample files. Please do

not change the content of this folder.

Help folder- Help files

Lib folder- Java libraries used by FBLdi

Profiles folder- Setup profiles are stored

as .TM file within this folder.

Temp folder- Temporary directory to

store cross-reference files downloaded
from your Oracle Fusion HCM
application

upload.bat file- Windows bat file to run

the program via command line instead of UI

Figure 4 FBLdi2.3.4 Folder Contents

To use the command line version of the

tool, go to the FBLdi root directory and
open the command prompt.

Figure 5 FBLdi Command Prompt

Sample command

run: upload ucm -help

Figure 6 FBLdi Sample Command

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Profile Setup
FBLdi profile is a one-time setup per application install, and consists of basic connectivity and login
information. You can create a new profile the first time and continue to use it for posting files using
FBL.

Creating a New Profile for Universal Content Management (UCM)

You can set up a new UCM profile using the following parameters.

Figure 7 UCM Setup Information

PARAMETER

DESCRIPTION

UCM Server URL

UCM is used as the file repository. UCM URL for your pod will be similar to https://fsaufsn4x0POD.oracleoutsourcing.com/cs/idcplg

UCM Username

User account (typically same as Oracle Fusion HCM application user) to login into UCM server and
upload/check-in the input file.

UCM Password

Password

Inbound Folder

Default UCM folder to store incoming FBL files - hcm/dataloader/import

Outbound Folder

Default UCM folder to store outgoing FBL files - hcm/dataloader/export

WSDL URL

File Registration URL. Typical value for a POD: https://hcmaufsn4x0POD.oracleoutsourcing.com/hcmCommonBatchLoader/LoaderIntegrationService?wsdl

HCM Username

User account for Oracle Fusion HCM. It will be used to invoke the file registration web service.

HCM Password

Password

Sequence#

Default is 1. You may use the sequence number 1,2,3,4...N in order to conduct a training class where each
student can load the demo data in the same POD without any conflicts.

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Creating a New Profile for Secure File Transfer Protocol (SFTP)

You can set up a new SFTP profile using the following parameters.

Figure 8 SFTP Setup Information

PARAMETER

DESCRIPTION

Test Case

Optional. Description or extra information for the profile.

End Point URL

File Registration URL. Typical value for a POD: https://hcm-aufsn4x0pod.oracleoutsourcing.com/soainfra/services/default/HcmCommonBatchLoaderCoreInboundLoaderComposite/inboundloaderprocess_client_ep

Application
UserID

User account for Oracle Fusion HCM. It will be used to invoke the file registration web service.

Password

Password

SFTP Host
Name

Default value is sftp.cloud.oracle.com. You can change this value depending on the SFTP provisioned for your pod.

SFTP Port

The SFTP port for your application. Default value is 2021.

SFTP User

SFTP User Name for your application

SFTP Password

SFTP users password

SFTP Root
(E1) path

Absolute path for the root directory (either /E1 or /upload/E_1)

Sequence#

Default value is 1. You may use the sequence number 1,2,3,4...N in order to conduct a training class where each student can
load the demo data in the same POD without any conflicts.

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Data File Transfer-n-Registration

As the name suggests, this is a two-step process in which you first transfer the zip file of data (set of
.dat files) to UCM (or SFTP for releases prior to release 7) followed by a web service call to register
and load that file into Oracle Fusion HCM. Using the FBLdi command line, you can accomplish these
tasks by means of simple commands, as explained in the following sections.

UCM Command Line

Starting from release 7, UCM is the recommended file transfer and storage mechanism for FBL. The
following sections explain the steps to automate FBL file transfer and auto run for UCM
Usage
upload ucm [-h] [-prop property_file] -f zip_file [-i [-ol object_list] [-lt FBL|HR2HR] [-al
Y|N] [-b batch_name]][-proxy -host -port] [-output <xml file>]

UCM COMMAND LINE PARAMETERS

PARAMETER

MANDATORY

DEFAULT
VALUE

-h, --help

DESCRIPTION

Print the help/usage message

-prop, --property-file

Properties file containing all necessary settings. Default

property file is profiles/ucmcli.tm

-f, --upload-file

The full path of the zip file to be uploaded

-i, -- invoke

Invoke FBL (i.e file registration) once file is uploaded to

UCM

-ol, --object-list

all

The names of business objects to be loaded, separated by

comma

-lt, --load-type

FBL

Data loading tool to be used, either FBL or HR2HR

-al, --auto-load

Auto load flag. N = Import only, Y = Import and Load

Set this flag to Y to automate FBL data loading.

-b, --batch-name

Unique batch name

-proxy

A flag to use http proxy to connect server

-host,--proxy-host

Http proxy host

-port,--proxy-port

Http proxy port

-output,--output-file

Xml file to output the result

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Examples
1. Upload the data file with the default setup file.
upload ucm -f D:\temp\Prasanna\DemoData\Location_Demo.zip

2. Upload the data file with a specified setup file.

upload ucm -prop D:\FBLdi2.3.4\profiles\Rel8stage.tm -f
D:\temp\Prasanna\DemoData\Location_Demo.zip -i

3. Upload the data file and register the business objects with default parameter values.
upload ucm -f D:\temp\Prasanna\DemoData\Location_Demo.zip -i

4. Use proxy.
upload ucm -f D:\temp\Prasanna\DemoData\Location_Demo.zip -i -proxy host proxy.oracleoutsourcing.com -port 80

5. Output the result into a specified file.

upload ucm -f D:\temp\Prasanna\DemoData\Location_Demo.zip -i -output
result.xml

6. Use the recommended command to upload the data file and auto load using FBL.
upload ucm -prop D:\FBLdi2.3.4\profiles\ Rel8stage.tm -f
D:\temp\Prasanna\DemoData\Location_Demo.zip -b batch_pb01 -i -lt FBL -al
Y -output D:\temp\Prasanna\DemoData\result.xml

Oracle Fusion HCM Automating File-Based Loader using FBLdi

SFTP Command Line

Prior to release 7, SFTP was the only available file transfer and storage mechanism for FBL. Oracle is
supporting SFTP for those customers that are using it post release 7. The following sections explain
the steps to automate FBL file transfer and auto run for SFTP.
Usage
upload sftp [-h] [-prop property_file] -f zip_file [-reg] [-proxy -host -port] [-output <xml
file>]

SFTP COMMAND LINE PARAMETERS

PARAMETER

MANDATORY

DEFAULT
VALUE

-h, --help

DESCRIPTION

Print the help/usage message

-prop, --property-file

Properties file containing all necessary settings. Default

property file is profiles/ucmcli.tm

-f, --upload-file

The full path of the zip file to be uploaded

-reg, -- regist

Invoke FBL (i.e file registration) once file is uploaded to

the SFTP server

-ol, --object-list

all

The names of business objects to be loaded, separated by

comma

-lt, --load-type

FBL

Data loading tool to be used, either FBL or HR2HR

-al, --auto-load

Auto load flag. N = Import only, Y = Import and Load

Set this flag to Y to automate FBL data loading.

-b, --batch-name

Unique batch name

-proxy

A flag to use http proxy to connect to the server

-host,--proxy-host

Http proxy host

-port,--proxy-port

Http proxy port

-output,--output-file

Xml file to output the result

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Examples
1. Upload the data file with the default setup file.
upload sftp -f D:\temp\Prasanna\DemoData\Location_Demo.zip

2. Upload the data file with a specified setup file.

upload sftp -prop D:\FBLdi2.3.4\profiles\Rel8stage_sftp.tm -f
D:\temp\Prasanna\DemoData\Location_Demo.zip

3. Register the business objects after uploading.

upload sftp -f D:\temp\Prasanna\DemoData\Location_Demo.zip -reg -b
batch_pb003

4. Output the result into a specified file.

upload sftp -f D:\temp\Prasanna\DemoData\Location_Demo.zip -reg -al Y -b
batch_pb004 -output result.xml

5. Use the recommended command to upload the data file and auto load using FBL.
upload sftp -prop D:\FBLdi2.3.4\profiles\Rel8stage_sftp.tm -f
D:\temp\Prasanna\DemoData\Location_Demo.zip -b batch_pb005 -reg -lt FBL
-al Y -output D:\temp\Prasanna\DemoData\result.xml

FBL Auto Run

Once you register the data file, it is available for processing by Oracle Fusion. If you have set the Auto
Load parameter to Yes, then Oracle Fusion automatically invokes FBL to load the input file.
You can see the results of the load in the Data Exchange work area on the Load Batch Data page.
Note: If you have set the Auto Load parameter to No, you need to manually click Run on the Load
Batch Data page to start the file import process.

10

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Figure 9 Load Batch Data Page

FBLdi Integration Using a Custom Java Program

Now that we know how to use FBLdi via command line, in this section, we discuss options to invoke
FBLdi directly from your custom java program. You can fully integrate the FBLdi functionality into a
custom java program in the following two ways:
7.

By executing the command in a separate process

8.

By calling the functional methods directly into your java program

Executing the Command in a Separate Process

You can execute the command in your java program in a separate process by using the
java.lang.Runtime class. A sample is shown in following code:

Build the command similar to the one you built previously.

Get an instance of java.lang.Runtime class associated with the current java application.

Invoke its exec method with the string command.

String command = "D:/FBLdi2.3.4/upload.bat ucm -f

d:/fbl2_demo_person_opa.zip";
Process p = Runtime.getRuntime().exec(command);
p.waitFor();
StringBuffer sb = new StringBuffer();
BufferedReader reader = new BufferedReader(new
InputStreamReader(p.getInputStream()));

11

Oracle Fusion HCM Automating File-Based Loader using FBLdi

String line = "";

System.out.println("exit value:" + p.exitValue());
while ((line = reader.readLine()) != null) {
sb.append(line + "\n");
}
System.out.println(sb);

Calling the Functional Methods Directly into Your Java Program

In this method, the code executes in the same process in which your java program is running.

Adjust the class path of your java program to include all Java libraries in Lib fold as well as
FBLdi2.3.4.jar.

Import either oracle.hcm.cx.app.cmd.impl.UCMUpload Java class for UCM storage or

oracle.hcm.cx.app.cmd.impl.SftpUpload for SFTP.

Instantiate an object of the class you just imported in the previous step with a String array of
command line parameters.

Here is a code sample using UCM as the storage.

import oracle.hcm.cx.app.cmd.impl.UCMUpload
...
//System.setProperty("ucm.prop.default", "D:/FBLdi2.3.4/conf/ucmcli.tm");
UCMUpload uf = new UCMUpload(new String[] {"-prop",
"D:/FBLdi2.3.4/conf/ucmcli.tm", "-f", " D:/temp/location1.zip", "-i", "output", "d:/result.xml" });
uf.execute();

Important: You need to either set the default property file first through the environment variable
pointing to the property file, or specify the full path of the property file. Both ways are illustrated in the
code above.
SETTING DEFAULT PROPERTY FILE
ENVIRONMENT VARIABLE NAME

DEFAULT VALUE

DESCRIPTION

ucm.property.default

Full path to the property file

sftp.property.default

Full path to the property file

12

Oracle Fusion HCM Automating File-Based Loader using FBLdi

Conclusion
As part of Oracle Fusion HCM cloud implementation full HR or coexistence model, you are likely to
face the situation where you need to automate file transfer and data loading tasks for FBL. You can
accomplish these tasks without investing heavily in programming, by using the tools and methods
described in this document. To summarize, here are various options to use FBLdi for file transfer and
registration tasks

FBLdi user interface

FBLdi command line

FBLdi use/functional call as part of custom java program

Related Documentation on My Oracle Support

13

Oracle Fusion Human Capital Management File-Based Loader - 1595283.1

FBL Desktop Integrator Download - 1616867.1

FBL Desktop Integrator User Guide - 1915774.1

Oracle Fusion HCM FBLdi User Guide

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

December 2014
Author: Prasanna Borse

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

Contributing Authors: Aaron Liu

warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties

Oracle Corporation
World Headquarters
500 Oracle Parkway
Redwood Shores, CA 94065
U.S.A.

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.

Worldwide Inquiries:

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

Phone: +1.650.506.7000

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

Fax: +1.650.506.7200

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

oracle.com