Académique Documents
Professionnel Documents
Culture Documents
Purpose:
This document provides an overview of features and enhancements included in Oracle Fusion Applications 11gR1 Release 11.1.1.10.0 and
applicable updates. It is intended solely to help you assess the business benefits of upgrading your existing Oracle Products to this release, or
implementing completely new Oracle developed products, and planning your I.T. Projects.
Disclaimer:
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to
and use of this confidential material is subject to the terms and conditions of your Oracle Software License and Service Agreement or other
applicable contract with Oracle, with which you agree to comply. This document and information contained herein may not be disclosed,
copied, reproduced or distributed to anyone outside Oracle without Oracle’s prior written consent. This document is not part of your license
agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.
This document is intended to outline our general product direction. It is intended for informational purposes only and solely to assist you in
planning for the implementation and upgrade of the product features described. Release information contained in this document is not a firm
development plan. Release information published here should not be used as the basis for customer delivery commitments, as part of marketing
efforts, or during contract negotiations. This 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, and inclusion or not thereof in the
commercially available version of the Software, if any, is subject to change at any time and is always at Oracle’s sole discretion. This document is
not considered part of the applicable program documentation.
Due to the nature of the product architecture, it may not be possible to safely include all features described in this document without risking
significant destabilization of the code.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 1 of 73
User Guide for HCM Extracts (Release 10 onwards)
Document Control
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 2 of 73
User Guide for HCM Extracts (Release 10 onwards)
Documentation on MOS
Note Details
1960148.1 Central Note for all HCM Extracts Collateral
1677090.1 HCM Extract Step-by-Step Definition Approach and Troubleshooting Guide
1964920.1 Oracle HCM Extracts: Running a Changes-Only Extract
1559127.1 Oracle Fusion HCM Extracts User Guide
- HCM Extracts User Guide
- Release 9 Entity Attributes
- Extracts presentation (ppt)
1573099.1 Oracle Fusion HCM Extracts: Delivery Options
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 3 of 73
User Guide for HCM Extracts (Release 10 onwards)
Contents
Document Control...................................................................................................................................................................................................... 2
1. Overview ................................................................................................................................................................................................................ 6
2. Extract Components............................................................................................................................................................................................... 9
4. Migrating an Extract............................................................................................................................................................................................. 35
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 4 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 5 of 73
User Guide for HCM Extracts (Release 10 onwards)
1. Overview
Use HCM Extracts for archiving, reporting, and as an outbound interfacing tool. HCM Extracts is primarily an outbound integration tool that lets
you choose the HCM Data, it then gathers it from the database, then processes and archives it. HCM Extracts can then convert this archived data
to a format of your choice and deliver to recipients. This document includes information on how you can use the HCM Extract tool to create
outbound interfacing, or reporting.
The Data Exchange work-area allows you to perform tasks related to inbound and outbound interfaces, which allows exchange of data between
different HR systems.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 6 of 73
User Guide for HCM Extracts (Release 10 onwards)
1.1. Tasks
Extract definition contains details of what data you want to extract and the structure in which you need to extract the data, and how you want
to deliver this data (ftp, email, fax, etc) as formatted output (xls, csv, pdf, etc) using BI publisher.
You can copy an extract in the same instance and also export or import extracts.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 7 of 73
User Guide for HCM Extracts (Release 10 onwards)
1.2. Architecture
The extracted data is retrieved from the database, through different means, for example, Fast Formula, Balance Groups and Custom Logic
defined in PLSQL or Java method.
A HCM Extract definition contains records that contain multiple attributes. These records are archived based on Fast Formula Database Item
(DBI) groups, or based on the structure of the balance group, or based on logic defined in PL-SQL or Java method.
The extracted data is archived into result tables and stored as an XML output in the database. This XML output is transformed into formatted
output of HTML, PDF, EFT, XLS, etc and delivered as email, fax, ftp, print, based on the delivery options set up for the extract.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 8 of 73
User Guide for HCM Extracts (Release 10 onwards)
2. Extract Components
The HCM Extracts feature is a flexible tool for generating data files and reports. This topic covers how you can use the extract components to
define what information you want the application to extract and report on. It also explains how the application displays, formats, and delivers
the information.
2.1. Definition
An extract definition refers to the complete setup of an extract, which consists of extract data groups, criteria, records, attributes, advanced
conditions and output delivery options. An extract definition consists of:
o One or more extract data groups, depending on how many logical entities you want to extract.
o One or more extract records depending on how many groups of information you want to collect.
o One or more attributes depending on how many individual fields of data you want to collect.
You use HCM extracts to extract, archive, transform, report, and deliver high volumes of HCM data from the Fusion HCM database. You can
generate the output in a variety of formats like CSV, XML, Excel, HTML, RTF, PDF.
You can distribute the extracted information to destinations like FTP, UCM and by e-mail, fax and other delivery modes (Note that some of these
delivery destinations are not applicable for cloud installations). Some common examples of extracts are: PDF payslips delivered to employees'
mailboxes, payroll or benefits data transferred to third-party service providers, HR and talent data exchange between Fusion and legacy
applications, for example in a coexistence scenario.
2.1.1. Design
Extract data group connections capture the association details between the current data group and the parent data group. The data group
connections form the hierarchical relationship among the data groups.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 9 of 73
User Guide for HCM Extracts (Release 10 onwards)
You can define a set of filtering conditions the application must perform on an extract data group using the extract data group criteria. You
specify the criteria conditions using an expression or fast formula.
2.1.1.3. Attributes
Attributes are the individual fields inside the extract record. An attribute is the lowest attribute level of a HCM extract and represents a piece of
information, for example, person first name, person last name or person date of birth.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 10 of 73
User Guide for HCM Extracts (Release 10 onwards)
For more information see the Oracle Fusion HCM Extracts: Delivery Options whitepaper in MOS: 1573099.1
%m Displays the system date month in two digits: 01-12 (where 01 = January)
%H Displays the system date hour in two digits based on 24-hour day: 00-24
%edy Displays the effective date year in four digits: Example: 2011
%edm Displays the effective date month in two digits: 01-12 (where 01 = January)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 11 of 73
User Guide for HCM Extracts (Release 10 onwards)
%edH Displays the effective date hour in two digits based on 24-hour day: 00-24
Perform the following steps to base the output filename on an attribute of the extract:
1. Add ‘%de’ in the output name where you want the attribute to appear. The tag is replaced with the attribute value.
2. In the additional details section, assign the ‘Run Time File Name’ property of the Delivery Type, with the attribute. This will indicate the
attribute value that should be assigned at the ‘%de’ location.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 12 of 73
User Guide for HCM Extracts (Release 10 onwards)
For the above setup, Department Name is suffixed in the filename. If ‘Vision Corporation’ is the department name, then the extracted output
filename will be ‘File_Vision Corporation’.
Perform the following steps to base the output filename on a parameter value:
b) Assign the ‘Run Time File Name’ property of the delivery type with the attribute.
Perform the following steps to base the output filename on complex logic:
a) Create an attribute of type ‘Rule Based’ which has the underlying logic defined in a Fast Formula.
b) Assign the ‘Run Time File Name’ property of the delivery type with the attribute.
Note: Post sql default is not advisable for effective date defaulting in a recurring schedule.
This table lists the different extract types and why you select them.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 13 of 73
User Guide for HCM Extracts (Release 10 onwards)
EOY Archive Use for end of year archives (HR, Benefits). Development use only
HR Archive Use for all HR archives.
Payroll Archive Use for all payroll or payslip archives. Development use only
Other Payroll Archive Use for all payroll archives.
You can manipulate the output in a changes-only extract to either exclude or include certain attributes, regardless of whether the attribute has
changed or not. For example, by selecting an option to exclude an attribute from comparison, you can ensure that that attribute is not compared
while identifying changes to include in the generated output of the next extract run. Therefore, even if the attribute has changed since the
previous extract run, it will not be included in the output. You can also select an option to always include an attribute in the generated output of
an extract run, even if the attribute has not changed.
2.3.1.1. What's a threading database item and what is its connection to the extract data group?
A threading database item is required for implementing the Changes Only feature. The threading database item is a unique ID in the chosen user
entity (UE). Generally, for Pay Employee UE and Assignment UE it would be DBI with %ASSIGNMENT%ID. For Person UE, it would be DBI with
pattern %PERSON%ID. You can declare one threading database item at the root data group or any child data group level. For example, you
declare the threading database item from the location where you need changes only.
The following table describes the different extract modes, their lookup values and descriptions.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 14 of 73
User Guide for HCM Extracts (Release 10 onwards)
N All attributes Includes all data in the extract. A full extract is run which produces the full data output at
that point of time. The archived data is utilized as a baseline.
Y Changed attributes Compares this extract run with the previous extract runs and by comparing against the
baseline (to identify the incremental data), displays the data that has changed only.
ATTRIBUTE Changed and marked attributes Includes elements that have changed or marked as mandatory
ATTRIB_OLD Changed and marked attributes with Displays elements that have changed or marked as mandatory plus their previous value
previous values
Note
You must run the Payroll Interface with the Attrib_Old mode whenever you use the US
ADP PayForce Third-Party Periodic Extract.
BLOCK_OLD Changed, marked attributes, Displays the following data under threading data group:
previous data under threading group
Changed data
Previous values
BLOCK Changed and marked attributes Displays the following data under threading data group:
under threading group
Changed data
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 15 of 73
User Guide for HCM Extracts (Release 10 onwards)
For more information see the Oracle HCM Extracts: Running a Changes-Only Extract whitepaper in MOS: 1964920.1
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 16 of 73
User Guide for HCM Extracts (Release 10 onwards)
3. Worked Example
This example demonstrates how to create a HCM extract including creating data groups, records, and attributes using the simplified interface.
You create an extract definition to capture the details of what you want to extract, the structure in which the data must be extracted and how
you want to deliver this data. FAST Bank is a global organization with subsidiaries all over the world. As part of an external reporting
requirement, FAST Bank must obtain the department and employee details across the entire company. This information must be sent to a third
party in an XML file and to the HR manager with employee details grouped by department as a Headcount Report.
The following table summarizes the key decisions in this scenario:
How many extracts do I need to create You create one extract definition to define a headcount report.
to produce this type of report?
How many data groups do I need to In this example there are 2 functional groups of information, therefore you create two data groups,
create? one for department and one for employees.
How many records do I need to create? You decide the number of records based on the sub-group of attributes within a data group. In this
example, you create two records for the department data group:
Department Details
Department Summary
You create one record for the Employees data group: Employee Details.
How many attributes do I need to You decide the number of attributes based on the specific information required for that report. In
create? this example, create the following attributes for the Department Details record:
Department Name
Department Location
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 17 of 73
User Guide for HCM Extracts (Release 10 onwards)
Record Code
Report Date
Employee Count
Full Name
Gender
Date of Birth
Salary
Bonus
Tax Rate
Do I need to create any fast formulas? You can use fast formulas at the following levels:
Extract Record level to automatically generate formulas when you use the Generate Formula
option.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 18 of 73
User Guide for HCM Extracts (Release 10 onwards)
Data
Groups
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 19 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 20 of 73
User Guide for HCM Extracts (Release 10 onwards)
2. Click on the Manage HCM Extract Definitions task and select the Create button.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 21 of 73
User Guide for HCM Extracts (Release 10 onwards)
2. Enter FAST Bank Extract, 01/01/2010 and select HR Archive as the extract type, and click ok.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 22 of 73
User Guide for HCM Extracts (Release 10 onwards)
The application creates the definition and you navigate to the Manage HCM Extract Definitions page in the Simplified interface:
The Tag Name field is derived and defaulted automatically based on the extract name you enter (for all levels, such as: definition, parameters,
data groups, records and attributes) and is used while generating the XML output.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 23 of 73
User Guide for HCM Extracts (Release 10 onwards)
3. Click Save and the application saves the extract definition and automatically generates the parameters based on the type of extract. The
parameters control the output of an extract. In this example, the application creates the following parameters:
o Effective Date
o Parameter Group
o Report Category
o Request ID
o Start Date
Note: Use the Switch Layout button to open the extract in the professional interface. Use the professional interface to create and define HCM
extracts without using a drag and drop system. You can perform most of the tasks for defining the extract in the Simplified interface. To enter an
effective date for the extract, you must switch to the professional interface. The session effective date is an effective start date that applies to all
date-effective interactions in the current session.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 24 of 73
User Guide for HCM Extracts (Release 10 onwards)
NOTE: Change the Session Effective Date to a fixed value (for example: 01/01/2000) before you create or update any data. Entities such as
criteria, records, attributes are date effective and dated; therefore if you create or edit the extract setup with different Session Effective Dates
then those entities will have different dates. The extract definition may produce non-uniform archive for different dates.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 25 of 73
User Guide for HCM Extracts (Release 10 onwards)
2. Select the Create icon or use the HCM Data Objects tree to drag and drop a data group into the local area. A data group represents data
that belongs to one or more logical data entities. User Entity (Logical Entity) is the name of the query for fetching the required data, for
example, departments and employees.
The HCM Data Objects tree displays the key DBIs based on the selected extract type and organizes them into a hierarchy for easy
viewing and searching. DBIs are grouped into folders such as Worker, Person, Contacts, and Assignment, which makes it easier for you to
identify or select the required DBI. You can access and search for DBIs that are not available in the HCM Data Objects hierarchy using the
Extracts Attributes section.
Name Departments
Root Data Group Yes (By selecting this checkbox you select this data group as the starting point for the extract execution.)
4. Select Save and create another data group with the following information:
Name Employees
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 26 of 73
User Guide for HCM Extracts (Release 10 onwards)
1. Ensure you enter the following details to create the extract data group connections. Data group connections enable you to define the
master-detail of parent-child relationship between the entities. For example the Department and Employees data groups are linked with
Department ID.
Define the data group criteria for each data group. Data group criteria enables you to specify the filter conditions of what data you want to
archive. You can specify the filter conditions as an expression or fast formula.
Once all data group connections are defined, select each data group available under the Extract Data Group folder and define the criteria and records for each
data group. Using the Extract Data Group Criteria, you can specify the filter conditions of what data you want to extract. Also, you can specify the conditions as
an expression and/or fast formula. You can add data group criteria; click on the ‘Add’ button in the Extract Data Group Criteria table.
You can define data group criteria expression using the Edit icon in ‘Criteria Expression’. Data Group criteria expression is translated into WHERE
clause of SELECT query and provides better performance compared to criteria formula.
You can create data group criteria formula using the ‘Manage Fast Formulas’ UI and by selecting the ‘Extract Criteria’ formula type. The formula
returns a single value called either ‘EXCLUDE’ or ‘INCLUDE’, has a value of ‘TRUE’ or FALSE’ and determines whether to process the record.
More details on Fast formulas can be found here
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 27 of 73
User Guide for HCM Extracts (Release 10 onwards)
1. Select the Department Data Group and ensure it includes the following extract record details. Extract records represent a physical
collection of all required fields. If a data group has 3 records, then you can specify the sequence in which the application processes the
records using the sequence field. You can also select the Next Data Group to identify which data group the application processes next.
2. Select the Configure icon and then Create Record. Complete the general fields, as shown in this table:
Sequence 20 10
3. Save the records and then select the Employees Data Group. Ensure this data group includes the following extract record details.
Sequence 10
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 28 of 73
User Guide for HCM Extracts (Release 10 onwards)
Creating Attributes
1. Select the Departments Details record within the Department Data Group and ensure it includes the following extract attribute details.
3. Select the Department Summary record and ensure it includes the following extract attribute details.
5. Select the Employee Details record within the Employees Data Group and ensure it includes the following extract attribute details.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 29 of 73
User Guide for HCM Extracts (Release 10 onwards)
Type Database Item Group Decoded database item group Database item group
Database Item Group Person Full Name Person Gender Person Date of Birth
Attributes with ‘Database Item Group’ as the type are associated with a fast formula database item that corresponds to SQL query for fetching
the field value (For example: Organization Name, Person Full Name, Job Name, etc.).
You can add conditional actions to records and attributes within a record, that specify an action, such as, log error or warning, to be performed
when the condition is evaluated as true. You can specify a condition as an expression or as fast formula. Define formula using ‘Manage Fast
Formulas’ UI with formula type as ‘Extract Advanced Condition’, and return value of Y or N for output variable DO_ACTION.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 30 of 73
User Guide for HCM Extracts (Release 10 onwards)
1. Select the Deliver icon and then the Add icon to define the delivery options.
3. Ensure you enter the additional information such as, the server, username, and password for the FTP delivery type.
4. Enter FAST Bank Extract as the reporting category and click Submit.
1. View the extract definition details and ensure the structure is valid in the Validate page by selecting the Validate icon.
2. Review any automatically generated connections. Connections are created automatically if the same database items exist across data
groups.
3. Select Export XSD to download the XML Schema Definition (.XSD) file for this extract setup. This exported file contains the structure of
the extract definition: the data groups, records, and attributes. You can view the exported XSD through any browser.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 31 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 32 of 73
User Guide for HCM Extracts (Release 10 onwards)
You can define delivery options for an extract using a BI publisher template, with the following delivery file output types: PDF, XLS, XML, DOC,
and the following delivery modes FTP, email, fax. You can also choose Documents of Record as the delivery mode. This delivery mode enables
you to store the output in the database and allows employees to view online payslips from documents of record. If the XML output is split and
burst as separate files, then you can select the bursting node. For example, if you want all employees to be sent an email with their payslip, then
set the bursting node to Employee_ID.
1. After defining the extract [setup and structure] details, define the formatting or layout options using BI Publisher.
More details on BI Publisher are available here.
Integration of extracts and BIP (the ability to view output directly from extracts UI rather than navigating to BI) is available in Release 4.
This allows users to view the output directly after the extract process is complete.
2. Save the BI report in any of the 'Shared Folders' locations (accessible to all logins), instead of the 'My Folders' location (accessible to the
logged in user only). Users on Release 3 SaaS environments should contact their BI admin to create the required folder structure.
3. Specify the extract delivery option with the BI report path and the process can access the report and show the output directly from the
UI. The suggested values are:
Submitting an Extract
An extract definition automatically creates an extract process (payroll flow) with the same name as the extract. The extract process enables you
to define an execution sequence of multiple tasks, including pre and post tasks.
1. Select the Submit Extracts task and select the FAST Bank Extract process.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 33 of 73
User Guide for HCM Extracts (Release 10 onwards)
2. Select Next.
3. Enter FAST Bank Extract - Jan 2012 as the Payroll Flow (extract process).
5. Select Next. You can specify interaction details if the task is dependent on other tasks with different extract processes. For example, this
task must wait because another task is running.
6. Select Next and review the extract. You can schedule the extract, or run it immediately.
7. Select Submit.
9. Select the View Extract Results task to review the results of the extract run. Search for the FAST Bank Extract process.
10. Select Go to Task for FAST Bank Extract - Jan 2012, click the eyeglasses, and view the report output by selecting the report name.
You can navigate to any data group or record in the extract definition by clicking the links in the navigation tree. To view the complete execution
tree, select the Extract Execution Tree option. This action validates the extract definition setup and the application provides validation messages,
along with fast formula compilation status.
Click on the Export to XML Schema button to download the XML Schema Definition (.xsd) file for this extract setup.
After defining the extract [setup and structure] details, define the formatting or layout options using BI Publisher.
More details on BI Publisher are available here.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 34 of 73
User Guide for HCM Extracts (Release 10 onwards)
4. Migrating an Extract
There are multiple ways in which you can create a copy of an extract, migrate an extract from one instance to another. ‘Copy’ will let you create
a copy of the extract in the current instance, while ‘Export’ along with ‘Import’ lets you migrate the extract to another instance. You can also use
the FSM migration tools to migrate incremental changes, and multiple extract at the same time. Refer to the FSM documentation for more
details.
1. Search and select the extract that you want to export, and select the Export XML Schema button.
2. Select the Save File option and save it to local file system [complete extract definition setup information is downloaded as XSD file].
3. Select the instance where you want to export this extract, and select the Import XSD File button.
4. Specify the new extract definition name, select the legislative data group and the XSD file you downloaded earlier, and click on Ok. The
application creates a new extract and you can query the extract from the search region.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 35 of 73
User Guide for HCM Extracts (Release 10 onwards)
You can:
View and modify the flow pattern using the Refine HCM Extracts task.
Search for existing flow patterns and select Edit to view or modify.
Modify the sequence in which you want to execute these tasks (if needed).
Define additional parameters to use across multiple tasks in the flow pattern (if needed).
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 36 of 73
User Guide for HCM Extracts (Release 10 onwards)
Edit parameters by selecting the required parameter row and clicking on the Edit Icon.
When a Parameter is created in HCM Extracts Setup UI it is automatically visible in the flow to refine. If you want to associate a common lookup
with the parameter, then select the required parameter, and click on the Edit Icon on the top of table.
Select Display Format and choose ‘Lookup Choice List’. In the lookup field provide the common lookup code you want to display. This lookup is
displayed for the parameter when you submit the process.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 37 of 73
User Guide for HCM Extracts (Release 10 onwards)
For example, you might have an extract that retrieves data based on an effective date. In the Refine HCM Extracts UI, you need to specify the
Context Binding for the ‘Effective Date’ parameter with parameter basis as ‘Context Binding’, and Basis Value as ‘System Date’. Setting these
parameters ensures that the dates the application derives from the defaulted date parameter are incremented appropriately.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 38 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 39 of 73
User Guide for HCM Extracts (Release 10 onwards)
2. Write formula to return number of days as gap. In this case since we require 5 minutes, return, ((1/24)/60)*5 days as return value for
flow schedule formula.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 40 of 73
User Guide for HCM Extracts (Release 10 onwards)
3. Follow same steps to Submit HCM Process, including below values in ‘Schedule’ section.
The instance is generated every 5 minutes from when the process is submitted.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 41 of 73
User Guide for HCM Extracts (Release 10 onwards)
7. Other details
7.1. View HCM Process
View HCM process allows you to view the results of an extract run. Search for the different runs of extract by entering the Flow Pattern name.
Select the flow instance name to display the status page and select the Go to Task icon to show the report output.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 42 of 73
User Guide for HCM Extracts (Release 10 onwards)
Enter the Payroll Flow name to indicate it to be a Roll back run instance. Select the Payroll Process Lookup and select the Payroll Flow or Instance
that you want to roll back. This Payroll Flow or Flow Instance can be Changes-Only run also. Submit the flow and select the ‘Ok and View
Checklist’ option.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 43 of 73
User Guide for HCM Extracts (Release 10 onwards)
3. Provide a unique free text value for the Payroll Flow field.
4. Provide a valid DDF or EFF name for 'Name' and valid context related to the EFF typed in for 'Context'.
A list of the most frequently used flex-fields which support the above:
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 44 of 73
User Guide for HCM Extracts (Release 10 onwards)
The flows infrastructure has web services to (1) run, (2) check the status and (3) rollback. The same web services can also be used to submit an
extract, check the status of an extract and rollback an extract run.
For more details on the web services, refer to the payroll flows documentation.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 45 of 73
User Guide for HCM Extracts (Release 10 onwards)
The following table lists the different types of formula you can use for extracts:
Extract Criteria Formulas of this type will be listed in the Data Group Criteria Fast formula list, can be used for specifying complex criteria
which indicates if record should be extracted or not
Extract Rule Formulas of this type will be listed in the Rule type Attributes Fast formulas list can be used for deriving/calculating attribute
value if it is based on complex logic or business rules
Extract Formulas of this type will be listed in the Record/Attribute Advanced conditions Fast formulas list can be used for specifying
Advanced complex conditions which indicates if actions (eg: log error/warning) should be raised.
Condition
Extract Record Formulas of this type will be generated automatically when using ‘Generate Formula’ option in Extract Records.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 46 of 73
User Guide for HCM Extracts (Release 10 onwards)
You can query/view/edit/create formulas from this UI. Fast formula can contain any complex business logic, and you can use it along with
extracts.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 47 of 73
User Guide for HCM Extracts (Release 10 onwards)
Enter the relevant fast formula details and select the Continue button. Enter the formula text in the Manage Formula details page.
Extract Rule formula should have value returned through variable ‘RULE_VALUE’
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 48 of 73
User Guide for HCM Extracts (Release 10 onwards)
Similarly extract criteria (data group criteria) formula should have value returned through variable INCLUDE/EXCLUDE and return value as
TRUE/FALSE.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 49 of 73
User Guide for HCM Extracts (Release 10 onwards)
/*****************************************************************************
FORMULA NAME: Sample Flow Schedule
FORMULA TYPE: Flow Schedule
DESCRIPTION: Formula to return a date time.
Returns NEXT_SCHEDULED_DATE;
Formula Results:
NEXT_SCHEDULED_DATE This will be a date time value with yyyy-MM-dd HH:mm:ss format.
*******************************************************************************/
/* Inputs */
INPUTS ARE SUBMISSION_DATE(DATE), SCHEDULED_DATE(DATE)
/* Calculations */
NEXT_SCHEDULED_DATE = ADD_DAYS(SCHEDULED_DATE,0.00347)
/* Returns */
RETURN NEXT_SCHEDULED_DATE
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 50 of 73
User Guide for HCM Extracts (Release 10 onwards)
===
2) Sample Data Group Criteria Formula to filter based on runtime Relationship Attribute1.
Use case: Here Periods of Service customer flex stores Payroll Provider in ATTRIBUTE1.
a) Create Extract Parameter of text type, with name 'Provider Name' and Ess Parameter name as 'Provider_Name'.
b) Formula to filter based on runtime DEP_NAME
In the scenarios above, there is a known issue if Payroll Provider Name or Department Name has a space. Ensure that you truncate the
parameter until first space; otherwise the results might have a different output. The following bug needs to be fixed to resolve the issue.
BUG 15921815 - RUP3MAINTAINANCE: SPACE IS NOT WORKING PARAMETERS, UNABLE TO GET SENTENCES
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 51 of 73
User Guide for HCM Extracts (Release 10 onwards)
INCLUDE = 'FALSE'
RETURN INCLUDE
Get Contact Person Id via Attribute, set PERSON_ID context to Contact Person Id, Get DBI Value of Primary NID to get NID of contact effectively.
By this way you can get any information related to contact.
a) Create an attribute with dbi as 'Extract Contact Person Id’, with short code as 'CONTPID'.
b) Create an 'Extract Rule' Type Formula (CONTACT_NID_FF) with the following text:
X = DATA_ELEMENTS['CONTPID']
CHANGE_CONTEXTS(PERSON_ID = TO_NUMBER(X) )
(
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 52 of 73
User Guide for HCM Extracts (Release 10 onwards)
RULE_VALUE = PER_PER_PRIMARY_NID_NUMBER
)
RETURN RULE_VALUE
c) Create Rule type attribute (with Name: Contact NID) as sibling of attribute created in (1) .
Associate CONTACT_NID_FF as fast formula.
Get Contact Person Id via Attribute, set PERSON_ID context to Contact Person Id, Get DBI Value of Person Local Name to get Local Name
of contact effectively. By this way you can get any information related to contact.
a) Create an attribute with DBI as 'Extract Contact Person Id’, with short code as 'CONTPID'.
b) Create an 'Extract Rule' Type Formula (CONTACT_LOCNAME_FF) with the following text:
X = DATA_ELEMENTS['CONTPID']
CHANGE_CONTEXTS(PERSON_ID = TO_NUMBER(X) )
(
RULE_VALUE = PER_PERSON_LOCAL_FULL_NAME
)
RETURN RULE_VALUE
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 53 of 73
User Guide for HCM Extracts (Release 10 onwards)
c) Create Rule type attribute (with Name: Contact Local Full Name) as sibling of attribute created in (1) .
Associate CONTACT_LOCNAME_FF as fast formula
You can get availability details of a person using predefined fast formula function between a start date and an end date.
SDATE = TO_DATE(SUBSTR(TRANSLATE(DATA_ELEMENTS['StartDate'],
'01234567890:.-TZ', '01234567890:.- '), 1, 19), 'YYYY-MM-DD HH24:MI:SS')
EDATE = TO_DATE(SUBSTR(TRANSLATE(DATA_ELEMENTS['EndDate'],
'01234567890:.-TZ', '01234567890:.- '), 1, 19), 'YYYY-MM-DD HH24:MI:SS')
RETURN RULE_VALUE
Create a root data group with Assignment User entity, which sets context of Person Id. PER_EXT_CONT_FIRST_NAME will return you array of
contact names associated with the person.
Create a Rule Element with the following code and associate it with a attribute (Contact Names) in root data group.
I=1
N=''
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 54 of 73
User Guide for HCM Extracts (Release 10 onwards)
I=1
MAXTDATE = '01-JAN-0001' (date)
@ DEFAULTDATE = '01-JAN-0001' (date)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 55 of 73
User Guide for HCM Extracts (Release 10 onwards)
) ELSE (
RULE_VALUE = TO_CHAR(MAXTDATE ,'YYYY/MM/DD')
)
RETURN RULE_VALUE
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 56 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 57 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 58 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 59 of 73
User Guide for HCM Extracts (Release 10 onwards)
This Plug-in provides sample documents, demos, templates and Template Viewer. These will help you understand the concepts and also create
templates (EFT, RTF, etc.) to view formatted output of XML.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 60 of 73
User Guide for HCM Extracts (Release 10 onwards)
After installing the BI Publisher plug-in for MS Word, you can find the Oracle BI Publisher option in the ‘Add-Ins’ tab. Use the ‘Add-ins’ option to
load the structure of data (XSD) using ‘Load XML Schema’ option.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 61 of 73
User Guide for HCM Extracts (Release 10 onwards)
After the ‘Load XML Schema’ is complete, you can arrange fields in the required layout and format, and upload the template to BI Publisher as
mentioned below.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 62 of 73
User Guide for HCM Extracts (Release 10 onwards)
You can use the existing standard data model available at this folder location: /Human Capital Management/Payroll/Data
Models/globalReportsDataModel.
This data model contains SQL query to get XML output taking flow instance run name as parameter.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 63 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 64 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 65 of 73
User Guide for HCM Extracts (Release 10 onwards)
There are many options available for defining the layouts of a report.
Based on template uploaded, which can be based on RTF, PDF, etc. created using MS Word plugin
Based on Basic Templates and inbuilt layout editor available in BI Publisher Enterprise
You can upload the earlier defined BI publisher RTF template, and test the layout by clicking on ‘View Report’ and you can view the output in the
required file format.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 66 of 73
User Guide for HCM Extracts (Release 10 onwards)
The contents of the Report Layout are displayed below. You can download this report as a pdf file by clicking on the ‘PDF’ option.
The latest data model has the flow instance name parameter along with the Payroll Action ID. The flow instance name is the name of the flow
pattern run which was provided earlier when submitting the extract.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 67 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 68 of 73
User Guide for HCM Extracts (Release 10 onwards)
You can upload other templates (for EFT) by defining the layout in MS-Word. You can use the EFT template for generating fixed length delimited
text files.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 69 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 70 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 71 of 73
User Guide for HCM Extracts (Release 10 onwards)
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 72 of 73
User Guide for HCM Extracts (Release 10 onwards)
Test the layout by clicking on ‘View Report’ and view the output in the required file format.
The latest data model has the flow instance name parameter along with the Payroll Action ID. The flow instance name is the name of the flow
pattern run given earlier when submitting the extract.
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 73 of 73