How to set up the integration
You need to generate a token in &frankly for authentication purposes. This can be found under Account -> API Access.
Only users granted the role "Administrator" in &frankly are capable of generating API tokens.
Copy the API Key
In Alexis HR navigate to Settings -> Integrations and enter the copied API Key and click “integrate”
When successful response is given the connection is set.
How to sync users from Alexis to &frankly
As an Owner go to Engagement - Surveys - Export
When clicking Export the current state of employees will be synced to &Frankly
Employee data export
The following data is exported to &frankly
All users that are in the active state in Alexis HR
&frankly | Alexis | Comment/example |
externalId | EmployeeId | 6128e769ee5cac02018203f27 |
firstName | firstName (mandatory) | John |
lastName | lastName (mandatory) | Doe |
Work email (mandatory) | ||
phone | Work Phone (needs to be correctly formatted, or left blank) | +461234567 |
timezone | Time Zone for user |
|
role | Role | Owners = Administrator , All others = User |
accessInfo : memberOf | The employees current connected "groups". And groups are defined as
|
|
Group data export
In &frankly reports are available for groups and teams that have been offered to participate in a pulse and surpass the anonymity requirements set for an account.
Therefore when employees are exported from Alexis we make sure that the groups in &frankly is the same as the groups/entities they belong to in Alexis HR.
Alexis HR entity | Name in &frankly | Description in &frankly |
Organizations | Name of the organization | Users belonging to the [Name] Organization in AlexisHR |
Offices | Name of the Offices | Users belonging to the [Name] Office in AlexisHR |
Departments | Name of the departments | Users belonging to the [Name] Department in AlexisHR |
Teams | Name of the Teams | Users belonging to the [Name] Team in AlexisHR |
Employment types | Name of the employment types | Users belonging to the [Name] Employment types in AlexisHR |
FAQ
Frequently asked questions
Q : What happens when an employee is offboarded in Alexis HR?
A : The next time the employees are exported to &frankly and the offboarded date has passed. The employee will be removed from &frankly. Already answered surveys will be saved.
Q : I am getting an error message saying "validateThatPhoneNumberIsCorrect", what does that mean?
A : This means that one of the employees within your company has a faulty phone number and you need to correct it. You can do this through an employee report and have the work phone as one of the fields for searching.
Q : I am getting an error message saying "validateNoPhoneDuplicates", what does that mean?
A : This means that one of the employees within your company has a work phone number that is already registered to a user in &frankly and you probably need to correct it. You can do this through an employee report and have the work phone as one of the fields for searching.
Q : I am getting an error message saying "validateDuplicateMailInAnotherCompany", what does that mean?
A : This means that one of the employees within your company has a work email that already exists on a user in &frankly.
