Configure the HCM Skills and Certifications Import Integration
This topic describes how to configure this integration.
This integration pack imports skills, certifications, or both from HCM by way of APIs to assign to employees.
- Skills and certifications track whether employees have the right skills or certifications to fulfill the duties of the assigned jobs. In scheduling, skills and certifications determine whether employees have the required skills to work shifts. If a job requires a skill or certification and no employee is scheduled who has that skill or active certification, a schedule rule Defines restrictions and requirements to ensure that a schedule meets certain criteria. is violated.
- Dimensions HCM is the system of record for skills and certifications definitions for employees.
- Make sure that skills and certifications are configured on both systems because this integration cannot create skill or certification records.
- Make sure that a Rest user account was created on the HCM tenant.
- Get the URL for the APIGatewayServer and the HCMAuthenticationServer.
-
Get the following HCMAuthenticationProperties from the tenant details:
- username: This is the username for the account that accesses the APIs and all employee groups.
- password: For the same account
api-key: The API key calls the HCM REST APIs from the HTTP request header. Get the key as follows:
- Log in to the HCM Company tenant with an administrator user account.
- Find and select the Company.
- Click Tap Log in as SA.
- Select Home > Maintenance > Company Settings > Global Setup > Company Setup > the Company Config tab.
- Select and expand API Keys.
- Do one of the following:
If a key has been generated already, do not generate another one. Click Tap View
to show the API Key. Copy and use this key. If a key has not been generated, click tap GENERATE.
- targetCompany: If you don't have access to this credential, contact UKG support.
- targetCompanyId: If you don't have access to this credential, contact UKG support.
- Deploy the Dimensions HCM Skills Certification Import integration pack; see the Deploy Integrations help topic.
Configure the integration
-
Open the Integration Template Designer: Select Main Menu
> Administration > Application Setup > Integrations Setup > Design Integration Templates. Note: If prompted, enter your Username and Password. Click Tap Log in.
- Select the Manage tab > Atom Management.
- Select your environment.
Environment extensions define the connection path and properties that are always used by the integration.
- In Administration, click tap Environment Extensions.
- In Process Filter, click tap the magnifying glass . It can take several seconds before the button becomes active.
- Scroll to and select the integration pack: Dimensions HCM Skills Certification Import > HCMSkillsAndCertsImport-v1.
Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.
- Select Connection Settings.
-
From Connection, select and configure:
Connection Settings Setting Required Actions APIGatewayServer Required To change the default API gateway server:
- Clear Use Default.
- Enter the URL to the server.
Example: <tenantURL>/api
HCMAuthenticationServer Required (Optional) To change the HCM authentication server:
- Clear Use Default.
- Enter the URL to the server.
- Select Process Properties.
Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.
- From the Process Property dropdown list, select HCMSkillsAndCertsImport-v1_External_HCMAuthenticationProperties to edit the properties to connect to the authentication server and get the access token to execute APIs.
Caution: You must edit the authentication properties for the account that accesses the APIs and all employee groups. This information is part of the tenant details for the destination system.
Edit the following:
- username: Clear Use Default. Enter the username.
- password: Clear Use Default. Enter the password.
- api-key: The API key calls the REST APIs from the HTTP request header. Clear Use Default. Enter the key for the destination.
- targetCompany: Default = Not Mapped. Clear Use Default. Enter the short name of the company exactly as it is defined in the destination system.
- targetCompanyId: Default = Not Mapped. Clear Use Default. Enter the Company ID exactly as it is defined in the destination system.
- (Optional) From the Process Property dropdown list, select APIErrorHandlerProperties to define how to handle errors if integration runs exceed the limitations of an API.
InitialTimeToWait: If an API limit is exceeded, this property defines how long to wait before sending the API call again.
Default = 60000 ms (1 minute)
This property sets only the first retry. If the API call has to be sent again, each repetition adds 60,000 ms to the wait time.
Example:
- 1st TimetoWait = 60,000 ms (InitialTimeToWait)
- 2nd TimetoWait = 60,000 ms + 60,000 ms = 120,000 ms
- 3rd TimetoWait = 60,000 ms + (2 * 60,000 ms) = 180,000 ms
To change the initial wait time:
- Clear Use Default.
- Enter the wait time in milliseconds (ms) up to a maximum of 180000 ms.
-
This integration uses cross-reference tables (CRT) to assign profiles to the employees during the import.
From the Process Property dropdown list, select HCMSkillsAndCertsImport-v1_CRTConfig to define headers in cross-reference tables.
Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.
Caution: The Boomi™ application does not return default values for cross-reference table headers. You have to enter the headings in Value.
Note: For details, see Configure cross-reference tables.
For each of the tables:
- Clear Use Default.
- In Value, enter the header column names, separated by commas (,) but no spaces, exactly as shown below the Value field. You can select and copy the headers from the screen, then paste them in the Value field.
- Repeat for the other tables.
-
In Process Property, select HCMSkillsAndCertsImport-v1_ProcessProperties to set process properties that must be configured before the integration can run.
Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.
Process Properties Property Required Actions Hyperfind A search engine that filters and selects groups of employees through queries that specify conditions or locations (criteria). Required Default = 1 (shown as blank) which indicates All Home A query that returns a list of employees associated with a manager's employee group. All Home finds people who are active employees or active users as of today. and includes all active employees.
To use a Hyperfind query for another group of employees:
- Clear Use Default.
- Enter the ID of the Hyperfind.
Note:
- Ad-hoc Hyperfinds are not supported.
- All Home does not include terminated and inactive employees even if they have totals during the period. To include these totals, configure a Hyperfind that includes terminated and inactive employees and select that Hyperfind in this process property.
- The maximum number of employees in a Hyperfind is 3500. To process more employee records, divide the population into smaller Hyperfinds to run sequentially.
Include Employees Required Default = Include all employees.
To process data for only a limited group of employees:
- Clear Use Default.
- Enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.
Example: 13997,15556,20012
Note: This property is ignored by scheduled integration runs.
Enable CRT for Proficiency Not required Default = true; use the HCMSkillsAndCertsImport_Proficiency cross-reference table to map the proficiency levels between the systems.
To not use the cross-reference table to map the proficiency levels, but directly map the levels:
- Clear Use Default.
- In Value, enter false.
Skills Import Required Default = true.
To not import skills:
- Clear Use Default.
- In Value, enter false.
Certificates Import Required Default = true.
To not import certifications:
- Clear Use Default.
- In Value, enter false.
WFD Certification Mapping Required if Certificates Import is true. Default = Both.
To change the type of certifications to map:
- Clear Use Default.
- In Value, select one of the following:
- Training/Certification: Map training activities to certifications.
- Credentials: Map formal credentials to certifications.
- Both (default): Map credentials and training to certifications.
Export Primary Accounts Only Required Default = true; export employee data only for the primary account.
To export data for all accounts:
- Clear Use Default.
- Leave Value blank.
Hyperfind IDType Not required Default = the setting in Dimensions.
To change the type of hyperfind ID:
- Clear Use Default.
- In Value, enter one of the following:
- Location
- Hyperfind
Delta Not required Default = false.
To set whether to import all or only employee records that had changes to skills, certifications, credentials, or demographic information:
- Clear Use Default.
- In Value, enter one of the following:
- true = Import only employee records that had changes to skills, certifications, credentials, or demographic information during the Lookback Days.
- false = Import the skills, certifications, credentials, and demographic information for all employee records.
Lookback Not required Default = 1 day.
To change the number of days in the past to retrieve records from the date of the integration run:
- Clear Use Default.
- Enter the number of days.
Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.
A cross-reference table (CRT) translates parameter values in an integration as follows:
- Organizes data values into rows and columns:
- Maximums = 20 columns, 10,000 rows.
- Can combine values from multiple columns to determine a single output value.
- If more than one row matches a reference value, the first match is the output value.
- If no match is found, the output value can be null, or the integration can produce errors.
-
Caution: Make sure that Use Default is not selected in Process Properties > EnableCRTforProficiency, and that the headers are defined.
- Select Cross Reference.
- From the Cross Reference dropdown list, select the following table:
Note: You cannot change the name of the table.
_Proficiency
Maps proficiency levels for each skill or certification of the employee between systems.
- Skill levels in HCM are numeric values; proficiency levels in Dimensions are text.
- Proficiency levels rank employees by their level of proficiency in a skill or certification, or define the level of proficiency that is needed to perform a job. When you assign a skill or certification to an employee, the system automatically tags it with a generic proficiency level Rank employees by their level of proficiency in a skill or certification, or define the level of proficiency that is needed to perform a job. of Any. However, you can define a proficiency level to indicate the employee’s actual level of expertise. Updates to proficiency levels create a new skill or certification assignment.
Column headers:
ProficiencyHCM,ProficiencyWFD
Example _Proficiency cross-reference table ProficiencyHCM ProficiencyWFD 1 Low 2 Low 3 Medium 4 Medium 5 High * Any Note:For simple pattern matching, table entries can include wildcard characters:
- Question mark (?) for a single character
- Asterisk (*) for multiple characters
-
Select Override to:
- Download the tables when you run the integration
- Edit the table cells in Extensions
Note: The data maps are not exposed for this integration.
Skills - Dimensions HCM | Skills - Dimensions | |
---|---|---|
Field | Field | Field type |
Skill | Skills | Required |
— | Display Name | Automatically populated from the configuration |
Skill Level | Proficiency Level | Default = Any |
Active | Status | Default = Active |
|
Effective Date | Required |
Certifications - Dimensions HCM | Certifications - Dimensions | ||
---|---|---|---|
Training or certification | Credentials | Field | Field type |
Course or Certification | Credential Type | Certification | Required |
— | — | Display Name | Automatically populated from the configuration |
— | Document | Number | — |
Default = Any | Default = Any | Proficiency Level | Default = Any |
Last Completion Date | Issued | Grant Date | Required |
Expiration Date | Expires |
Expiration Date Note: Expired certifications are not imported. |
Required Note: Expired credentials are not imported. |
API | Section | Type | Resource Path | Location |
---|---|---|---|---|
GetHcmTraining | Global | POST | /ta/rest/v1/report/global/REPORT_HR_EMPLOYEE_TRAININGS | _GetHcmTrainings |
GetHcmCredentials | Global | POST | /ta/rest/v1/report/global/REPORT_HR_CREDENTIALS | _GetHCMCredentials |
GetHcmTrainingMetadata | Global | GET | /ta/rest/v1/report/global/REPORT_HR_EMPLOYEE_TRAININGS/metadata | _GetHcmReportsMetadata |
GetHcmCredentialsMetadata | Global | GET | /ta/rest/v1/report/global/REPORT_HR_CREDENTIALS/metadata | _GetHcmReportsMetadata |
Process Callback | Platform | POST | /v1/platform/integrations/update_status | _WFD Callback |
GetHcmSkills | Companies | GET | /ta/rest/v2/companies/{{CID}}/employees/{{account_id}}/skills | _GetHcmAllSkills |
GetAllHcmEmployees | Companies | GET | /ta/rest/v2/companies/{{CID}}/employees | _GetHcmEmployeesAccountid |
UpdateSkills | Commons | POST | /v1/commons/persons/skills/multi_upsert | _UpsertSkills |
Certificate multi upsert | Commons | POST | /v1/commons/persons/certifications/multi_upsert | _UpsertFromTrainings |
Certificate multi upsert | Commons | POST | /v1/commons/persons/certifications/multi_upsert | _UpsertFromCredentials |
ExecuteHyperfind | Commons | POST | /v1/commons/hyperfind/execute | _ExecuteHyperfind |
RetrieveEmpSkills | Commons | POST | v1/commons/persons/Skills/multi_read | _UpsertSkills |
RetrieveWFDProficiencyLevel | Scheduling | GET | /v1/scheduling/proficiency_levels | _GetWFDProficiencyLevel |
RetrieveAllCerts | Scheduling | GET | /v1/scheduling/certifications | _GetWFDAllCertifications |
RetrieveAllSkills | Scheduling | GET | /v1/scheduling/skills | _GetWFDAllSkills |
HcmSkillsLookup | Companies | GET | /ta/rest/v2/companies/{{CID}}/lookup/skills | _GetHcmAllSkills |
Integration Details | Platform | POST | /v1/platform/integration_executions/ | _Submit Integration Details |