Configure the Universal Punches Export Integration

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

1. In Administration, click tap Environment Extensions.
2. In Process Filter, click tap the magnifying glass
   
   . It can take several seconds before the button becomes active.
3. Scroll to and select the integration pack: Universal Punch Export > PunchExport.

• 1. Select Connection Settings.

  2. From the Connection dropdown list, select and configure the following:

     Connection Settings

     Connection Settings for the Universal Punches Export integration

     Setting	Required	Actions
     APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. 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: For each field, clear Use Default. 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.

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 PunchExport_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 PunchExport_PayPeriodLookup:

   1. Clear Use Default.
   2. In Value, enter the headers, 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.

4. From the Process Property dropdown list, select PunchExport_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 Punches Export integration

   Property	Required	Actions
   ExcludeEmployee	Not required	To exclude employees from the integration: Clear Use Default. Enter the person numbers each separated by a comma (,) or number sign (#).
   PayPeriod	Not required	To change the pay period: Clear Use Default. Enter one of the following values for the pay period: 0 = Previous pay period 1 = Current pay period 2 = Next pay period 3 = Previous schedule period 4 = Current schedule period 5 = Next schedule period 6 = Week to date 7 = Last week 8 = Yesterday 10 = Range of relative dates 11 = Specific date 12 = Relative specific date 13 = Today
   OutputFileName	Not required	Name of the file to store the generated export data Clear Use Default. Enter the file name. Use a .csv extension. Default = punchexport.csv. Example: ExportPunchData.csv
   DisqualifyActive	Not required	To not process person records of active employees: Clear Use Default. Select Value.
   DisqualifyInactive	Not required	To not process person records of inactive employees: Clear Use Default. Select Value.
   DisqualifyTerminated	Not required	To not process person records of terminated employees: Clear Use Default. Select Value.
   Payrules	Not required	Default = blank To consider pay rules during the payroll export: Clear Use Default. 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: Clear Use Default. 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: Clear Use Default. (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.
   IncludePaycodes	Not required	To export only a limited group of paycodes: Clear Use Default. Enter the paycodes each separated by a comma (,) or number sign (#), but no spaces.
   ExcludePaycodes	Not required	To exclude paycodes from the integration: Clear Use Default. Enter the paycodes each separated by a comma (,) or number sign (#), but no spaces.
   IsCustomizedOutput	Not required	To generate a customized output file: Clear Use Default. Select Value.
   PunchesPairPerRow	Not required	To export in- and out-punches to single rows for each employee: Clear Use Default. Select Value.
   Custom 1	Not required	A custom field can be a search criterion to extract punch data for specific employees or groups. Enter the person custom fields each separated by a number sign ( #).
   Delimiter	Not required	Default = comma (,) To change the character that separates data values in the flat file: Clear Use Default. Enter the character.
   _Threshold	Not required	Default = 5000 To set a different number of queries as the hyperfind threshold: Click Tap Use Default. Enter the number in Value. Caution: Important: High thresholds can impede system performance.
   _DisableQuotes	Not required	To remove double quotation marks from the exported file: Clear Use Default. Select Value. If the value of any field contains any character that is used as a delimiter, this property converts that character in the data map to another character that is not used in the file. Example: Convert the comma (,) delimiters in a comma-separated values file to a pipe (|) character.

5. From the Process Property dropdown list, select PunchExport_SFTPProperties.

   SFTP Properties

   SFTP Properties for the Universal Punches 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: Clear Use Default. Enter the directory path.
   AppendRecords	Not required	To append records to any previous payroll export file: Clear Use Default. Select Value.

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

   This table maps pay periods between source and destination.

   You cannot change the name of the table.

4. 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:
   • PunchExport_SinglePunchesForFilter—PunchExport_CustomizedOutputFields to define a custom map with your own fields and ordering to map the data from the source to the destination. You can also define functions to transform mapped data.
   • PunchExport_CustomizedOutputFieldsSource—PunchExport_CustomizedOutputFields to define a custom map with your own fields and ordering to map the data from the source to the destination. You can also define functions to transform mapped data.
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. When you finish, click tap OK.

1. In Administration, click tap Environment Extensions.
2. In Process Filter, click tap the magnifying glass
   
   . It can take several seconds before the button becomes active.
3. Scroll to and select the integration pack: Universal Punch Export > PunchExportFILO.

• 1. Select Connection Settings.

  2. From the Connection dropdown list, select and configure the following:

     Connection Settings

     Setting	Required	Actions
     APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. 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: For each field, clear Use Default. 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.

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

   To change the batchName label in the run summary and Transaction Assistant:

   • Clear Use Default.

   • In Value, enter the label.

     Example: PunchImport.

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

   For PunchExportFILO_PayPeriodLookup:

   1. Clear Use Default.
   2. In Value, enter the headers, 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.

5. From the Process Property dropdown list, select PunchExportFILO_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

   Property	Required	Actions
   ExcludeEmployee	Not required	To exclude employees from the integration: Clear Use Default. Enter the person numbers each separated by a comma (,) or number sign (#).
   PayPeriod	Not required	To change the pay period: Clear Use Default. Enter one of the following values for the pay period: 0 = Previous pay period 1 = Current pay period 2 = Next pay period 3 = Previous schedule period 4 = Current schedule period 5 = Next schedule period 6 = Week to date 7 = Last week 8 = Yesterday 10 = Range of relative dates 11 = Specific date 12 = Relative specific date 13 = Today
   OutputFileName	Not required	Name of the file to store the generated export data Clear Use Default. Enter the file name. Use a .csv extension. Default = punchexport.csv. Example: ExportPunchData.csv
   Payrules	Not required	Default = blank To consider pay rules during the payroll export: Clear Use Default. 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: Clear Use Default. 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: Clear Use Default. (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.
   IsCustomizedOutput	Not required	To generate a customized output file: Clear Use Default. Select Value.
   Custom 1	Not required	A custom field can be a search criterion to extract punch data for specific employees or groups. Enter the person custom fields each separated by a number sign ( #).
   Delimiter	Not required	Default = comma (,) To change the character that separates data values in the flat file: Clear Use Default. Enter the character.
   _Threshold	Not required	Default = 5000 To set a different number of queries as the hyperfind threshold: Click Tap Use Default. Enter the number in Value. Caution: Important: High thresholds can impede system performance.
   _DisableQuotes	Not required	To remove double quotation marks from the exported file: Clear Use Default. Select Value. If the value of any field contains any character that is used as a delimiter, this property converts that character in the data map to another character that is not used in the file. Example: Convert the comma (,) delimiters in a comma-separated values file to a pipe (|) character.

6. From the Process Property dropdown list, select PunchExportFILO_SFTPProperties.

   SFTP Properties

   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: Clear Use Default. Enter the directory path.
   AppendRecords	Not required	To append records to any previous payroll export file: Clear Use Default. Select Value.

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

   This table maps pay periods between source and destination.

   You cannot change the name of the table.

4. To allow the tables to be downloaded when you run the integration, select Override.

5. 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 PunchExport_CustomizedOutputFieldsSource—PunchExport_CustomizedOutputFields to define a custom map with your own fields and ordering to map the data from the source to the destination. You can also define functions to transform mapped data.
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. When you finish, click tap OK.