Initial Import: Configuring the API for Import Map Details

A formatted URL pointing to the API services for the specific PrismHR client and site (must include the trailing / character).

For the GetPayrollBatchCutoffDate parameter, specify version 1.22 or higher of the PrismHR API. Note: Failure to update the version in the API Endpoint config results in the following error in the API log: Error Processing Batch Control Info '202023.104', error=Unexpected character encountered while parsing value: }. Path 'PayrollBatchWithOptionsResponse', line 1, position 35., queue record will be in Pending status.

Defines the types of users included in a user import:

• I: Internal User. Someone who works for the PEO or someone at PrismHR.
• M: Manager. Someone who works in payroll or human resources for a PEO client.
• A: Trusted Advisor. Same as Manager but without an Employee ID. Used for consultants.
• E: Employee.
• S: Super User in the legacy HRPWE. Similar to I.
• C: Client Manager in HRPWE.

Controls the number of payroll batches processed at once during the PrismHR Import Payroll Batch Complete scheduled process (which is one of two scheduled processes used by the Payroll Batch process.) By default, it is set to 250. This means that an import file containing more than 250 batches is processed in chunks of 250 to reduce impact on the server. Also see Configuring the Payroll Batch Scheduled Processes.

Created to support multi-tenant environments where there are multiple PrismHR API imports and a need to specify which PrismHR import feeds create a new workspace from an import record and which do not.

When PrismHR nightly imports run, ClientSpace evaluates each import file to determine if the PEOID in the import file matches the Secondary ID entered on the API Configuration record. If there is a match, ClientSpace then references the CanCreateWorkspaces parameter to determine if a workspace should be created using the following logic:

• If the CanCreateWorkspaces parameter is set to a value of 1 and the Client Number does not already exist for the PEOID, a new workspace is created.

• If the CanCreateWorkspaces parameter is set to a value of 0 or is blank, a new workspace is not created.

• Insert/Both: Allows Import Queue record creation for Contacts in PrismHR but not in ClientSpace.
• Update: For Contacts in PrismHR but not in ClientSpace, it does not create an Import Queue record. It updates existing ClientSpace Contacts with changes.

Defines where an employee portal case is created if no workspace match is found. Uses ProjectCode from workspace settings.

• 0: The Company Initial import map is included in the sync if the map is active (updates Company information and all other active Initial maps). Note: Initial sync of company data can be applied to individual workspaces using the option Sync with PrismHR on the Client Master. See PrismHR to ClientSpace Client sync.
• 1: The Company Initial import map is NOT included in the sync whether or not the map is active (all other active Initial maps are processed).

ASO and HRO are the PrismHR Service Types that should not be imported into ClientSpace.

Email domains that should not be imported into ClientSpace. Supports comma-separated list.

User names that should not be imported into ClientSpace.

• 0: Reprocesses all failed Import Queue records.
• X: Reprocesses failed Import Queue records with an UpdatedDate greater than X hours.
• If not present (default), failed Import Queue records are not reprocessed.

Remote Cutoff Date is the deadline for reporting payroll.

• 0: Do not retrieve the Batch Control Remote Cutoff Date in the import.

• 1: Include the Remote Cutoff Date if available in the Payroll Batch in PrismHR.

• If GetPayrollBatchCutoffDate not present, defaults to 0.

GetPayrollBatchCutoffDate parameter requires version 1.22 or higher of the PrismHR API. Specify the version in the URL in Endpoint. For example, https://api.prismhr.com/api-1.22/services/.

• 0: The files generated by the API Import appear in the Manage Import File List at status Ready for Import.
• 1: The files generated by the API Import automatically import into ClientSpace.

Sets how many queue records of each import map type are processed at a time.

Sets the threshold of maximum number of Employees to import during a scheduled process run.

• If no Value is set, it processes all Employees for Clients (up to the InitialImportClients count) during a scheduled process run.
• If a Value is set, after obtaining a list of Employees, if the number exceeds the parameter Value, no additional processing occurs for that run. Subsequent runs for the scheduled process resume the import, picking up where the last run ended when the maximum threshold was met. This parameter eliminates session timeouts for groups of Clients with high Employee counts.

• 0: Any leading zeros on CompanyID in PrismHR are stripped off before the Client Record is saved.
• 1: Leading zeroes on CompanyID are retained when importing records into ClientSpace.

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.

This parameter denotes the number of years to get the OSHA totals from PrismHR.

• Not Present: If the parameter is not present, then limit the number of years to the past year.
• 1 or Less: If the parameter is set to 1 or less, then limit the number of years to the past year.
• 2 If the parameter equals 2, then limit the number of years to the past two years.
• 3 or Greater: If the parameter equals 3 or greater, then limit the number of years to the past three years.

• 0: Queued Employee Payroll Vouchers are not processed immediately.
• 1: Employee Payroll Vouchers are processed as they are imported.