HCM Extracts Templates

Use the predefined templates to quickly set up extracts. The following table lists the templates that are available for different Extract types:

Extracts Type

Template

Payroll Interface

Global Payroll Interface

Other Payroll Archive

Calculation Card Report

These templates enables you to define your extracts by choosing from a comprehensive list of data elements. Thus, selecting the list of objects you need for your integration will automatically build the Extracts definition. You can choose the list of attributes and select predefined filter criteria for various data elements. For example, when you select address data element, you can choose the filter criteria to only select work address based on the address types that you've defined in your implementation.

After you select the data elements and the filter criteria, your extracts definition is complete. You can move to the final step of defining the delivery options to complete the design process.

The extracts defined using a template as the source, is like any other Extracts that you define. You can add data groups and data elements to this newly defined extract to include more attributes according to your requirement.

Predefined Extracts

HCM Cloud has other sample extracts that are predefined. Unlike the templates, where you can select a subset of data elements, you can't edit the predefined extracts. You can make a copy of the predefined extracts and work on the copy to update the extract to your requirements.

The Work Structure and Worker extracts are the examples of predefined extracts. The Work Structure extract generates details of business units, legal entities, departments, grades, jobs, locations, and positions, while the Worker extract generates details of person names, phones, emails, national identifiers, address, legislative data, accruals, absences, work relation, work term, assignment, work measure, supervisor, and salary.

You must not run the predefined extracts directly. Make a copy to run these extracts. When copying and using these predefined extracts, verify the following before extracting data according to your requirements:

  • Define filter criteria. For example, to extract data related to specific locations, include an expression or fast formula in the data group filter conditions.

  • Remove data groups that aren't required for your integration requirement. For example, you might choose to remove positions data group from your extracts that you copied.

  • Review the details to ensure the data groups, records, and attributes that you've included meet your requirements.

  • Generate and compile the fast formulas that you've used and validate the extracts design.

  • Refine the parameters to define the default values, if any.

Using Work Structure and Worker Extract Templates

To use the Worker or Work Structure extract templates:

  1. Copy the Worker or Work Structure extract definition to create a new extract.

  2. Update the copied extract.

  3. Generate and compile fast formulas.

  4. Validate the extract design.

  5. Refine the parameters.