Configure the Universal Schedules Import-v2 Integration

How to configure connection settings, process properties, and cross-reference tables for this integration.

This topic describes how to configure this integration.

Universal integration packs exchange data by way of flat files, either to export data to the file or import data from the file. Other systems access the data in these flat files to complete the import or export integration. The default settings allow rapid configuration and runs of the integration process, while the exposure of the data maps and cross-reference tables in the extensions allows overrides and customizations of the default data mappings or values.

This integration pack has integrations that do the following:

  • Import schedule data from a flat file.
  • Bidirectionally export timecard data and import schedule data by way of flat files.
  • Lock days or shifts.

This version of the Schedule Import integration pack allows successful runs even if some records have errors.

  • It updates paycodes and validates the list of employees when it runs.
  • It does not use a data map, instead it uses a script to map fields.

Configure the integration

How to configure this integration.

Select the environment

How to select the environment for theintegration.

  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.

Select environment extensions

How to select the environment extensions for the Schedule Import-v2 integration.
  1. In Administration, click tap Environment Extensions.
  2. In Process Filter, click tap the magnifying glass
    Search button
    . It can take several seconds before the button becomes active.
  3. Scroll to and select the integration pack: Universal Schedule Import > ScheduleImport-v2.

Configure connection settings

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 the Connection dropdown list, select and configure:

    Connection Settings

    Connection Settings for the Universal Schedules Import-v2 integration

    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.

    Note:

    This integration sends error logs with the following information to the SFTP server:

    • API errors with person numbers
    • Shift records when the segment type is not mapped in the _SegmentType cross-reference table
    • Paycode edit records when the paycode is not configured in the destination
    • Employees who are not configured in the destination
    • Input records that are missing the following fields: Employee, StartDate, StartTime, EndDate, EndTime, or Duration

Configure process properties

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 CallbackProcessProperty to define properties for the Run Summary and Transaction Assistant.

    To change the batchName label in the Run Summary and Transaction Assistant:

    • Clear Use Default.

    • In Value, enter the label.

      Example: ShiftImport.

  4. From the Process Property dropdown list, select ScheduleImport-v2_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.

    Caution: The Boomi™ application does not return default values for cross-reference table headers. You have to enter the headings in Value.
    Note: For details, see Configure cross-reference tables.

    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.
  5. From the Process Property dropdown list, select ScheduleImport-v2_ProcessProperties to set process properties that must be configured before the integration can run.
    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.

    Process Properties

    Process Properties for the Universal Schedules Import-v2 integration

    Property

    Required

    Actions

    SourceDirectory

    Required

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

    Default = Use the /Inbound directory.
    Caution:

    Do not change the name of the folder from Inbound. Additional or differently named folders are not supported by .

    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.

    SourceFileName

    Not required

    The name of the file that contains the data to import.

    Default = true, use the default file name.

    To define a different file name:

    1. Clear Use Default.

    2. Enter the filename. Use a .csv extension.

      You can use the asterisk (*) or question mark (?) as wildcard characters to enter patterns of file names so that the integration reads only files that have names that match this filter.

    Default = ShiftImport.csv.

    Example: ScheduleRecords_MMDDYYYY.csv

    _DeleteFileAfterReading

    Not required

    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.

    ShiftSegmentElapseTime

    Not required

    Time variance to allow between segments of a shift

    Default = 0 minutes

    To change the value:

    1. Clear Use Default.
    2. Select Value.
    3. Enter a new time in minutes.

    _EnableCustomMapping

    Not required

    To use a custom map:

    1. Clear Use Default.
    2. Select Value.

    _MoveProcessedFileToDirectory

    Not required

    The directory on the SFTP server to move the destination file after data is successfully uploaded.

    Default = true, use the default 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.

    DurationTimeFormat

    Not required

    Time format of durations

    Default = HH.hh

    To change the value:

    1. Clear Use Default.
    2. Select Value.
    3. Enter HH.hh or HH:mm.

    BatchName

    Not required

    Default = ScheduleImport

    To change the value:

    1. Clear Use Default.
    2. Select Value.
    3. Enter the batch name to group the failed records in Transaction Assistant.

    _LogFileDirectory

    Not required

    Directory on the SFTP server where the log file of errors is archived after processing.

    Default = true, use the default directory.

    To define a different directory path:

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

    _LogFileExtension

    Not required

    File format of the log file

    To define a different format:

    1. Clear Use Default.
    2. Select .log, .txt, or .dat.

    _LogFileName

    Not required

    Filename prefix of the log file; the filename ends with the date and time of the integration run.

    To define a different name prefix:

    1. Clear Use Default.
    2. In Value, enter the filename prefix.

    DeleteExistingSchedule

    Not required

    Default = true, replace the existing schedule with the imported schedule

    To not replace the existing schedule:

    1. Clear Use Default.
    2. Select Value.

Configure 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.

A cross-reference table (CRT) translates parameter values in an integration as follows:

  • Organizes data values into rows and columns:
    • Maximums = 20 columns, 10,000 rows.
  • Can combine values from multiple columns to determine a single output value.
  • If more than one row matches a reference value, the first match is the output value.
  • If no match is found, the output value can be null, or the integration can produce errors.
  1. Caution: For the cross-reference tables that you are customizing, make sure that Use Default is not selected in Process Properties > {ProcessName}_CRTConfig, and that the headers are defined.
  2. Select Cross Reference.
  3. From the Cross Reference dropdown list, select the following:

    You cannot change the name of the table.

    ScheduleImport-v2_SegmentType

    Column headers:

    Field1,Field2,Field3,Field4,Field5,Field6,Field7,Field8,Field9,Field10,Field11, Field12,Field13,Field14,Field15,Field16,Field17,Field18,Field19,Field

  4. Select Override to:

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

Default files for Schedule Import

Base integration: ScheduleImport-v1, the same for both versions of the Universal Schedule Import integration.

Default source file = ShiftImport.zip compresses and contains the ShiftImport.csv file.

Design of the Universal Schedule Import integration

This section provides detailed information to help you to assess whether this integration meets your business needs.

Integration flow:

  1. Separate the segments and paycode edit data that is imported from the input file.
  2. Convert the segment data to shift records.
  3. Search for existing shifts for the employees and start dates.
  4. Delete the existing shifts for the employees and start dates.
  5. Create new shifts for the employees from the data that was imported.
  6. Search for existing paycode edits for the employees and start dates.
  7. Delete the existing paycode edits for the employees and start dates.
  8. UnivCreate new paycode edits for the employees from the data that was imported.