Run and Test the Prorated Accruals Integration

Prorated Accruals distribute accruals entitlements proportionally on the date of hire or termination, or a change to employment contract based on the number of remaining days in the reference accruals period.

Note: For more information, see the Prorated Accruals Overview.

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. Schedule this integration to run daily.
  1. When you run this integration for the first time, do the following:
    1. Upload the compressed (.zip) file of accruals data to the SFTP server by way of SDM. All following runs of this integration automatically import this file.
    2. Only if the accruals configuration changes, export a new .zip file to the SFTP server by way of SDM. Otherwise, do not upload the SDM file during subsequent integration runs.
  2. Select the integration:
    1. Select Main Menu  > Maintenance > Integrations. 
    2. Click Tap Run an Integration . 
    3. Select the ProratedAccruals_v5 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.
  3. Set parameters as follows:
    • Hyperfind or Locations: Select the default hyperfind query for the location that contains the employees.
      • Default = All Home.
      • (Not recommended) You can select a different hyperfind query.
    • Employee IDs: (Optional) Enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.
    • Enable New Hire: (Optional) Select whether to process employees when they are hired or rehired.
    • Enable FTE Change: (Optional) Select whether to process employees by changes to FTE status.
    • Enable Accrual Profile Change: (Optional) Select whether to process employees by changes to accrual profiles.
    • Enable Termination: (Optional) Select whether to process records for employees when they are terminated.
    • Enable Earning Amount Limit: (Optional) Select whether to process FTE-adjusted earnings-amount limits. This limit controls the number of hours an employee can earn during an accrual period regardless of takings.
    • Enable Carryover Limit: (Optional) Select whether to process FTE-adjusted carryover limits. This limit controls the number of hours or days that can be carried from one accrual period to another.
    • Enable Accruals Payout: (Optional) Select whether to pay out accruals when an employee is terminated.
    • Limit Look Forward Days: (Optional) Select the number of days in the future that the integration runs for carry-forward and earning-amount limits. The integration scans for future-dated changes to FTE status and accrual profiles, and inserts the adjustment on the future date.
    • Adjustment Paycode: (Optional) Select a paycode that identifies the prorated, adjusted accruals in the Timecard to help find or re-run accruals.
    • Adjustment Comment: (Optional) Select a comment to add details to the Prorated Accrual paycode.
    • Overdraft Comment: (Optional) Select a comment to add details to the Overdraft paycode.
    • Overdraft Paycode: (Optional) Select a paycode for overdrafts.
    • Non-Carried Over Days: (Optional and only if EnableCarryoverLimit is enabled) Select the number of days that the integration processes FTE-adjusted carryover limits that exceed the carryover limit.
    • Non-Carried Over Hours: (Optional and only if EnableCarryoverLimit is enabled) Select

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

  5. Wait for the confirmation that the integration completed or failed. Close the panel.
  6. Click Tap Refresh . 
  7. 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 Schedule Integrations topic.