PrismHR Event Monitoring

ClientSpace watches for data changes in PrismHR and imports a selected set of data related to those changes. ClientSpace does this by monitoring the event queue, noting events that show changed data that is also mapped in an Import Map Header record. Changed data that is mapped then triggers system logic.

Import Map Header Detail

The Import Map Header Detail form defines the import event.

Field Description

Source File

HRPAPI_event*.csv

Dataform

PrismHR Event

Execution Order

100

Execution Pipeline

Default

Import Type

API

Special Import True (selected)

Import Map Field Search

From the Import Map Header Detail form, click Fields to display a list of the HRPAPI_event*.csv fields.

The following graphic illustrates the HRPAPI_event*.csv fields.

AccountNumber AccountType benefitPercent Deductions Dependents EeEmail EeFirstName EeGender EeLastName FederalFilingStatus FederalOverrideAmount FederalOverrideType MultipleJobs OtherIncome StateFilingStatus StateTaxAlternativeCalculationCode StateTaxExemptAmount StateTaxOverrideAmount  StateTaxOverrideType StateTaxPrimaryAllowances StateTaxSecondaryAllowances StateTaxSupplementalExemption

Import Map Detail

From the Import Map Search, click the click (Jump button for a field to display the Import Map Detail.

The Import Map Detail form manages the settings for the imported fields.

Field Description

File Column

This name has no spaces.

Data Type

Text (always)

API Path

Schema/Class/field

API Configuration

Same as a typical PrismHR API Configuration (can use existing)
Users only the KeepLeadingZeros=0/1 parameter for Client Numbers

PrismHR Subscription forms

New Type field, Standard, or Event
Existing Subscriptions must be set to Standard (run attached Script to update)
This process uses Type Event

Process overview

Retrieve the Event type Subscription
Retrieve all Import Map Details with header source file = 'HRPAPI_event*.csv'
Retrieve all Events from PrismHR for the Subscription
Resolve each Event into a list of
Schema (the type of change, such as Employee)
Class (the category of change, such as Person or Direct Deposit
Client Number
Object ID (typically the Employee ID)
Modified Attributes (which fields changed for this Event)
If an Event contains a Modified Attribute that is not in the Import Map it will be added to the Excludes list on the Subscription
For each resolved Event
Populate a new PrismHR Event dataform with the resolved Event data
Locate the workspace for the Client Number (from CM.ClientNumber)
if found, save the PrismHR Event dataform in that workspace
if not found, save the PrismHR Event dataform in the Admin workspace
Save using the PrismHREvent Pipeline - Any business rules triggered by this will also need to be set to execute on the PrismHREvent Pipeline.