Better Off Overall Test

Before you configure this integration, you must do the following:

1. Configure Access to Integrations.
2. Configure the following:

• Hyperfind: Configure a public Hyperfind query, such as BetterOffOverallTest. See the Hyperfind queries topic.

  Paycode Distribution: Configure the paycode distribution to include all zones that apply to the Industry Award. Make sure that the zones for all-inclusive payment and for Industry-Award compensation are mapped to standard paycodes. Map the zones for Industry-Award compensation to the relevant paycodes.

  See the Paycode Distributions topic.

  Note: Tip: Label the reference paycodes to distinguish them from regular paycodes.

  Example Paycode Mappings for Better Off Overall Test

  Zone, Schedule Deviation	Default
  Default	Regular, HIGA Regular
  Saturday	Regular, HIGA Saturday
  Sunday	Regular, HIGA Sunday

  • HIGA = Hospitality Industry General Agreement, one example of an Industry Award.
  • EBA = Enterprise Bargaining Agreement.

• Percent Allocation Rule: Configure the percent allocation rule to calculate the Industry-Award payment to compare to the normal pay calculation. See the Percent Allocation Rules topic.

  Note: The Industry-Award paycodes use a flat rate as defined in the award agreement.

• Integration List Parameters: Configure integration parameters to represent the BOOT detailed and summary report views, and the BOOT SFTP Action list. See the Configure Integration List Parameters topic.

3. Reports: Configure the report views for the Payment Comparison Reports. See the Design and administer reports topic.

4. Get the URL, User, and Password for the APIGatewayServer.

Deploy the Better Off Overall Test integration

For more information, see the Deploy Integrations topic.

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. Make sure that the Account is correct. If not, select the right account.

3. Select the Deploy tab > Integration Packs.

1. From the list in the left column, search for and select the Pro WFM Better Off Overall Test Extension integration.

2. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button .

Configure the Better Off Overall Test integration settings

Select the environment

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

Select environment extensions

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: Pro WFM Better Off Overall Test Extension > BetterOffOverallTest_iPack_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 the following:

   Connection Settings

   Setting	Required	Actions
   BetterOffOverallTest_iPack_v2_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api Use the format <tenantURL>/api.
   BetterOffOverallTest_iPack_v2_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.
   BetterOffOverallTest_iPack_v2_Paycode_CRT	Required	Enable Override.

Configure process properties

1. Select Process Properties.

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

2. Select BetterOffOverallTest_iPack_v2 to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

Process Properties

Property	Required	Actions
BetterOffOverallTest_iPack_v2_CRTConfig	Required	For BetterOffOverallTest_iPack_v2_Paycode_CRT: Clear Use Default. Enter Actual Paycodes, Comparison Paycodes.

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.

1. Select Cross Reference.
2. From the Cross Reference dropdown list, select the BetterOffOverallTest_iPack_v2_Paycode_CRT table.
3. Select Override, which allows you to:

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

4. When you finish, click tap OK.

BetterOffOverallTest_iPack_v2_Paycode_CRT: Maps the standard (Actual) paycodes to the Industry-Award (Comparison) paycodes.

Better Off Overall Test — Paycode CRT structure

Column header	Description
Actual Paycodes	Standard (actual) paycode name.
Comparison Paycodes	Industry-Award (comparison) paycode name.

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
2. Click Tap Create .
3. In Integration Name, enter a unique name, such as BetterOffOverallTest_iPack_v2.
4. (Optional) Enter a Description.

Note: Do not select API Integration.

5. In File Access, select None to not select a connection.
6. (Optional) If the person who runs the integration doesn't have full access to integrations, select Execute Integration with System Account. This allows the integration access to all APIs in the FAP, and the relevant permissions and data, regardless of the FAP and GDAP of the person who runs the integration.

7. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

8. Email Notifications

   (Optional)

   1. Select Yes to send email and control center notifications for integration runs.
   2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

      In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

9. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.

10. Do not select Allow Minute Interval.

11. Integration template and parameters

    1. In Integration Template, select BetterOffOverallTest_iPack_v2.
    2. Click Tap Assign .
    3. (Optional) In Integration Parameters, you can override default settings. Click Tap Create .
    4. Complete the configuration for each integration control parameter value. 
    5.  Click Tap Save.  

Repeat this step for each integration parameter that supports the Better Off Overall Test process.

Integration parameters

Parameter name	Description	Template parameter	Parameter type
File Name	The name of the flat file (.csv) that the integration exports. User prompt = Yes Caution: Do not include slashes (/).	FileName	Text
Hyperfind or Locations	The default Hyperfind or Location query that contains the employees for whom the integration is run. Default = 1 (All Home) User prompt = Yes 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.	HyperfindOrLocations	Hyperfind
OutputDirectory	The SFTP directory to which the file is exported. Default = /Outbound User prompt = No	OutputDirectory	Text
Employee IDs	A comma-separated list of specific employees for whom the integration is run. When no value is entered, the integration defaults to the Hyperfind or Locations parameter. To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces. User prompt = Yes	EmployeeIDs	Text
Report View	The type of file that the integration exports. User prompt = Yes Supported values include: Detailed: Totals are split by paycode by employee. Summarized: Totals are rolled up, one row for each employee. For detailed descriptions and examples, see Output file.	ReportView	Dropdown
Symbolic Period	Symbolic name for the pay period or date range. User prompt = Yes		Time period
Action	The action that the integration does. User prompt = Yes Supported values include: Create New Name (default): Create a new file and do not replace or change existing files. Overwrite: Replace an existing, exported file. Append: Add the exported data to an existing, exported file. Create an Error File: Create a file of error details.		Dropdown

12. Ensure that the generic data access profiles (GDAP) allow access to the Better Off Overall Test integration for the people who need to run the installed integrations. See Configure Access to Integrations.

Run integrations to test that the configuration is set up correctly.

• Initial: For the initial run of the integration, process all historical pay statements.
• Scheduled: For subsequent runs, schedule this integration to export the payroll data only for employees who had changes or corrections made to their timecard.

Run the integration

1. Select the integration:
   1. Select Main Menu  > Maintenance > Integrations. 
   2. Click Tap Run an Integration . 
   3. Select the BetterOffOverallTest_iPack_v2 integration from the list. Click Tap Select. 
   4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
2. Set parameters as follows:
   • Hyperfind or Location: Select a Hyperfind query of employees.
   • Symbolic Period: Select the symbolic name for the time period.

     Examples: A symbolic period can represent a pay period such as Previous Pay Period or Current Pay Period, a date range, or a calendar year.

   • Employee IDs: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.

     Example:

     • Generate a report for an individual or a few employees to show what they were paid and whether those amounts are correct.
     • For 3 employees: 13997,15556,20012
   • Action: Select one of the following:
   • Create New Name (default): Create a new file and do not replace or change existing files.
   • Overwrite: Replace an existing, exported file.
   • Append: Add the exported data to an existing, exported file.
   • Create an Error File: Create a file of error details.
   • File Name: Enter a name for the exported file. Do not include slashes (/).
   • Report View: Select one of the following:
     • Detailed: Totals are split by paycode by employee.
     • Summarized: Totals are rolled up, one row for each employee.

3. Select the following:

   • Run Integration: If this is the first time this integration is being run.
   • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.

4. Wait for the confirmation that the integration completed or failed. Close the panel.
5. Click Tap Refresh . 
6. To see details, select the integration run. Select Run Summary.

Check the results

Status indicators

•  In-Progress: The run of this integration has not yet completed.
•  Completed: The integration ran successfully without errors.
•  Scheduled: This integration is scheduled to run later or repeatedly.
• (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
•  Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
•  Failed: The integration run has errors or could not run.
• To troubleshoot and resolve errors, do the following:

  Check the Run Summary for details.

  • To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
  • (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.

To check the results in more detail, do the following:

1. To see detailed results, click tap the tile for the integration run.
2. Click Tap Run Summary to see the results of the integration run.

   Example Run Summary details

   Note: The available details vary by integration and configuration.

   • Integration Run Name: Name of this run of the integration.
   • Process Name: Name of any integration set that includes this integration.
   • Integration Name: Name of the installed integration.
   • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
   • User: The person or user account that ran the integration.
   • Integration Type: Import, Export, or None
   • Start Date: Date and time when the integration run started.
   • End Date: Date and time when the integration run finished.
   • Status: In-Progress, Completed, Completed with Errors, or Failed.
   • Records Processed: Number of records that were processed.
   • Records Created: Number of records that were created.
   • Errors: Number of records that failed.
   • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
3. Log in to the destination system and make sure that the data has been correctly updated.

Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the topic.

Detailed report view

In the Detailed report view, totals are split by paycode by employee.

Summarized report view

In the summarized report view, totals are rolled up, one row for each employee.

Output file specifications

• File name: BootExport
• File extension: .csv
• Format: Comma delimited
• Frequency: On-demand or scheduled
• Header row: Yes, 1 row
• Footer row: No
• Output folder: /Outbound

Output file for the Detailed report view

Field	Data type	Comments or examples
Person Number	Number Maximum length: 15	Defined in UKG Pro Workforce Management™
Person ID	Number	Defined in UKG Pro Workforce Management™
Date Range	Date-Time Format: YYYY-MM-DD hh:mm	Date span
Paycode Name — Actuals	String	Actual paycode
Total Hours — Actuals	Number	Actual worked hours
Total Money Amount (AUD) — Actuals	Number	Actual wages in AUD
Hourly Rate — Actuals	Number	Actual wage per hour in Australian Dollars (AUD)
Paycode Name — Industry Award Comparison	String	Comparison paycode
Total Hours — Industry Award Comparison	Number	Worked hours of the comparison paycode
Total Amount (AUD) — Industry Award Comparison	Number	Total monetary amount of the comparison paycode in AUD
Hourly Rate — Industry Award Comparison	Number	Hourly pay rate of the comparison paycode in AUD
Total Hours Delta — Actuals vs. Comparison	Number	Comparison of the hours between the actual and comparison paycodes
Total Amount Delta — Actuals vs. Comparison	Number	Comparison of the difference in pay between the actual and comparison paycodes in AUD
KPI (%)	Number	The change in the monetary amount as a percentage
Underpaid	String	Indicator whether the employee is underpaid: Yes No

API details

API name	Type	Resource path	Description
Execute Hyperfind	POST	/v1/commons/hyperfind/execute	Executes a Hyperfind query by ID or qualifier and returns the result.
Get Symbolic Period	GET	/v1/commons/symbolicperiod	Returns all symbolic periods in the system.
Integration Details	POST	/v1/platform/integration_executions/{id}/additional_details	Submits all additional details related to an integration execution (API or batch) into system.
Update Integration Execution Details	POST	/v1/platform/integrations/update_status	Updates and returns the callback instance against the provided integration execution details.
Retrieve Timecard Data for Multiple Employees	POST	/v1/timekeeping/timecard_metrics/multi_read	Returns timecard data for a set of employees or locations.
Retrieve Locale Date Span	POST	/v1/commons/symbolicperiod/read	Returns a locale date span, or symbolic period, according to the data provided.