Importing to ClientSpace from HCM Using Initial Import Sync

Scheduled process HCM Import Initial Sync obtains a list of all clients available through the HCMAPI and creates Import records for each. Scheduled process HCM Import Initial Sync processes the clients (company) and then imports the remaining Active Import Map data (i.e., department, division, employee, employment, job and location).

Prerequisites

The HCM Initial Import map for the client record (HCMAPI_initial_company*.csv) must be Active. All other initial import records for the data you want to import (HCMAPI_initial_department*.csv, HCMAPI_initial_division*.csv, HCMAPI_initial_employee*.csv, HCMAPI_initial_employment*.csv, HCMAPI_initial_job*.csv and HCMAPI_initial_location*.csv) must also be Active to receive a full compliment of files.

**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 have these configurations added.

There must be a valid HCM user account in ClientSpace that matches an account in HCM. This is set up on the HCMUser API. The account must have permissions in HCM to create subscriptions.
The HCM API must be properly configured.

If you try to configure this on your own and are not sure of your configuration or next steps, STOP, and log an Extranet case. When enabled, the API overwrites existing data values, potentially leading to data loss if not properly configured.

Running the Initial Import

To run the Initial Import:

•

Run the HCM Import Initial Sync scheduled process. (System Admin

>Advanced> Scheduled Processes> Select HCM Import Initial Sync > Run Import button.)

•

All Companies available on the HCM site are imported.

•

Import Queue records are generated for each Company. A list of all other Active Initial Import Maps is retrieved.

•

Those Import Queue records are set to Status = InitialPending.

•

The HCM Import Initial Sync should only execute once. If for some reason it needs to execute multiple times, DELETE all of the Import Queue Records before proceeding.

•

A list of Import Queue records is retrieved. The quantity to process at once per import map is defined in the HCMAPI API Configuration using the value set for the Additional Parameter InitialImportClients.

•

Import files are generated. In the HCMAPI API Configuration, if HRPRunImport=1, those Import Queue records are marked as InitialCompleted. If HRPRunImport=0, those Import Queue records are left at InitialPending and are retrieved again the next time the process is run.

•

Assuming HRPRunImport=1, running the HCM Import Initial Sync again grabs the next set of Import Queue records (i.e., those marked InitialPending). This continues until all Import Queue records are processed (i.e., marked InitialCompleted).

Note: During an Import, if an exception occurs during the dataform save, the system logs an appropriate exception in both the Import logs and the exception log.