Run and Test the PlanSource Integration

Run, set parameter values, and check the status of these integrations; schedule integrations.

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

Run the integrations

HCM Demographic Export integration

    1. Run the HCM Demographic Export integration as follows:
      1. Select Main Menu Maintenance > Integrations.
      2. Click Tap Run an Integration .
      3. Select the HCM Demographic Export 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— Select or enter the required parameters as follows:

      Delta: Select true.

      Include Employees: Enter the person numbers, as defined in the source system, each separated by a comma ( ,) but no spaces. The integration validates each employee's subscriber ID, username, and Social Security Number (SSN).

      Lookback Days: Enter from 1—31 days.

    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.
  2. PlanSource Deductions Import integration
    1. Run the PlanSource Deductions Import integration as follows:
      1. Select Main Menu Maintenance > Integrations.
      2. Click Tap Run an Integration .
      3. Select the HCMDeductionsImport 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. Enter the Date of the most recent update of data in PlanSource.

      For the initial import of deductions, this date must be the first date of the update in PlanSource for the plan year that you are importing in order to include all deductions.

      Example: For the plan year 2021-01-01 — 2021-12-31, the first change in PlanSource was on 2020-09-19. So, for the initial run of the integration, set the start date to 2020-09-19. If the deductions are imported with a 2021-01-01 start date and a 2021-12-31 end date, request the EE ENROLLMENT REPORT from PlanSource.

    3. Set parameters— Select or enter the required parameters as follows:

      Delta: Select true.

      Include Employees: Enter the person numbers, as defined in the source system, each separated by a comma ( ,) but no spaces. The integration validates each employee's subscriber ID, username, and Social Security Number (SSN).

      Caution: Records for employees who are flagged as Test in PlanSource are not imported.

      Lookback Days: Enter from 1—31 days.

      Plan Year Start Date: Enter the day before the start date of the plan year (Plan Year Start Date — 1 day); use the format YYYY-MM-DD. During open enrollment, this date is the start date of the plan year, or for a life-event change, it is the current date.

    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.
Note: Transaction Assistant is not available for the PlanSource integrations.

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.
    Note:
    • Employees Processed shows only the number of employees who have benefits data.
    • Records Processed shows only the number of records that are processed and not the number of employees whose records are processed. If an employee has no benefits data to process, Records Processed does not show any records processed for that employee.
    Note: For import integrations, Transaction Assistant can be enabled to help you to correct minor, transaction errors; click tap Go to Transaction Assistant.
  3. Log in to the destination system and make sure that the data has been correctly updated.

Best practices for PlanSource integrations

  • During initial setup, run the HCM Demographic Export integration for all employees. Then, run the PlanSource Deductions Import integration with the Deduction Start Date set to import the entire benefit year. The initial start date must be the earliest date of change for that plan year.
  • If PlanSource imports Prior Year Benefit Enrollments and Current Year Benefit Enrollments, it must import the prior year first and it must import on a different day than the current year. Otherwise, deductions are not accurate.
  • When employee assignments change, run the HCM Demographic Export integration before you run the PlanSource Deductions Import integration.
  • Schedule the HCM Demographic Export integration to run hourly, and the PlanSource Deductions Import integration to run nightly.
  • Schedule both integrations with Delta= true and Lookback Days= 1 day.
    Note: If Installed Instance and Allow Minute Interval are selected, scheduled integrations automatically request changed records since the last successful run.
  • Connection Settings are lost when you clone or refresh the tenant. To restore the settings, see Manage Integration Properties.
  • Only primary employee information numbers (EIN) are supported; multiple EINs are not. If an employee works in multiple EINs, only the information on the employee’s record for the primary EIN goes to PlanSource, not employee information for non-primary EINs.

Schedule PlanSource integrations

Schedule the PlanSource integrations as follows:

  • HCM Demographic Export = hourly
  • PlanSource Deductions Import = nightly
Note: Alternatively, you can schedule integrations or integration sets to run once later or at any recurring frequency.
  1. Click Tap Main Menu Maintenance > Integrations.
  2. Click Tap Schedule Processes .
    Note: If you don't see this button, click tap Run Processes to toggle the labels.
  3. Schedule HCM Demographic Export
    1. Click Tap Schedule an Integration .
    2. Select the HCM Demographic Export integration from the list. Click Tap Select.
    3. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, you use the default name which ends with a date and time stamp.
    4. Set the following parameters:
      • Leave Include Employees and Delta Lookback Days blank.
      • In Qualify Delta, select No.
    5. In Schedule, select Recurring Scheduled Run.
      • Click Tap Recurrence .
      • From Repeats, select By Hour.
      • In Recurrence, select 1 hour between runs.
      • Select the Start Date.
      • Enter the Start Time.
      • Select the End Date. If you select Forever or leave the End Date blank, the schedule recurs indefinitely.
      • Click Tap Apply.
      • Click Tap Schedule Integration Request.
      • Close the panel.
  4. Schedule PlanSource Deductions Import
    Caution: Schedule this integration only after you run an initial import of deductions.
    1. Click Tap Schedule an Integration .
    2. Select the PlanSource Deductions Import integration from the list. Click Tap Select.
    3. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, you use the default name which ends with a date and time stamp.
    4. Set the following parameters:
      • Leave Include Employees blank.
      • In Delta Lookback Days, enter 1.
      • Leave Deduction Start Date blank.
      • In Qualify Delta, select Yes.
    5. In Schedule, select Recurring Scheduled Run.
      • Click Tap Recurrence .
      • From Repeats, select By Day.
      • In Recurrence, select 1 day between runs.
      • Select the Start Date.
      • Enter the Start Time at the end of the payroll day.
      • Select the End Date. If you select Forever or leave the End Date blank, the schedule recurs indefinitely.
      • Click Tap Apply.
      • Click Tap Schedule Integration Request.
      • Close the panel.