Pending Corrections Computation

Note: This integration is an extension that is developed outside the normal release schedule to meet specific customer needs. To request one of these extensions, you must submit a Salesforce Service Request to UKG. After the extension is delivered to your tenant, you can edit it accordingly.

The Pending Corrections Computation integration provides an efficient way to retrieve, review, and save pending corrections.

This integration enables the user to:

  • Retrieve pending corrections for a selected time frame and set of employees.

  • Review corrections and evaluate the initiating causes.

  • Add a comment to corrections for future reporting reference.

  • Save pending corrections.

Two actions are supported by the integration:

Review Pending Corrections Computation

Pending corrections data retrieved and computed by new API v1/timekeeping/pending_historical_corrections/compute/async is downloaded to a CSV file for user review. To support analysis, exported data consists of:

  • Sr No: Correction number found in the snapshot file.

  • Employee ID + Employee Name: Employee identification.

  • Reference Date: Start of the requested lookback period.

  • Processed Date: Start of the pay period in which the Reference Date falls.

  • Earliest Correction Date: Earliest day in the lookback period where a pending correction is found for the employee.

  • Latest Correction Date: Last day in the lookback period where a pending correction is found for the employee.

  • Status: Status of the pending correction.

  • Historical Date: Correction date in the historical pay period.

  • Pay Code + Amount: Populated when the system is configured to manage adjustments with hours paycodes (Pay Rule or System Setting).

  • Wage Pay Code + Wages: Populated when the system is configured to manage adjustments with a money paycode (Pay Rule or System Setting).

  • Effective Date: Corrections Apply Date defined in the Pay Rule.

  • Include in Totals: Create correction transactions in the current pay period to be exported to payroll (System Setting).

For each employee with pending corrections, the earliest and latest pending correction dates display along with a snapshot of corresponding data. The user analyzes exported data to determine how to handle the pending corrections.

Note: In consideration of service limits and the potential quantity of pending corrections, the new API is designed to return only the first 10 days with pending corrections for each employee, beginning with the processed date. This snapshot avoids overloading the user with a high volume of correction records, which makes the review process more manageable.

Pending corrections, while not always expected, are always correct — they are the result of a change processed by the Totalizer at the request of a user. Some corrections result from unintentional changes, such as an improperly effective-dated change to a Person record or Setup item. This integration allows users to inspect the cause of unwanted corrections before they are saved to the database and exported to payroll.

Review Pending Corrections does not provide a means to delete pending corrections — that is not possible. Choosing to set Include in Totals = No during the Save Pending Corrections action prevents corrections from being exported to payroll. Remember that this action does not revert the incorrect totals in the historic pay period.

The best practice is to edit the correction by reverting the unintentional change to generate a new set of corrections nullifying the previous set.

Save Pending Corrections

Pending corrections are saved using a new API, /v1/timekeeping/pending_historical_corrections/save/async, for the selected employees from the processed date forward. At run time, the user indicates whether the pending corrections should be included in totals:

  • Yes — Indicates an intentional change.

  • No — Indicates an unintentional change.

Optionally, adding a comment to saved corrections simplifies future reporting. An automated note containing the save action's date and time attaches to the comment.

The Compute Pending Corrections action can be scheduled as an automatic event, writing information to five date fields in the Person record. To enable this option, configure the five field names in System Setting — Timekeeping,and enable Compute Pending Corrections in Event Manager. With every run of the Compute Pending Corrections event, each of the five date fields is overwritten with the most recent information; data is accessible in a Dataview.

In a typical scenario, the user navigates to the Pending Corrections Computation integration, and selects options corresponding to the employees being evaluated. The user analyzes a snapshot of the pending corrections from the CSV file generated by the integration. A sample is provided below.

PendingCorrectionsSummaryReport - Sample
Sr No Employee ID Employee Name Reference Date Processed Date Earliest Correction Date Latest Correction Date Status Historical Date Pay Code Amount Wage Pay Code Wages Effective Date Include in Totals
1 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-07-04 OT200 -8.50     2022-01-14 Yes
2 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-07-04 Regular 8.50     2022-01-14 Yes
3 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-09-05 OT200 -8.50     2022-01-14 Yes
4 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-09-05 Regular 8.50     2022-01-14 Yes
5 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-10-10 OT200 -8.50     2022-01-14 Yes
6 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-10-10 Regular 8.50     2022-01-14 Yes
7 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-11-11 OT200 -8.50     2022-01-14 Yes
8 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-11-11 Regular 8.50     2022-01-14 Yes
9 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-12-25 OT200 -8.50     2022-01-14 Yes
10 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2021-12-25 Regular 8.50     2022-01-14 Yes
11 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2022-01-01 OT200 -8.50     2022-01-14 Yes
12 062-001 Williams, Emily 2021-07-01 2021-06-30 2022-07-04 2022-01-01 Pending 2022-01-01 Regular 8.50     2022-01-14 Yes
13 031-128 Arnott, Michael 2021-07-01 2021-06-30 2021-06-30 2022-01-09 Pending 2021-06-30     $Correction 40.00 2022-01-14 Yes
14 031-128 Arnott, Michael 2021-07-01 2021-06-30 2021-06-30 2022-01-09 Pending 2021-07-01     $Correction 40.00 2022-01-14 Yes
15 031-128 Arnott, Michael 2021-07-01 2021-06-30 2021-06-30 2022-01-09 Pending 2021-07-02     $Correction 40.00 2022-01-14 Yes
16 031-128 Arnott, Michael 2021-07-01 2021-06-30 2021-06-30 2022-01-09 Pending 2021-07-03     $Correction 40.00 2022-01-14 Yes
17 031-128 Arnott, Michael 2021-07-01 2021-06-30 2021-06-30 2022-01-09 Pending 2021-07-04     $Correction 40.00 2022-01-14 Yes

While evaluating the results, the user interprets the following:

  • The system intelligently retrieved pay period-wise corrections; that is, scanning began on the closest start date of the pay period which included the lookback period. In this case, that was the 30th of June; this is known as the process date.

  • Two very important dates retrieved by the system are the earliest and latest correction dates. When these date values are taken into consideration with the historical date, paycode, and amount columns, they aid in finding correction patterns. Observing records for Emily, the user noted deductions of 8:30 moved from overtime to regular buckets. Recognizing these date patterns as holidays, the user realized the need to check either the Holiday Credit Rule or the list of public holidays.

  • Money corrections observed while analyzing the historical corrections for Michael indicated that an increase in salary probably occurred.

After completing their analysis, the user determines the correct value for Include in Totals and saves the pending corrections.

Before you start

  1. Configure Access to Integrations.
  2. Update the user's Function Access Profile — set the Function Access Control Point "APIs > Rest API > Pending Corrections" = "Allowed"; see the FAP APIs topics.
  3. Create a Comment to identify the pending correction reference; see the Comments topic.
  4. (Optional) Configure system settings if the Compute Pending Corrections action will be scheduled as an automatic event; see the Timekeeping System Settings topic.

    site.timekeeping.computeCorrections_requestedHistoricDateName = Reference Date

    site.timekeeping.computeCorrections_latestCorrectionDateName = Latest Correction Date

    site.timekeeping.computeCorrections_processedHistoricDateName = Processed Historic Date

    site.timekeeping.computeCorrections_earliestCorrectionDateName = Earliest Correction Date

    site.timekeeping.computeCorrections_runDateTimeName = Run Date Time

  5. (Optional) Schedule Compute Pending Corrections as an automated event, such as:

    Name: Compute Pending Corrections

    Description: Compute Pending Corrections Event

    Schedule Type: Weekly

  6. Get the URL for the APIGatewayServer for the tenant.
  7. Deploy the Pending Corrections Computation_v1 integration template.

Select the environment

  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

  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. Select the integration pack: PendingCorrectionsComputation > PendingCorrectionsComputation_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.

Configure connection settings

  1. Select Connection Settings.

  2. From the Connection list, select and configure 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

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 PendingCorrectionsComputation_v1_ProcessProperties to set process properties that must be configured before the integration can run.

    Process Properties
    Property Required Actions
    Action Required

    The action that the integration performs.

    Select one of the following:

    • Review Pending Corrections

    • Save Pending Corrections
    Hyperfind or Location Required

    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.
    Include in Totals Not Required

    Default = true; controls generation of correction transactions.

    To not Include in Totals:

    1. Clear Use Default.
    2. Select Value.
    Lookback Period (Days) Not Required

    Number of days before the Run Date, which defines the period during which pending corrections are computed and retrieved.

    Default = 90

    To change the wait time:

    1. Clear Use Default.
    2. Enter the number of days.
    Person Numbers Not Required

    Default = blank

    Leave Use Default selected to include all employees in the Hyperfind
    Reference Date Required

    The date from which the pending corrections will be computed and retrieved. Used to define the Process Date.

    Default = current date

    To use an alternative Reference Date:

    1. Clear Use Default.
    2. Enter the date.
    Effective Date Required

    Effective Date of the pending correction. Must be today or a future date.

    Default = current date

    To use an alternative Effective Date:

    1. Clear Use Default.
    2. Enter the date.
    Comment Required

    Comment that will be added to the pending correction.

    Default = Adjustment amount after pending correction

    To use an alternative Comment:

    1. Clear Use Default.
    2. Enter the comment.
    Filename Not Required

    The name of the file where pending corrections are exported.

    Default = PendingCorrectionSummaryReport

    To use a different name:

    1. Clear Use Default.
    2. Enter a unique name for the file.
    SourceDirectory Not Required

    The SFTP Location of the exported file.

    Default = /Inbound/PendingCorrections

    To use a different location:

    1. Clear Use Default.
    2. Enter a unique SFTP location.

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.

Note:
  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.
  • An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
  1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. Enter a unique and descriptive Integration Name.
  4. (Optional) Enter a Description.
  5. Do not select API Integration.
  6. In File Access, select None to not select a connection.
  7. (Optional) If the person who runs the integration does not 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.

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

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

  10. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.
  11. Do not select Allow Minute Interval.
  12. Integration template and parameters
    1. In Integration Template, select PendingCorrectionsComputation_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings.
    4. Specify the following parameters:

      (Required) Specify the action to execute:

      Click Tap Create .

      Action
      Parameter Name(Required) Enter Action.
      Description(Optional)
      Template Parameter

      (Required) Select Action.

      Parameter Type

      (Required) Select Dropdown.

      Default Value(Optional) Select Review Pending Corrections.
      User Prompted

      To prompt the person who manually runs the integration to set this parameter, select Yes.

      Click Tap Save.

      (Required) Specify the default Hyperfind query that contains the employees:

      Click Tap Create .

      Hyperfind Name
      Parameter Name(Required) Enter Hyperfind Name.
      Description(Optional)
      Template Parameter(Required) Select Hyperfind or Location.
      Parameter Type(Required) Select Hyperfind.
      Default Value(Optional) Enter 1 = All Home Locations.
      User Prompted

      To prompt the person who manually runs the integration to set this parameter, select Yes.

      Click Tap Save.

      (Optional) Specify whether corrections are included in timecard totals:

      Click Tap Create .

      Include in Totals
      Parameter Name(Required) Enter Include in Totals.
      Description(Optional)
      Template Parameter

      (Required) Select Include in Totals.

      Parameter Type

      (Required) Select Boolean.

      Default Value(Optional) Select True.
      User Prompted

      To prompt the person who manually runs the integration to set this parameter, select Yes.

      Click Tap Save.

      (Optional) Specify Lookback Period (Days):

      Click Tap Create .

      Lookback Period (Days)
      Parameter Name(Required) Enter Lookback Period (Days).
      Description(Optional)
      Template Parameter

      (Required) Select Lookback Period (Days).

      Parameter Type

      (Required) Select Number.

      Default Value(Optional) Enter 90.
      User Prompted

      To prompt the person who manually runs the integration to set this parameter, select Yes.

      Click Tap Save.

      (Required) Specify Person Numbers for whom the integration will run:

      Click Tap Create .

      Person Numbers
      Parameter Name(Required) Enter Person Numbers.
      Description(Optional)
      Template Parameter

      (Required) Select Person Numbers.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter Person Numbers.
      User Prompted

      To prompt the person who manually runs the integration to set this parameter, select Yes.

      Click Tap Save.

      (Required) Specify Pending Corrections Reference Date:

      Click Tap Create .

      Reference Date
      Parameter Name(Required) Enter Reference Date.
      Description(Optional)
      Template Parameter

      (Required) Select Reference Date.

      Parameter Type

      (Required) Select Date.

      Default Value(Optional) Select date.
      User Prompted

      To prompt the person who manually runs the integration to set this parameter, select Yes.

      Click Tap Save.

      (Required) Specify Pending Corrections Effective Date:

      Click Tap Create .

      Effective Date
      Parameter Name(Required) Enter Effective Date.
      Description(Optional)
      Template Parameter

      (Required) Select Effective Date.

      Parameter Type

      (Required) Select Date.

      Default Value(Optional) Select current date.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

      Click Tap Save.

      (Required) Specify the Comment to identify the Pending Correction reference:

      Click Tap Create .

      Comment
      Parameter Name(Required) Enter Comment.
      Description(Optional)
      Template Parameter

      (Required) Select Comment.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Select adjustment amount after pending correction.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

      Click Tap Save.

      (Optional) Specify name of file to which pending corrections data is exported:

      Click Tap Create .

      Filename
      Parameter Name(Required) Enter Filename.
      Description(Optional)
      Template Parameter

      (Required) Select Filename.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter PendingCorrectionSummaryReport.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

      Click Tap Save.

      (Optional) Specify SFTP Location of the exported file:

      Click Tap Create .

      SourceDirectory
      Parameter Name(Required) Enter SourceDirectory.
      Description(Optional)
      Template Parameter

      (Required) Select SourceDirectory.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter /Inbound/PendingCorrections.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

      Click Tap Save.

  13. Click Tap Save.
  14. Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. Select Administration > Application Setup > Integrations Setup > Access Profiles; see Configure Access to Integrations.

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

Run the integration

  1. Select the integration:
    1. Select Main Menu  > Maintenance > Integrations. 
    2. Click Tap Run an Integration . 
    3. Select the Pending Corrections Computation_v1 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 system assigns a default name, which ends with a date and time stamp.
  2. Set parameters as follows:
    • Action: Specify the Action to execute.
    • Hyperfind: Select a Hyperfind query of employees.
    • Include in Totals: Specify whether corrections are included in timecard totals.
    • Lookback Period (Days): Specify Lookback Period (Days).
    • Person Numbers: 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.

      For 3 employees: 13997,15556,20012

    • Reference Date: Specify pending corrections Reference Date.
    • Effective Date: Specify pending corrections Effective Date.
    • Comment: Specify the Comment to identify the pending correction reference.
    • Filename: Specify name of file to which pending corrections data is exported.
    • Source Direcotry: Specify SFTP Location of the exported file.

  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:

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

Pending Corrections Computations - API Details
API name Action Resource path Description
v1/timekeeping/pending_historical_corrections/compute/async POST _RetrieveComputeCorrections Generate the request key for employee on a specific day.
/v1/timekeeping/pending_historical_corrections/compute/{{Compute_Request_ID}}/status GET _RetrieveComputeCorrectionsStatus Retrieve the status of the historical correction record.
/v1/timekeeping/pending_historical_corrections/compute/{{Compute_Request_ID}}/results?resultIndex=0 GET _Retrieve_PendingHCResults Get all pending historical correction details.
/v1/timekeeping/pending_historical_corrections/save/async POST _SaveCorrections Save all pending historical corrections.
/v1/timekeeping/pending_historical_corrections/save/{{Save_Request_ID}}/status GET _SaveCorrectionStatus Save historical correction record fetch status.
/v1/timekeeping/pending_historical_corrections/save/{{Save_Request_ID}}/results?resultIndex=0 GET _SaveCorrectionResults Save historical correction result.