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 Synchronize the current state of employees will be synced to &Frankly
Repeat this step every time you make a change related to employees and organizations in Alexis
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 |
Attributes data export
You can export the following custom attributes from Alexis HR to &frankly that is connected to the exported users.
Attribute | Data in Alexis HR | Comment |
City | Personal - City | Optional |
Country | Personal - Country | Optional |
Gender | Personal - Legal Gender | *Needs to be created as a custom attribute with the label Gender and options must be Male, Female, Non-binary or Not-specified |
Birthdate | Birthdate | Required if active |
Employment date | Employee hire date, first employment date | Required if active |
To be able to export attributes you must first add the attributes in &frankly.
Go to Account – User management and add wanted attributes:
NOTE: If you allow Gender to be not specified on your employees you need to create a custom attribute in &frankly with the following options Male, Female, Non-binary, Not-specified. See image below
When you have added the attributes in &frankly you can sync data from Alexis to &frankly (note that all employees must have attribute data in their Alexis profile for the sync to be successful).
How to access &frankly
1. As an Owner go to Engagement - Surveys - Overview
2. When clicking View Surveys you will get directed in to &frankly
3. Go to Log in - &frankly
4. First time you log in you have to create an account:
- Add your email address
- Choose password
- Confirm password
5. Now you are ready to log in!
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.
Q : I am getting an error message saying "apiTokenValidation", what does that mean?
A : This means that the api token from &frankly that was entered when activating the integration is not currently valid.
Q : I am getting an error message saying "validateExternalProperties", what does that mean?
A : This means that &frankly expects external properties to be sent (they are activated in &frankly). Or that Alexis is sending external properties that are not activated in &frankly (but activated in Alexis HR).
In the below example Alexis is trying to send external name "not specified" for the attribute Gender but that attribute or its allowed data is not configured in &frankly.
