Configure the HCM People Import-v1 Integration

Open the Integration Template Designer: Select Main Menu Administration > Application Setup > Integrations Setup > Design Integration Templates.

From Connection, select and configure both of the following:

Only while you test or design integration templates, should you edit the properties to connect to the authentication server and get the access token to execute APIs.

1. From the Process Property dropdown list, select AuthenticationProperties.
2. In GatewayDefaultPort, clear Use Default. Enter the path to the port for the API gateway.
3. Note: You no longer need an AppKey to call API operations. If one is defined, it is ignored.

Edit the following:

• username: Clear Use Default. Enter the username.
• password: Clear Use Default. Enter the password.
• api-key: The API key calls the REST APIs from the HTTP request header. Clear Use Default. Enter the key for the destination.
• targetCompany: Default = Not Mapped. Clear Use Default. Enter the short name of the company exactly as it is defined in the destination system.
• targetCompanyId: Default = Not Mapped. Clear Use Default. Enter the Company ID exactly as it is defined in the destination system.

(Optional) HCMAPIErrorHandler properties define how the integration responds if an integration run exceeds an API limit.

From the Process Property dropdown list, select _HCMAPIErrorHandler to change how to handle errors if integration runs exceed the limitations of an API.

• MaxRetry: This property defines the maximum number of times to retry integration runs if errors occur.

  Default = 5.

  To change the number of retries:

  Clear Use Default.

  Enter the number of retries up to a maximum of 5.

• TimeToWait: If an API limit is exceeded, this property defines how long to wait before sending the next API call.

  Default = 60000 ms. If the API call has to be sent again, each repetition adds 60,000 ms (1 minute) to the wait time.

  Examples:

  1st TimetoWait = 60,000 ms (InitialTimeToWait)

  2nd TimetoWait = 60,000 ms + 60,000 ms = 120,000 ms

  3rd TimetoWait = 60,000 ms + (2 * 60,000 ms) = 180,000 ms

  To change the initial wait time:

  Clear Use Default.

  Enter the wait time in milliseconds (ms) up to a maximum of 180000 ms.

1. From the Process Property dropdown list, select HCMAccountExtraFields.
   1. For any of the following fields:

      Accrual Profile

      Attendance Profile

      Employee Group: for the manager

      Employment Terms

      EE Job Transfer Set: for the employee

      Job Transfer Set: for the manager

      Pay Rule

      Percentage Allocation Rule: Use only one method to assign percentage allocation rules to employees; for guidelines, see Percentage Allocation Rules.

      Schedule Rule Set: Select an Account Extra Field as an alternative to using the Scheduling cross-reference table to map schedule rule sets.

      Caution: If you use an Account Extra Field to map schedule rule sets, do not map schedule rule sets in the Scheduling cross-reference table; see Cross-reference tables.
      Note: Effective dates are applied from the HR Time and Labor Profile.

      Do the following:

      • Clear Use Default.
      • Select one of Account Extra Field 1—10.
      • Repeat for another field.

2. Ignore the HR Time and Labor Profile field in the cross-reference tables.

   Custom mappings by combining process properties and cross-reference tables

   If you need custom mappings, you can combine AccountExtraFields and custom cross-reference tables as follows:

   • Assign multiple values to the same Account Extra Field.
   • Use that Account Extra Field to look up a custom cross-reference table that assigns a value to the field. See Configure Cross-Reference Tables.

   Example:

   • Set Pay Rule and Accrual Profile to map to the Account Extra Field 2 process property. Account Extra Field 2 identifies the employee type to determine the pay rule and accrual profile.
   • In the data map, configure an empty cross-reference table to use Account Extra Field 2 as an input and map the output columns to Pay Rule and Accrual Profile.
   • If Account Extra Field 2 or the effective date changes, the assignments and the date remain based on the output from the cross-reference table.

Each employee can be assigned to up to six primary labor categories. The integration can use cost center trees to assign one or more primary labor categories to employees. Any cost center tree that populates a labor category is configured with one level.

In addition, labor categories can store manager fields for employee groups.

For each Labor Category:

1. Clear Use Default.
   Note:

   If Use Default is selected, the value is Not Used and labor categories are not defined.

   Not Mapped means that a labor category is defined but is not processed by the integration.

   Not Used means that a labor category is not defined.

2. Select one of the following:

   Not Mapped: Labor categories are defined, but do not import them.

   Not Used(default): Labor categories are not defined.

   Cost Center 2—9: Map cost center fields to labor categories.

   • Cost Center 1 maps node-by-node to the business structure and includes the job. If nobusiness structure corresponds to the default cost center, the integration run fails that record.
   • Cost Center 10 is reserved for the HR job and is not available to be assigned to a labor category.

   Manager 1—6: Map manager fields to labor categories.

   • Format = LastName FirstName EmpId
   • Example: Smith John 123

This integration uses cross-reference tables (CRT) to assign profiles to the employees during the import.

From the Process Property dropdown list, select HCMPeopleImport-v1_CRTConfig to define headers in cross-reference tables.

Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

For each of the tables:

1. Clear Use Default.
2. In Value, enter the header column names, separated by commas (,) but no spaces, exactly as shown below the Value field. You can select and copy the headers from the screen, then paste them in the Value field.
3. Repeat for the other tables.

From the Process Property dropdown list, select HCMPeopleImport-v1_ProcessProperties to set process properties that must be configured before the integration can run. In most cases, use the default values.

You cannot change the names of the tables.

_TimeZones

Column headers:

_Status

Maps the employee status from HCM to the employment and account status.

Column headers:

_Accruals

Assigns the profile values for accruals, use this table when the Accruals license is assigned to an employee.

Column headers:

_Attendance

Includes the profile values for attendance, use this table when the Absence license is assigned to an employee.

Column headers:

_Currency

Column headers:

_Devices

Example devices include time clocks or terminals.

Column headers:

_Employee

Includes the employee information to assign to the employee.

Column headers:

_Leave

Includes the profile values for Leave, use this table when the Leave license is assigned to an employee.

Column headers:

_License

Includes the license assignments for each employee as assigned in the Status cross-reference table.

Column headers

_Lookup1—4

You can customize these empty tables to look up values for fields that are not included in the data maps or the other cross-reference tables.

Column headers:

_PersonProfiles

_Scheduling

Includes the profile values used for Scheduling.

Column headers:

_Timekeeping

Includes the profile values used for Timekeeping.

Column headers:

Select Override to:

• Download the tables when you run the integration
• Edit the table cells in Extensions

1. Select Data Maps.

2. From the Data Maps dropdown list, select one of the following:

   • Default map: HCMPeopleImport-v1_HR—HCMPeopleImport-v1_PeopleInfo

     You cannot edit the default map, so use it as a guide when you edit or create a custom data map.

     Data map and cross-reference tables: HCMPeopleImport-v1

   • Map cost centers to business structure: HCMPeopleImport-v1_HR Schema—HCMPeopleImport-v1_Dimensions Schema
3. Select
   
   to expand or
   
   to collapse levels.
   To expand all levels, right-click the green boxes icon
   
   . Select Expand All
   
   .

   The lines show the links between fields in the source (left side), any intermediate functions, and the destination (right side).

4. (Optional)

   Caution: The default mappings are developed and tested based on best practices. If you make changes, you may get unexpected results. Modify and test carefully.
   • Change mappings — When you customize a default data map, you can add fields only to the end of the map.

     You can select and drag to change the links between the source (left column), function (middle column), and destination (right column) items. A single source field can link to multiple destination fields, but a destination field can link to only one source field.

   • Transform the data — A map can include intermediate functions that transform the data. Examples: Perform mathematical calculations on the values or get values from a cross-reference table.
     Note: To override a field — for example because you cannot delete it from a default map — insert a function that has a null output.
     1. In Function, click tap the plus button
        
        to add an intermediate function.
     2. From Category, select a category of functions:

        String — Trim, add to, concatenate, replace, remove, split, or change the case of text.

        Caution: Do not use special characters such as angle brackets (< or >) in data in cross-reference tables, data maps, and input files. These characters can make the integration fail.

        Numeric — Perform mathematical calculations on the data.

        Date — Change the format or get the current date.

        Lookup — Get data from a cross-reference table (CRT), document cache, SQL query, or define a key-value change.

        Connector — Call a value from a connector to an application or data source.

        Custom Scripting — Transform data by way of Groovy or JavaScript code.

        Properties — Get or set process or document properties.

     3. Select the function from the list in the selected category.
     4. Click Tap OK.
     5. If prompted in Configure Defaults, enter the relevant values. Select a Caching. Click Tap OK.
     6. Select and drag from a source field to an input of the function.
     7. Select and drag from the output of the function to a destination field.
     8. Repeat to add another function.
5. Click Tap OK.