The Scheduled Process

There are two scheduled processes involved in the HRP Import function:

• HRP Import Ongoing process generates the following standard Import files:
  • HRPAPI_company_ongoing*.csv
  • HRPAPI_clientteam_ongoing*.csv
  • HRPAPI_employee*.csv
  • HRPAPI_employment*.csv
  • HRPAPI_location*.csv
• HRP Import Voucher process generates the following standard Import file:
  • HRPAPI_voucher*.csv

Service Provider user type

Prism users who are not Service Provider user types are not imported using the HRPAPI_Users initial and ongoing imports. The user types included in the user import is determined using the AllowUserTypes parameter.

Existing inactive users

Existing inactive users are deleted if a change is made to these users in PrismHR and the user is still inactive. The system will not delete user accounts without being triggered by a change to a user account in PrismHR.

Import Queue records stuck in In-Progress status

The system converts import queue records to import file rows. As the system processes the file, the system updates the import queue record status. The first status is In Progress. If the import is aborted, the queue record will be stuck in the In Progress status. If this occurs, the system will retrieve records that have been in the In Progress status for more than an hour. The system will reset the status to Pending and allow the process to retrieve current data via the PrismHR API.

Additional parameters

Additional parameters used by the PrismHR API include:

DefaultProjectCode	Sets the default workspace for a record if the system is unable to determine it
KeepLeadingZeros	Tells the system to not strip leading zeroes from the client number value stored in PrismHR
ExcludedContractTypes	Sets the system to ignore clients in the PrismHR system based on the Service Type. (comma delimited)
	• Add ExcludedContractTypes=XXX,YYY to the Additional Parameters section of the API configuration replacing XXX,YYY with the comma separated (or singular) list of PrismHR Service Types. • Service Types must be comma-separated (if there are multiples to exclude). • This setting applies to Import Initial Queue Clients and Import Initials scheduled processes. • If a Client is of an excluded contract type, it is not included in the import file. • Import Queue records are not created for Clients that are excluded (for remaining initial import maps).
ExcludeEmailDomains	Allows a comma-separated list of partial email domains to be added. If a user account has an email domain that starts with the excluded string, the user account is not imported. Example: ExcludeEmailDomains=PrismHR,gmail would exclude any user with an email domain beginning with PrismHR or Gmail such as PrismHR.com.
ExcludeUserNames	Allows a comma-separated list of partial UserIDs from the PrismHR payroll system to be added. If a user account has a UserID that starts with the excluded string, the user account is not imported.
AllowUserTypes	If not valid, user type is blank, will inactivate existing records if present. UserTypes are: • E: Worksite Employee • M: Worksite Manager • A: Worksite Trusted Advisor • I: Service Provider
NumberOfEvents	Sets the max number of records to import per subscription record on each run of the HRPAPI_Ongoing import. Setting NumberOfEvents to 0 defaults the max records imported per subscription to 100. This parameter minimizes the risk of imports failing due to large record sets. If this parameter is not set on the import configuration, the system adds the parameter and sets the value to 500.
ContactImportBehavior	Insert/Both: Allows Import Queue record creation for Contacts that are in Prism but not in ClientSpace. Update: Does not allow Import Queue record creation for Contacts that are in Prism but not in ClientSpace. Updates existing ClientSpace Contacts with changes.