Guide For HCM Extracts: Oracle Online Training Materials - Usage Agreement

Guide for HCM Extracts
Oracle Online Training Materials – Usage Agreement
Use of the information, documents and online training courses (collectively, “Materials”) found on this area of the Site constitutes agreement
with the following terms and conditions (as well as those set forth in the Purpose and Disclaimer sections below):
1. Oracle is pleased to allow its business partner (“Partner”) to download and copy the Materials found on this area of the Site. The Materials are
proprietary information of Oracle. Partner or other third party at no time has any right to resell, redistribute or create derivative works from the
Materials. The use of the Materials is restricted to the non‐commercial, internal training of the Partner’s employees only. The Materials may not
be used for training, promotion, or sales to customers or other partners or third parties.
2. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
3. Oracle disclaims any warranties or representations as to the accuracy or completeness of any Materials. Materials are provided "as is"
without warranty of any kind, either express, implied or statutory, including without limitation the implied warranties of merchantability,
satisfactory quality, fitness for a particular purpose, accuracy, timeliness and non‐infringement of third‐party rights. The information contained
herein is subject to change without notice.
4. Under no circumstances shall Oracle be liable for any loss, damage, liability or expense incurred or suffered which is claimed to have resulted
from use of these Materials. As a condition of use of the Materials, Partner agrees to indemnify Oracle from and against any and all actions,
claims, losses, damages, liabilities and expenses (including reasonable attorneys' fees) arising out of Partner’s use of the Materials.

Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle Proprietary and Confidential. Page 1 of 112


Purpose:
This document provides an overview of features and enhancements included in Oracle Fusion Applications 11gR1 Release 11.1.1.5.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.

Document Control
Change Record
Date Author Version Change Reference
10-April-2012 Ventrapragada Rajasekhar/ Parag 0.1 First Release

Jain/Shesha Shila Bharadwaj R
04 July- 2012 Parag Jain 0.2 Details of ‘Changes Only’ functionality
29-Aug-2012 Parag Jain 0.3 Note added for Delivery Option setup under sub-point-20 of Manage HCM
Extract Definition
23-Oct-2012 Ventrapragada Rajasekhar 0/4 Details on Copy and Export/Import functionality
16-Jan-2013 Shesha Shila Bharadwaj R 0/5 Corrected Document and added Criteria Formula , Rollback
19-Mar-2013 Shesha Shila Bharadwaj R 0/6 Added Section on Recursive Scheduling
21-Mar-2013 Shesha Shila Bharadwaj R 0/7 Add Changes Only Attribute level features.
13-May-2013 Shesha Shila Bharadwaj R 0/8 Added Generating DBI for flex fields
0-June-2013 Alison Firth 0/9 Edited guide for publication to MOS


Contents
Overview ........................................................................................................................................................................................................................ 6
Tasks related to Extracts: ........................................................................................................................................................................................... 7
Architecture ............................................................................................................................................................................................................... 8
Case Study: Fast Bank wants to set up and run HCM Extract ........................................................................................................................................ 9
Manage HCM Extract Definitions ................................................................................................................................................................................. 10
Refine HCM Extracts [Optional Setup] ......................................................................................................................................................................... 50
Submit an HCM Extracts .............................................................................................................................................................................................. 55
Submit an HCM Extracts – Recursive Scheduling ..................................................................................................................................................... 62
View HCM Process ....................................................................................................................................................................................................... 67
Rollback Payroll Run ..................................................................................................................................................................................................... 69
How to define Fast Formulae ....................................................................................................................................................................................... 70
Sample Formula ....................................................................................................................................................................................................... 74
How to set‐up Changes Only data extract ................................................................................................................................................................... 80
Changes Only Modes ............................................................................................................................................................................................... 81
Generating DBI for flexfields ........................................................................................................................................................................................ 85
Integration with BI Publisher ....................................................................................................................................................................................... 87
Installing BI Publisher Plug‐in ................................................................................................................................................................................... 89
Defining the report .................................................................................................................................................................................................. 93
Appendix .................................................................................................................................................................................................................... 106

Sample Scenario of using changes only (Attribute Only mode) ............................................................................................................................ 106

Overview
Use HCM Extracts for archiving, reporting, and as an outbound interfacing tool. This document includes information on how you can use the HCM Extract tool
to create Out Bound 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.

Tasks related to Extracts:
‐ Manage HCM Extract Definitions
Define new extracts, edit/modify or delete the existing extracts
Extract definition contains details of what data should be extracted and the structure in which data needs to be extracted, and how this data should
be delivered (ftp, email, fax, etc) as formatted output (xls, csv, pdf, etc) using BI publisher
‐ Refine HCM Extracts (optional step)
When we create an extract, the application creates a flow pattern (i.e. checklist) automatically, which includes a task for executing the extract.
We can refine the flow by adding pre or post tasks that need to be executed along with data extraction.
‐ Submit HCM Process
Submit the extract for processing after entering the parameter values. If the extract definition contains delivery options that specify an output format
and delivery method (email, ftp, etc), then the output will be generated through the integration with BI Publisher application.
‐ View HCM Process Results (optional step)
Archived output stored in tables can be viewed at anytime through Results UI.

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 (grouping of attributes) that contain multiple data elements (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, etc based on the delivery options set up for the extract.

Case Study: Fast Bank wants to set up and run HCM Extract
FAST Bank is a global organization with subsidiaries all over the world. It requires a headcount report with department and employee details. The employee
information needs to be grouped at each department level. They need to distribute this report through FTP to 3rd Party as XML/Flat file, and emailed to the HR
manager. To generate this report, FAST Bank must define an extract and run it using the HCM Extract tool within Fusion HCM.

Fast Bank Extract Design
This Extract consists of 2 logical entities or blocks (i.e. Departments, Employees), which consists of few records in each block and different type of data
elements.
Block represents a logical entity, which contains SQL query for getting data, For example: Organizations, Persons, Employees, etc.
Block links allow you to define the parent‐child relationship between the entities. For example: you can link Department and Employee blocks through
Department_ID.
Record is a collection of fields (data elements) which should be archived/extracted.


Manage HCM Extract Definitions
1) Click on the Data Exchange workarea to perform tasks related to extracts.


2) Data Exchange workarea has 4 tasks (as mentioned above) related to HCM Extracts.


3) Click on ‘Manage HCM Extract Definitions’.
‐ search for existing extracts and click on Name to view/edit
‐ or click on ‘Create’ to define a new extract

4) Provide a name for the extract definition, and select the type of extract and save the definition.
The Tag Name field is derived and defaulted automatically based on the extract name you enter (for all level i.e. definition, parameters, blocks, records
and data elements) and will be used while generating the XML output.
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, data elements etc. date effective and dated, so in case you are creating/editing the extract setup with different Session Effective Dates then those
entities will get created with different dates. This will cause extract definition to produce non‐uniform archive for different dates.

5) After you save the extract definition and based on the type of extract selected, the application automatically creates a number of parameters. You can
optionally add/edit/delete additional parameters from the parameters table region. These parameters can be used in the filter conditions, calculations or
extracted as data elements.
6) Click on the ‘Extract Block’ folder on the left hand side navigation tree. The Extract Blocks region opens.
Click on ‘Create’ to define a new block.
A block represents a logical entity, which contains SQL query for fetching data, for example, data such as: organizations, persons, employees.



7) Provide details for the block and click on ‘Save and Create Another’ to define the next block.
Create all the blocks needed for this Extract.
Mark the starting or parent block from where you want the extraction to start using the Root Block option.
User Entity (Logical Entity) is the name of the query for fetching the required data, for example, departments and employees.
Frequently used User Entities:

• Person: PER_EXT_SEC_PERSON_UE
o To get all persons across the enterprise, and
o To get all person related attributes):
• Worker: PER_EXT_SEC_PERSON_UE
o To get all workers across the enterprise, and
o To get all person, worker (relationship, term, assignment) related attributes
• Worker Payroll: PER_EXT_PAY_EMPLOYEES_UE
o To get all workers and their payrolls across the enterprise, and
o To get all person, worker (relationship, terms, assignment), payroll
(relationship, term, assignment) related attributes and Element entry data


8) Create the second block for this case study, and click on ‘Save and Close’.
9) Once all blocks are created – then click on ‘Extract Block’ folder in the navigation tree to view Extract Blocks.
Select each child block record in ‘Extract Blocks’ table and define Block Link details.
Block links enable you to define the master‐detail of parent‐child relationship between the entities, for example, employee and department blocks are

linked with Department_ID.

10) Once all block links are defined, select each block available under the Extract Block folder and define the criteria and records for each block. Using the
Extract Block 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. To add block criteria; click on the ‘Add’ button in the Extract Block Criteria table.


11) You can define block criteria expression using the Edit icon in ‘Criteria Expression’.
Block criteria expression is translated into WHERE clause of SELECT query and provides better performance compared to criteria formula.
You can create block 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


12) Create an extract record by selecting the Create button in the Extract Records table of the Extract Block details page (screen shot step 9).
An extract record is a physical collection of fields (data elements) which you want to extract.
Provide the following details: the type of record (Header/Trailer/Details) and the process type: fast formula/balance group/custom logic.
If a block has 3 records, then the application uses the sequence value to identify the processing order, and the next block value to identify
the next block to process.


13) Saving the record enables you to select the Create button in the ‘Data Elements’ table.
Data Elements are the individual fields inside the record. Provide the following details: the type (DBI group), rule, decoded element, and the string, and
the required fields based on the selected type. The record output is stored in a table with 300 columns and the location of this field is captured in the
Output Column value.
Click on ‘Save and Create Another’ to define all the data elements in this record.

Data elements with ‘Database Item Group’ as the type (refer box above) 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 all the required data elements of the record one individually using the ‘Save and Create Another’ option.

You can add conditional actions to records and data elements 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.


14) Once all the data elements (fields) of record are defined, then you can generate and compile the Fast formula which contains the code for extracting this
record data.
Note: As well as using the ‘Compile Formula’ option you can also define the complete extract and generate fast formulas. Note the Generated Fast Formula
names [as shown in above screenshot] and use the Navigator menu ‐ Payroll Calculation workarea – Manage Fast Formulas UI – Search by giving the Formula
Name and LDG, edit the formula and click on ‘Compile’ option. More details on Fast formulas can be found here


15) Similarly define other blocks, criteria, records and data elements.
a. Block criteria for Employees block
b. Create records within the Employees block.



c. Create a data element for Full Name within the Employees block.


d. Create a data element for Date of Birth within the Employees block.


e. Create a data element for Gender within the Employees block. You create the Gender data element as a Decoded Database Item group, because
this type of element allows you to decode the value returned by the DBI group.


f. Create a data element for Salary within the Employees block.


g. Create a data element for Bonus within the Employees block. You create the Bonus data element as a ‘Record calculation’ type, because this type
of data element allows you to define an expression based on other data elements and parameters.


h. Create a data element for Tax Rate within the Employees block. You create the Tax Rate data element as a ‘Rule’ type. Data elements with a type
value of ‘Rule’ (refer to the screenshot) will be associated with fast formula. You can define fast formula using the ‘Manage Fast Formulas’ UI with
formula type as ‘Extract Rule’. The formula contains the logic for calculating the value you want to extract from the data element.

More details on Fast formulas can be found here


i. Click on the Create option of the Extract Records table to create additional records in the Departments Block.


j. Create an extract record for Department Summary within the Departments block.


k. Create data elements within the Department Summary record.


l. Create data element for Record Code within the Department Summary record.


m. Create data element for Report Date within the Department Summary record.


n. Create data element for Employee Count within the Department Summary record.


16) You can navigate to any block 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 XSD button to download the XML Schema Definition (.xsd) file for this extract setup.



You can view the exported XSD through any browser. The file contains the structure of the extract definition, blocks, records, and data dlements


17) 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.
18) You can define the delivery options for an extract by specifying the BI publisher template, delivery file output type (PDF/XLS/XML/DOC) and delivery mode
(FTP/email/fax). The delivery mode can also be Documents of Record which allows you to store the output in the database (for example, this allows
employees to view online pay slips from documents of record).
You can specify a bursting node if you want to split and burst the XML output into separate files. For example: if you want all employees to receive a
payslip as an email then you can set the bursting node to Employee_ID.
Note: You can also view the formatted output directly from the BI Publisher.
19) Based on the type of delivery mode you select, you may need to provide additional details. For example, if you select FTP as the delivery type, then you
must provide the server, username and password details.



20) Once all delivery options are defined, you can associate them with different reporting categories.
Important Note for Delivery Options Setup:
1. 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:
a. Report path: /Custom/Human Capital Management/ReportName.xdo
b. Template name: Layout name given in the BI Report
c. Delivery type: None
4. Run the extract and view the output through the View HCM Process.

Copying an Extract
You can use the Copy facility to make copy of an existing extract.
‐ Search and select the extract that you want to copy, and click on the Copy button.
‐ Specify the new extract definition name, and click on Ok.
‐ A new extract is created and displayed in the search list, (extract definition including parameters, blocks, records, data elements are also copied copied).

Export/Import of Extract
You can create a copy of an existing extract within the instance or across instances (i.e. Test to Production instance – instead of re‐creating the complete
extract manually), then you can use the Export‐Import option.

‐ Search and select the extract that you want to export, and select the Export XSD File button.
‐ Select the Save File option and save it to local file system [complete extract definition setup information is downloaded as XSD file].

‐ Select the instance where you want to export this extract, and select the Import XSD File button.
‐ 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.


Refine HCM Extracts [Optional Setup]
1) After you define an extract a flow pattern is automatically created with the same name as the extract. The flow pattern enables you to define an execution
sequence of multiple tasks, and enables you to add any pre or post tasks along with extraction of data (default task that is created automatically).
You can view and modify the flow pattern using the Refine HCM Extracts task. You can search for existing flow patterns and select Edit to view or modify.


2) You can add additional (pre or post) tasks (if needed).


3) You can modify the sequence in which you want to execute these tasks (if needed).


4) You can define additional parameters to use across multiple tasks in the flow pattern (if needed).
You can also edit parameters by selecting the required parameter row and clicking on the Edit Icon.

5) 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.


Submit an HCM Extracts
1) A flow pattern with the same name as the extract is automatically created when you define an extract.
You can run the flow pattern directly using the Submit an HCM Process option. You can also access this task from the Navigator menu> Payroll Checklist
workarea> Submit a Process or Report.


2) Specify the name for the current flow run (Flow Instance) and the parameter values, and select Next.


3) If this task is dependent on other tasks from different flow patterns, then you can specify interaction details (Optional).
For example, if you would like this task to wait because another task is running, then select ‘Next’.


4) Review the Extract and click on ‘Submit’.


5) Select OK or OK and View Checklist to view the process status.


6) If you selected to view the checklist, then the status displays.

7) Review the Status column, if the status does not indicate a green tick, then you can refresh the status by clicking on the refresh icon. Repeat this process
until the green ticks appear against all the rows. If the process takes too long, then you can query the status of any extract executed earlier by using the
View an HCM Process option.

Submit an HCM Extracts – Recursive Scheduling
You can select the following options for recursive scheduling: Daily, Weekly, and Monthly. If you want to create your custom schedule, you need
to create a Fast Formula of type ‘Flow Schedule’. You can create a custom schedule by creating a fast formula with Flow Schedule and return
when next flow has to be run i.e gap in days.
Use Case: You require recursive scheduling for every 5 minutes.
Steps to follow:
a) Create a fast formula with Flow Schedule as the type.

b) 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.


/*****************************************************************************
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
/* End Formula Text */

c) Follow same steps to Submit HCM Process, including below values in ‘Schedule’ section.

d) The instance is generated every 5 minutes from when the process is submitted.

View HCM Process
1) 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.


2) Select the flow instance name to display the status page and select the Go to Task icon to show the report output.

Rollback Payroll Run
1) Open Payroll Checklist >Submit a Process or Report, select the ‘Roll Back Process’ task.
2) 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.

How to define Fast Formulae
You can launch the Manage Fast Formulas UI from the Navigator Menu – Payroll Calculation workarea ‐ > Clicking on task ‘Manage Fast Formulas’.
The following table lists the different types of formula you can use for extracts:
Formula Type Description
Extract Criteria Formulas of this type will be listed in the Block 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 Data Elements Fast formulas list can be used for deriving/calculating data element value
if it is based on complex logic or business rules
Extract Advanced Formulas of this type will be listed in the Record/Data Element Advanced conditions Fast formulas list can be used for specifying complex
Condition conditions which indicates if actions (eg: log error/warning) should be raised.
Extract Record Formulas of this type will be generated automatically when using ‘Generate Formula’ option in Extract Records


1) 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.
2) Enter the relevant fast formula details and select the Continue button. Enter the formula text in the Manage Formula details page.

[Sample Extract Rule formula text is given below]

.
Extract Rule formula should have value returned through variable ‘RULE_VALUE’
Similarly extract criteria (block criteria) formula should have value returned through variable INCLUDE/EXCLUDE and return value as TRUE/FALSE.

[Sample Extract Criteria formula text is given below]


Sample Formula

Block Criteria Formula:
1) Sample Block Criteria Formula to filter based on runtime Department Name.
a) Create Extract Parameter of text type, with name DEP_NAME.
b) Formula to filter based on runtime DEP_NAME
DEFAULT FOR PER_ASG_ORG_NAME IS ' '
dept_name_from_dbi = PER_ASG_ORG_NAME
dept_name_from_param = GET_PARAMETER_VALUE('DEP_NAME')
IF dept_name_from_dbi = dept_name_from_param THEN (
INCLUDE = 'TRUE'
)ELSE (
INCLUDE = 'FALSE'
)
return INCLUDE
===
2) Sample Block 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
DEFAULT FOR PER_REL_ATTRIBUTE1 IS ' '
rel_attribute1_from_dbi = PER_REL_ATTRIBUTE1
provider_param = GET_PARAMETER_VALUE('Provider_Name')
IF rel_attribute1_from_dbi = provider_param THEN (
INCLUDE = 'TRUE'

)ELSE (
INCLUDE = 'FALSE'
)
return INCLUDE
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
3) Block Criteria Formula to deal with Multi Row Data.
DEFAULT FOR "PER_EXT_CONT_CONTACT_TYPE" IS ' '
INPUTS ARE "PER_EXT_CONT_CONTACT_TYPE" (text)

INCLUDE = 'FALSE'

IF ("PER_EXT_CONT_CONTACT_TYPE" = 'M' ) THEN (
INCLUDE = 'TRUE'
)

RETURN INCLUDE


Rule type Formula:

1) Use case: Get Primary NID of Contact
Get Contact Person Id via Data Element, 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 a data element with dbi as 'Extract Contact Person Id’, with short code as 'CONTPID'.

b) Create a 'Extract Rule' Type Formula (CONTACT_NID_FF) with the following text:

DEFAULT FOR DATA_ELEMENTS IS EMPTY_TEXT_TEXT

DEFAULT FOR PER_PER_PRIMARY_NID_NUMBER IS ' '

INPUTS ARE DATA_ELEMENTS (TEXT_TEXT)

X = DATA_ELEMENTS['CONTPID']

CHANGE_CONTEXTS(PERSON_ID = TO_NUMBER(X) )
(
RULE_VALUE = PER_PER_PRIMARY_NID_NUMBER
)

RETURN RULE_VALUE

c) Create Rule type data element (with Name: Contact NID) as sibling of data element created in (1) .
Associate CONTACT_NID_FF as fast formula.

2) Use case: Get Contact Full Name
Get Contact Person Id via Data Element, 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 a data element with DBI as 'Extract Contact Person Id’, with short code as 'CONTPID'.

b) Create a 'Extract Rule' Type Formula (CONTACT_LOCNAME_FF) with the following text:


DEFAULT FOR PER_PERSON_LOCAL_FULL_NAME IS ' '


X = DATA_ELEMENTS['CONTPID']

CHANGE_CONTEXTS(PERSON_ID = TO_NUMBER(X) )
(
RULE_VALUE = PER_PERSON_LOCAL_FULL_NAME
)

RETURN RULE_VALUE

c) Create Rule type data element (with Name: Contact Local Full Name) as sibling of data element created in (1) .
Associate CONTACT_LOCNAME_FF as fast formula
3) Use Case: Using Predefined Formula Functions.
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')

RULE_VALUE = to_char(GET_PAY_AVAILABILITY('ASSIGN',SDATE ,EDATE,'Y','Y','N','N','H'))
RETURN RULE_VALUE
4) Use Case: Working with Array DBI’s
Get all Contact Names, comma appended as single item.
Create a root block 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 data element (Contact Names) in root block.
DEFAULT_DATA_VALUE for PER_EXT_CONT_FIRST_NAME IS ' '

I = 1
N = ' '
WHILE PER_EXT_CONT_FIRST_NAME.EXISTS(I) LOOP
(
IF I <> 1 THEN
(
N = N || ','
)
N = N || PER_EXT_CONT_FIRST_NAME[I]

I = I + 1
)
RULE_VALUE = N
RETURN RULE_VALUE
5) Use Case: Using loop to iterate and get value
You can get the last termination date of an employee.

DEFAULT_DATA_VALUE for PER_HIST_ASG_REL_ACTUAL_TERM_DATE IS '01‐JAN‐0001'
(DATE)

I = 1
MAXTDATE = '01‐JAN‐0001' (date)
@ DEFAULTDATE = '01‐JAN‐0001' (date)

WHILE PER_HIST_ASG_REL_ACTUAL_TERM_DATE.EXISTS(I) LOOP
(

IF ( PER_HIST_ASG_REL_ACTUAL_TERM_DATE[I] > MAXTDATE ) THEN (
MAXTDATE = PER_HIST_ASG_REL_ACTUAL_TERM_DATE[I]
)
I = I + 1
)

IF ( MAXTDATE = DEFAULTDATE ) THEN (
RULE_VALUE = ' '
) ELSE (
RULE_VALUE = TO_CHAR(MAXTDATE ,'YYYY/MM/DD')
)

RETURN RULE_VALUE

How to setup Changes Only data extract
1) Navigate to the extract definition, and add an extract parameter called Changes Only by clicking on ‘Add’ button. Note: You must enter the value of ‘ESS
Parameter’ as ‘CHANGES_ONLY’ in upper cases without any spelling mistakes.
2) Set up multi threading database item in any one of the blocks.
If you are choosing PAYROLL_RELATIONSHIP_ID equivalent DBI as the threading database item (present in user entity), then you need to select the
threading action type as "Relationship actions". If you are choosing any unique DBI item other than Payroll Relationship Id, then you can use ‘Object
Actions’.
For example: if you select the PER_EXT_PAY_EMPLOYEES_UE user entity, then you can have threading database item as
‘PER_EXT_PAY_HR_ASSIGNMENT_ID’ and threading action type as 'Object Actions'.
Note: This step should be performed for a new extract block only. You cannot modify existing extract blocks to add a threading database item.

3) Run the Extract Definition with CHANGES_ONLY='N' now, so that it produces XML with complete data.
4) Run the extract with CHANGES_ONLY='Y' to fetch the data that has been corrected or updated since the last run only. If any data changes are observed
from a previous run, then those changes would reflect in the generated XML only.
Changes Only Modes
There are four modes for Changes Only. Changes Only Modes (c), (d) mentioned below will only work from REL5 onwards.
a) Full Extract (N: ‘No, display full details’)
If you run an extract with Changes Only value as ‘N’, then it would be a full extract, and, therefore entire data would be extracted in the system.
Generally you need to run extract as ‘N’ for first time and there after choose other modes of Changes Only.
b) Changes Only at block level (Y:’Yes, display all details’)
If you run an extract with Changes Only value as ‘Y’, only data that has changed from a previous run would be extracted. In this case, even if a single
attribute is changed, entire attributes of the block would be extracted (even if other attributes are not changed).
c) Changes Only with attribute level changes (ATTRIBUTE:’ Yes, display new and mandatory details’)
If you run an extract with Changes Only as ‘ATTRIBUTE’, the extract would return all changes from a previous run and only attributes which are
changed will be extracted.
For this mode to work, you must perform a few extra steps while defining data elements.
Step 1:
For each block defined in the extract, you must highlight at least one data element in the block as a Key Data Element. The data element you choose
must be unique (for example: Assignment Id, Person Id, Person Number, Citizenship Id, Visa Id, Phone Id). It would be ideally primary key for the user
entity you are choosing. For example: for Assignment and Pay Employee User Entity it would be Assignment Id and for Person User Entity it would be
Person Id.

Step 2:
For each block you define in an Extract, highlight at least one data element as Changed Data Element. The data element you choose should be an
attribute which always displays and will be used to identify the record for which data has changed. For example, Person Number, Person Name is the
attribute which will be required to identify whose record has changed.

.

d) Changes Only with attribute changes and old values (ATTRIB_OLD:’ Yes, display new, old, mandatory details’)
If you provide value of Changes Only as ‘ATTRIB_OLD’, this option extracts only attributes changed from a previous run along with its old and new
value. You need to perform the same steps as in (c) for this mode to work.
Sample XML Output with ATTRIBUTE changes:

A sample scenario of attribute level changes is provided in the Appendix section.

Generating DBI for flexfields
The ‘Generate Database Items’ process allows you to generate DBI for the flexfields associated with particular context.
Navigator > Payroll Checklist
Select the 'Submit a Process or Report' option.
Search and select for Generate Database Items.
Provide a unique free text value for the Payroll Flow field.
Provide a valid DDF or EFF name for 'Name' and valid context related to the EFF typed in for 'Context'.
Single row contexts are supported and for following frequently used flex‐fields.

PER_ORGANIZATION_INFORMATION_EFF, PER_ACCRUAL_PLAN_LEG_DDF, PER_ASG_LEG_DDF, PER_ASSIGNMENT_EIT_EFF, PER_JOBS_EIT_EFF,
PER_JOBS_LEG_EFF, PER_LOCATION_INFORMATION_EFF, PER_LOCATION_LEG_EFF, PER_PERSON_EIT_EFF, PER_PERSON_LEGISLATIVE_DATA_LEG_DDF,
PER_PERSON_NAME_LEG_DDF, PER_POSITIONS_EIT_EFF, PER_POSITIONS_LEG_EFF, PER_PPS_LEG_DDF
Support for multi‐row context associated with flex‐field is tracked though following enhancement:
Bug 16737421 ‐ NEED SUPPORT FOR GENERATION OF MULT ROW FLEX DBI

Integration with BI Publisher
You can launch BI publisher from the Navigator menu – Reports and Analytics workarea.


Click on the Browse Catalog option to open the BI Publisher Enterprise.


Installing BI Publisher Plugin

Template Builder for Word is a plug‐in available from BI Publisher Enterprise Home page or you can download it from Oracle link.



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.


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.


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.


Defining the report
Report will be based on a BI Publisher Data Model.
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.


Click on Save to save the report.

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
• Based on template generate automatically based on selected data model.

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.


The contents of the ‘Report Layout’ are displayed below. This report can be downloaded as a pdf file by clicking on the ‘PDF’ option.
Latest data model will have flow instance name parameter also along with the Payroll Action ID. Flow instance name will be the name of the flow pattern
run given earlier when submitting the extract.

A PDF file is generated and displayed in a new window.

Similarly you can upload other templates (for EFT – Electronic File Transfer) by defining the layout in MS‐Word.
You can use the EFT template for generating the fixed length delimited text files.







You must upload the EFT templates as type ‘eText Template’

Test the layout by clicking on ‘View Report’ and view the output in the required file format.

Two tabs – ReportLayout and EFT Layout are displayed.

Latest data model will have flow instance name parameter also along with the Payroll Action ID. Flow instance name will be the name of the flow pattern
run given earlier when submitting the extract.
Contents of ‘EFT Layout’ is displayed below.

Appendix
Sample Scenario of using changes only (Attribute Only mode)
Create extract definition with two blocks (parent and child), create Employee block (using PER_EXT_SEC_PERSON_UE) as root and child
Employee Contacts Block (using PER_EXT_CONTACT_RELATIONSHIPS_UE) and join the two blocks with a block link as displayed below.
Follow all the steps required for basic changes only functionality, provide the multi threading DBI and action as required for root block and
creating Changes Only parameter.
Create a record in root block (Employee block > Employee Basic Details) and the record should contains data element which has to be a primary
key (in this case it is Employee Person Id).

Highlight the Person Id as key and also mark the mandatory fields which you want to display irrespective of whether it is changed or not as
‘Changed’ in the data element creation.

Even in the child block record (Employee Contact block > Contact Details), create primary key data element in this case it is Contact Person Id.
Also mark the fields that you want to display irrespective of whether it is changed or not as ‘Changed’ in the data element creation (like Person
Number).


Running the HCM Extract:
Run the extract with changes only parameter as ‘N’ to fetch the full extract.
Now change any value of a given employee and run the extract with changes only = ‘ATTRIBUTE’, then you can see only attributes that are
changed and the fields which are mandatory (marked as changed).


Output

Guide For HCM Extracts: Oracle Online Training Materials - Usage Agreement

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Guide For HCM Extracts: Oracle Online Training Materials - Usage Agreement

Uploaded by

Copyright:

Available Formats

Guide for HCM Extracts

Date Author Version Change Reference

10-April-2012 Ventrapragada Rajasekhar/ Parag 0.1 First Release

You might also like