Ongoing Import Queue Management

As records are retrieved from PrismHR, Import Queue (tblImportQueue) records are created and modified. The Import Queue Management dashboard and detail pages enable you to reset queue item statuses (reset to Pending, set to Complete) and interrogate error data using the Log Data field.

When the queue record fails to import into ClientSpace, we show the queue record in Failure status and add a message to the Import Queue Log Data for the following Ongoing import types: Location, I9, Employee, Employment, Contact, User, PayrollBatch, Company, ClientTeam, Codes, and Employee Future Change.

When a PrismHR API - USERS import has a missing or invalid email address, we show the queue record in Requires Attention status and we add a message to the Import Queue Log Data. The message follows this format: "User '<username>' invalid or missing email address <invalid email>, queue record set to Requires Attention".

For example, if the email address for the user carlos was carlos@gmail, the system would evaluate the email address as incomplete (since the email address was missing .com from the end) and add the message "User carlos invalid or missing email address carlos@gmail, queue record set to Requires Attention." to the import queue log.

To access the management suite:

  • Go to System Admin > Imports > Manage Import Queue.

Configuration includes

The configuration includes the following steps:

  • ImportIDs for Lookups and other data (ClientSpace)
  • Import Map Headers (ClientSpace)
  • Import Map Details (ClientSpace)
  • API Configuration form (ClientSpace)
  • HRP Subscription Dataforms (ClientSpace)
  • The PrismHR site parameters

Import IDs

Certain Lookups and other data require translation to PrismHR values. Translation occurs by using ImportIDs on the following data:

• Contract Type (ClientMaster)
• Contract Status (ClientMaster)
• HR Rep User
• Sales Rep User
• Employment Status (Employee)
• Employment Type (Employee)
• Marital Status (Employee)
• Gender (Employee)
• Ethnic Classification (Employee)
• Work State Filing Status (Employee)
• Home State Filing Status (Employee)
• Pay Method (Employment)
• Pay Frequency (Employment)

 

Import Map Headers

Configure the Import Map Headers for each file type to be produced. The configured headers MUST match the PEO headers listed in the following table. You must configure the Custom Import Class for each Header.

Import file Import Map Header

HRPAPI_company_ongoing*.csv

ClientSpace.PEO.Import.ClientMaster

HRPAPI_clientteam_ongoing*.csv

No custom import class

HRPAPI_employee*.csv

ClientSpace.PEO.Import.Employee

HRPAPI_employment*.csv

ClientSpace.PEO.Import.Employment

HRPAPI_location*.csv

ClientSpace.PEO.Import.Location

HRPAPI_voucher*.csv

ClientSpace.PEO.Import.EmployeeVoucher

HRPAPI_payroll_batch*.csv

ClientSpace.PEO.Import.PayrollBatch

These import map configurations should have been pushed to your site but may be inactive. If you find these configurations do not exist on your site, log an Extranet case to add these configurations.