Configure the Universal Schedules Export Integration

How to configure connection settings, process properties, and data maps for this integration.

This topic describes how to configure this integration.

This integration exports schedule data to a flat file.

Schedule data types:

  • Shifts
  • Shifts and paycode edits
  • Shift segments
  • Shift segments and paycode edits
  • Includes scheduled paycode edits only, not timecard paycode edits.

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.

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 Export 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 Export > ScheduleExport.

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

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 ScheduleExport_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 Export integration

    Property

    Required

    Actions

    ExcludeEmployee

    Not required

    To exclude employees from the integration:

    1. Clear Use Default.
    2. Enter the person numbers each separated by a comma (,) or number sign (#).

    PayPeriod

    Not required

    To change the pay period:

    1. Clear Use Default.
    2. Enter one of the following values for the pay period:

      3= Previous schedule period

      4= Current schedule period

      5= Next schedule period

      6= Week to date

      7= Last week

      8= Yesterday

      13= Today

    ResultFileName

    Not required

    Name of the file to store the generated export data

    1. Clear Use Default.
    2. Enter the file name. Use a .csv extension.

    Default = schexport.csv.

    Payrules

    Not required

    To consider pay rules during the payroll export:

    1. Clear Use Default.
    2. Enter the PayruleNames each separated by a comma (,) or number sign (#).

    IncludeEmployees

    Not required

    Default = Include all employees.

    To process data for only a limited group of employees:

    1. Clear Use Default.
    2. Enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.

      Example: 13997,15556,20012

    HyperfindAndLocations

    Not required

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

    To select another hyperfind and locations:

    1. Clear Use Default.
    2. (Required) Enter the ID of a single hyperfind, or the IDs of one or more locations each separated by a comma (,) or number sign (#).
      Caution: If you do not enter an ID for the Template Parameter, the integration cannot identify the hyperfind and the integration run fails.
    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 for the organization 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.

    _TimeFormat

    Not required

    Default = HH:mm

    To change the time format of the exported data:

    1. Clear Use Default.
    2. Enter the time format.

    _HyperfindAndLocationsType

    Not required

    Default = Hyperfind

    Default = Hyperfind

    1. Clear Use Default.

    2. Select one of the following:

      • Hyperfind = Preferred
      • Location
      • Custom — Required for IncludeEmployees and any Disqualify properties

    _EnableCustomMapping

    Not required

    To customize the export with a custom map:

    • Clear Use Default.
    • In Value, select true.

    _ExportType

    Not required

    Default = Segment

    To change the type of schedule data to export:

    1. Clear Use Default.
    2. Select Shift, Shift and PaycodeEdit, Segment, or Segment and PaycodeEdit.

    _HyperfindQueryThreshold

    Not required

    Default = 5000

    To set a different number of queries as the hyperfind threshold:

    1. Click Tap Use Default.
    2. Enter the number in Value.
      Caution: Important: High thresholds can impede system performance.

  4. From the Process Property dropdown list, select ScheduleExport_SFTPProperties.

    SFTP Properties

    SFTP Properties for the Universal Schedules Export integration

    Property

    Required

    Actions

    OutputDirectory

    Not required

    The directory on the SFTP server to archive the output files.

    Default = /Outbound.
    Caution:

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

    To define a different directory path:

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

    AppendRecords

    Not required

    To append records to any previous payroll export file:

    1. Clear Use Default.
    2. Select Value.

Configure data maps

(Optional)

A data map translates a data structure from the source format to the destination format. Examples: Map "PersonID" in the source to "Person ID" in the destination or "LastName" to "Last Name".

Each integration pack has a default data map. Editing of the default map is limited to adding fields, changing mappings, or inserting functions. Any changes override the previous values. If the predefined fields do not suite your requirements, use the default map as a guide when you create your custom data map.

To customize data transformation, select the data map extension. The _EnableCustomMapping process property must be set to true.

  1. Select Data Maps.
  2. The setting of the _ExportType process property determines the relevant data map:
    • If _ExportType= Shift or Shift and PaycodeEdit, from the Data Maps dropdown list, select the ScheduleExport_ShiftProfile—ScheduleExport_ShiftCustomProfile data map.
    • If _ExportType= Segment or Segment and PaycodeEdit, from the Data Maps dropdown list, select the ScheduleExport_SegmentProfile–ScheduleExport_SegCustomProfile data map.
  3. Select
    Expand
    to expand or
    Collapse
    to collapse levels.
    To expand all levels, right-click the green boxes icon
    Map level options
    . Select Expand All
    Expand all map levels
    .

    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
        Add map function
        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. When you finish, click tap OK.

Default files for Schedule Export

Base integration: ScheduleExport-v1

Default source file = schexport.csv.