1. HCM Extracts
  2. Define Extracts

Define Extracts

This example shows the steps required to create an extract definition.

Before you create an extract definition, you should understand the following details:

  • Information that you want to extract

  • Structure in which the data must be extracted

  • How you want to deliver this data (including file format, delivery mechanism, and frequency information)

FAST bank is a global organization with subsidiaries all over the world. As part of an external business reporting requirement, FAST bank is required to extract the department and employee details (grouped by department) across the entire company. This information must be sent to a third party in an XML file and to HR Managers in a PDF file using email. The following table summarizes the key decisions in this scenario:

Decisions to Consider

In This Example

How many extracts do I create to produce this type of report?

You create one extract definition to define a headcount report.

How many data groups do I create?

There are 2 functional groups of information, therefore you create two data groups, one for department and one for employees.

How many records do I create?

You decide the number of records based on the subgroup 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 create?

You decide the number of attributes based on the specific information required for that report. Create the following attributes for the Department Details record:

  • Department Name

  • Department Location

For the Department Summary record, create the following attributes:

  • Record Code

  • Report Date

  • Employee Count

For the Employees Details record, create the following attributes:

  • Full Name

  • Gender

  • Date of Birth

  • Salary

  • Bonus

  • Tax Rate

Do I create any fast formulas?

You can use fast formulas at the following levels:

  • Extract Criteria level to decide certain conditions.

  • Extract Rule level to derive attribute values.

  • Extract Advanced Condition level to specify complex conditions.

  • Extract Record level to automatically generate formulas when you use the Generate Formula option.

Create an Extract Definition

  1. On the Extract Definitions page, click Add > Create New to open the Create Extract Definition page.

  2. Select HR Archive and enter 01-Jan-2000 as the Session Effective Date.

    The session effective date is an effective start date that applies to all date-effective interactions in the current session.

  3. Enter FAST Bank Extract as the name of the extract definition. The application automatically creates the tag name based on the extract name and uses this name to generate the XML output file.

  4. Click OK. 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:

    • Effective Date

    • Legislative Data Group

    • Parameter Group

    • Report Category

    • Request ID

    • Start Date

Configure Effective Date Defaulting Rule

When extracts are scheduled, the Effective Date parameter, which is a required attribute, needs to be specified for defaulting appropriate values. For example, running an extract daily will require passing the effective date in context to the date on which it's run. You can define defaulting rules from the Refine Extracts page where you specify it at the task parameter level. You can define these rules in both the Extracts Definition page and in the Refine Extracts page. You can define the parameter and default values by choosing the 'Advanced View' option in the parameters region. Select the default value from the 'Parameter Basis' list of values

  1. Open the extract for which you want to specify the Effective Date parameter.

  2. In the Define tab, go to the Parameters region and select Advanced View from the Show list.

  3. Select the value from Parameter Basis list.

  4. Click Save and Close.

You can rename an extract when you want to import or migrate a later version of the extract with the same name. Renaming will help references in external applications to remain unaffected, while you can update the extract with a later version.

  1. In the Extract Definitions page, click Actions > Copy or Rename.

  2. Select Rename and enter the extract name, and click OK. After renaming the extract, ensure that you run a new baseline if your extract is incremental.

Related Topics