Initial 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 to interrogate error data using the Log Data field.
All PrismHR import failures are stamped on the Queue record. If the queue record fails to import, it is put in Failure status. The reason for the error is included in the log data row.
The Import Queue management suite is available from System Admin > Imports > Manage Import Queue.
Configuration includes:
- ImportIDs for Lookups and other data (ClientSpace)
- Import Map Headers (ClientSpace)
- Import Map Details (ClientSpace)
- API Configuration form (ClientSpace)
- The PrismHR Site
Import IDs
Certain Lookups and other data require translation to Prism values. This is done using ImportIDs on the following data.
|
Import IDs |
|
|---|---|
|
|
Import Map Headers
Import Map Headers must be configured for each file type to be produced and MUST match the following PEO headers**. Configure the Custom Import Class for each Header.
|
File |
Custom import class |
|---|---|
| PHRAPI_initial_company*.csv | ClientSpace.PEO.Import.ClientMaster |
| PHRAPI_initial_clientteam*.csv | No custom import class |
| PHRAPI_initial_employee*.csv | ClientSpace.PEO.Import.Employee |
| PHRAPI_initial_employment*.csv | ClientSpace.PEO.Import.Employment |
| PHRAPI_initial_location*.csv | ClientSpace.PEO.Import.Location |
**These import map configurations should have been pushed to your site but may be inactive. If you find these configurations do not on your site, log an Extranet case to have these configurations added.
PrismHR Subscription Dataforms
The following dataforms are typically used in the Admin Workspace:
- Client Schema
- Employee Schema
- Voucher Schema
Each form contains:
- Schema: For Import Ongoing only, defines the type of data this Subscription ID evaluates.
- Subscription ID: The PrismHR ID of the registered Subscription for this ClientSpace installation.
- Replay ID: The last Event marker processed, from the last time the Ongoing Scheduled Process successfully ran.
- Voucher Last Process Date: The last date the Voucher Scheduled Process successfully ran.
- Notes: General information such as the date and time the scheduled process ran, the Replay ID used.
Excludes Import Map Detail
Review the PrismHR Security subscription record to ensure that Users=activeUser is NOT part of the Excludes Import Map Detail for the PHRAPI_users import. The import must contain a valid record for the Active flag.
User status in PrismHR and ClientSpace
The ClientSpace user Active value is automatically set to the PrismHR value so that when a user is inactivated in PrismHR, the same status is reflected in ClientSpace.
Contact status in PrismHR and ClientSpace
When a Contact is deleted in PrismHR, the corresponding Contact in ClientSpace is marked as Inactive.
PrismHR API - USERS
When processing User Import Queue records, if the email address is incorrectly formatted or there is no email address, the system marks the record as Requires Attention and adds 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.
Default workspace for external users
When the AllowUserTypes parameter on the PrismHRAPI configuration is blank or includes M or A, Worksite Manager (M) and Worksite Trusted Advisor (A) users in PrismHR are imported as external users, and external users require a default workspace (see Initial Import: Configuring the API for Import Map Details). When the PHRAPI_users and PHRAPI_initial_users imports process one of these users, the system checks the PrismHR clients that the user can access. It sets the user's Default Workspace to the workspace of the first of those clients that exists in ClientSpace.
Note: If you want ClientSpace to automatically create Worksite Managers and Trusted Advisors, additional configuration is required. Log an extranet case or contact Professional Services.
If no default workspace can be set, the user is not imported. For the PHRAPI_users import, the system marks the User Import Queue record as Completed and adds one of the following messages to the Import Queue Log Data:
- When the user has no client access in PrismHR: "User '<username>' has no allowed clients in PrismHR, queue record automatically Completed".
- When none of the user's PrismHR clients exist in ClientSpace: "User '<username>' has no PrismHR Client ['<client IDs>'] found in ClientSpace, queue record automatically Completed".
Note: If an existing Worksite Manager or Worksite Trusted Advisor user no longer has access to any PrismHR client that exists in ClientSpace, the PHRAPI_initial_users import clears the user's Default Workspace. The user then has no workspace access in ClientSpace, which matches the user's revoked client access in PrismHR.