Configure the HCM Employee JTS Import Integration

Employee JTS = Employee Job Transfer Set

This topic describes how to configure this integration.

This integration pack imports or creates job transfer sets for employees from HCM.

The integration imports the following parameters by way of a flat file (CSV) as follows:

  • If the ISMaintenance parameter is set to false (default), this integration creates a job transfer sets for employees who are not assigned a job transfer set. The integration uses the employee number as the name of the job transfer set, adds the primary job as the single job in the created set, and assigns that set to that employee. You must specify a Hyperfind.
  • If the ISMaintenance parameter is set to true, this integration runs in maintenance mode in which it imports organization sets from a flat file. This import can change job assignments in employees' job transfer sets.

This integration does not import records for terminated or rehired employees.

  1. Get the URL for the APIGatewayServer and the URL, User, and Password for the HCMServer. Get the URL for the APIGatewayServer and the URL, User, and Password for the HCMAuthenticationServer.
  2. Make sure that the Employee Job Transfer Set is set to No Change in the Timekeeping Profiles.

    Note: For details, see Standard Profiles  > Timekeeping Profiles.

    1. Select Main Menu > Administration > Application Setup > HCM Profiles Setup > Standard Profiles.
    2. Select Timekeeping Profiles and click tap Manage Profiles .
    3. If you need to change a setting, select a profile and click tap Edit .
    4. In Employee Job Transfer Set, select No Change.

      Note: To retain and not overwrite the current value of the job transfer set that is assigned to an employee, select No Change for the Employee Job Transfer Set attribute in the timekeeping profile. Then, People Import integration runs do not overwrite the employee's job transfer set.

    5. Click Tap Save.
  3. Deploy the HCM Automated Employee Job Transfer Set integration pack; see Deploy Integrations.

Configure the integration

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

    Note: If prompted, enter your Username and Password. Click Tap Log in.

  2. Select the Manage tab > Atom Management.
  3. Select your environment.

Environment extensions define the connection path and properties that are always used by the integration.

  1. In Administration,click tap Environment Extensions.
  2. In Process Filter, click tap the magnifying glass Search button.
  3. Scroll to and select the integration pack: HCM Automated Employee Job Transfer Set >HCMAutomatedEmployeeJobTransferSet-v1.

Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.

  1. Select Connection Settings.

  2. From Connection, select and configure both of the following:

    Connection Settings
    Setting Required Actions
    APIGatewayServer Required

    To change the default API gateway server:

    1. Clear Use Default.
    2. Enter the URL to the server.

      Example: <tenantURL>/api
    SFTPServer Required

    The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account.

    To change the default SFTP server parameters:

    1. For each field, clear Use Default.
    2. Enter the following values:

      • Enter the name of the internal Host.

      • Enter the number of the Port for the internal SFTP account.

      • In User, enter the username for the internal SFTP account.

      • In Password, select <Encrypted>. Enter the new password for the internal SFTP account.

      • Click Tap Apply.

Process properties apply globally to all records that an integration processes. When you install the integration, you can define the parameter values or configure a prompt for the user to define the value when they run the integration.

Note: Most of the process properties have default values, even though the Integration Template Designer does not display these values.

  1. Select Process Properties.

  2. Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

    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.

  3. From the Process Property dropdown list, select HCMAutomatedEmployeeJobTransferSet-v1_External_HCMAuthenticationProperties to edit the properties to connect to the authentication server and get the access token to execute APIs.

    Caution: You must edit the authentication properties for the account that accesses the APIs and all employee groups. This information is part of the tenant details for the destination system.

    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.

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

    Process Properties
    Setting Required Actions
    DeleteFileAfterProcessing Not required

    Caution: ISMaintenance must be set to true.

    Default = false; do not delete the source file after processing.

    To delete the source file but archive it to _DestinationDirectoryPath:

    1. Clear Use Default.
    2. Select Value.
    DescriptionStringAppend Not required

    Caution: ISMaintenance must be set to false.

    To add a suffix to the description of the employee job transfer set:

    1. Clear Use Default.
    2. Enter a static suffix.

      Example: Add text after the employee number of the description: {EmployeeNumber}-XXXX.
    DescriptionStringPrepend Not required

    Caution: ISMaintenance must be set to false.

    To add a prefix to the description of the employee job transfer set:

    1. Clear Use Default.
    2. Enter a static prefix.

      Example: Add text before the employee number of the description: XXXX-{EmployeeNumber}.
    DisableUpdates Not required

    Caution: ISMaintenance must be set to true.

    When the integration is in maintenance mode, specify whether to update the records from the input file.

    Default = false.

    To disable updates from the input file:

    1. Clear Use Default.
    2. Select true.
    EnableTransactionAssistant Not required

    Default = true

    To not submit import errors to Transaction Assistant:

    1. Clear Use Default. 
    2. Select Value.
    FileName Not required

    The name of the output file.

    Default = orgset.csv.

    To change the filename:

    1. Clear Use Default.
    2. Enter a static prefix for the filename; the integration adds a timestamp to the end.
    Hyperfind Not required

    Caution: ISMaintenance must be set to false.

    Default = 1 (shown as blank) which indicates All Home and includes all active employees.

    To use a Hyperfind query for another group of employees:

    1. Clear Use Default.
    2. Enter the ID of the Hyperfind.
      Note:
      • Ad-hoc Hyperfinds are not supported.
      • All Home does not include terminated and inactive employees even if they have totals during the period. To include these totals, configure a Hyperfind that includes terminated and inactive employees and select that Hyperfind in this process property.
      • The maximum number of employees in a Hyperfind is 3500. To process more employee records, divide the population into smaller Hyperfinds to run sequentially.
    ISMaintenance Not required

    Set whether to create job transfer sets or import organization sets.

    Default = false:

    • If false (default), this integration creates a job transfer set for employees who are not assigned a job transfer set. The integration uses the employee number as the name of the job transfer set, adds the primary job as a single job in the new set, and assigns that set to that employee. You must specify a Hyperfind.
    • If true, this integration runs in maintenance mode in which it imports organization sets from a flat file. In this mode, the integration can change job assignments in employees' job transfer sets.

    To import organization sets from a flat file:

    1. Clear Use Default.
    2. Select true.
    RemoveInvalidPaths Not required

    Caution: ISMaintenance must be set to true.

    Set whether to remove invalid business structure nodes in the source file before processing and show the errors in Run Summary.

    Default = true, remove the invalid nodes.

    Example:

    • Leave Administrator and System Administrator jobs are defined in the business structure for the CO company.
    • However, the source file has records for Payroll Manager and HR Administrator jobs. These jobs are not defined in the business structure, so the integration does not import these records.

    To not remove invalid nodes, then send the errors to the Transaction Assistant:

    1. Clear Use Default.
    2. Select false.
    SourceDirectory Not required

    Caution: ISMaintenance must be set to true.

    The directory path on the SFTP server where the integration process reads the file.

    Default = Use the /Inbound directory.

    To define a different directory path:

    1. Clear Use Default.
    2. Enter the path to the directory.

      Caution: Make sure that this directory is configured on the SFTP server.
    WaitTimeBeforeAssignment Not required

    Set the delay time between creating and assigning the employee job transfer set.

    Caution: ISMaintenance must be set to false.

    Default = 60 seconds.

    To set a different delay time:

    1. Clear Use Default.
    2. Enter the number of seconds to wait.