Introduction
You will need to request access to iThink Connect Sync for Breathe HR by contacting us.
Whilst the product is launched it requires setup and configuration support from ourselves.
We aim to include automated onboarding and greater visibility into what the application is doing with the next version.
This document explains the process of setting up and installing the iThink Connect Sync product.
Please follow the appropriate instructions for the Human Resources Information System you are connecting to.
Pre-requisites
the Firstly, you will need to be or have access to a person who has been assigned the Global Administrator within Microsoft Entra ID (Formerly Azure Active Directory) role.
Let's get started!
Register for iThink Connect
Register for iThink Connect.
Browse to https://setup.connect.apps.ithink365.co.uk
You will see the following screen.
- Scroll down and click the “Get started – sign in” button.
- Accept the consent for iThink Connect Customer Portal” if it pops up. This allows iThink Connect to read your user information and is need to continue.
- Click “Consent on behalf of your organisation”
- Click Accept
You will be presented with the Start iThink Connect Setup page.
- Check the email address at the top of the screen.
- Click Start iThink Connect Setup button
You will be taken through a setup wizard.
- Please fill out your company size.
- Please choose the domain that you use as your primary domain.
- Please fill out your details, and company address.
- Choose Yes to accept the confirmation to setup iThink Connect for the tenant.
- Click Submit.
You will be presented with screen two of the Setup Wizard.
If you have not consented to the iThink Connect Api then you will be asked to consent the application.
- Click “Consent iThink Connect Api”
- Login with your credentials.
- Check the permissions requested and click Accept.
You will receive congratulations, consent to the iThink Connect Api was successful.
Sign up for iThink Connect Sync Subscription
The next step is to sign up for the iThink Connect Sync subscription.
- Click on the Home icon and you will see the Welcome screen.
Click on Products
You should be able to see the iThink Connect Sync Product if you cannot please contact [email protected] as we are rolling this product out through a gradual program to ensure that our quality and performance levels are maintained.
Click on the Start Subscription button on the iThink Connect Sync for People HR product tile.
- Click Start Trial
- Choose the number of users by changing the Quantity
- Fill in your card information.
- Fill in your address
- Choose I am purchasing as a business
- Click Start Trial
Once you have signed up to the subscription wait a few seconds and the subscription will be setup.
You may need to consent the iThink Connect Api.
Once consented you are ready to set up the product.
Setup the Product
- Click Setup Product
- Next, we need to setup the iThink Connect Sync settings.
- Depending on the HRIS platform there maybe different settings to apply.
HRIS Settings
Breathe HR
You will need the following settings from Breathe HR.
The API Key. To get the API Key doing the following:
- Login to Breathe HR.
- Click on Configure and Settings from the HR Dashboard
- Choose Integrations and API Setup
- If you do not see an api key but rather disabled
- Click on the Enable API button
- Accept the warning and the copy the production API key
- It is the one that starts with prod-
Fill out the product settings for iThink Connect Sync.
- Paste the API key that was copied from Breathe HR into the API key field
- Enable the Sync button
- We will enable the sync write later in the process.
- Choose default password and provide the password that new users will be given.
- Set your timezone, this is important as it is used to determine when to disable the user’s account.
- Choose the time that you wish to disable the user at, normally we would recommend 18:00.
- Field Mappings
- Copy and paste the JSON below into the Field Mappings Text Box.
--- start JSON copy the [ and beyond ---
[{"SourceField":null,"TargetField":"GivenName","Value":"{{employee:first_name}}"},{"SourceField":null,"TargetField":"Surname","Value":"{{employee:last_name}}"},{"SourceField":null,"TargetField":"DisplayName","Value":"{{employee:first_name}} {{employee:last_name}} ([Company Name])"},{"SourceField":null,"TargetField":"MobilePhone","Value":"{{employee:work_mobile}}"},{"SourceField":null,"TargetField":"JobTitle","Value":"{{employee:job_title}}"},{"SourceField":null,"TargetField":"OfficeLocation","Value":"{{employee:Location}}"},{"SourceField":null,"TargetField":"EmployeeHireDate","Value":"{{employee:JoinDate}}"},{"SourceField":null,"TargetField":"EmployeeId","Value":"{{employee:id}}"},{"SourceField":null,"TargetField":"Department","Value":"{{employee:Department}}"},{"SourceField":null,"TargetField":"Division","Value":"{{employee:Division}}"},{"SourceField":null,"TargetField":"City","Value":"{{employee:city}}"},{"SourceField":null,"TargetField":"Country","Value":"{{employee:country}}"},{"SourceField":null,"TargetField":"EmployeeType","Value":"{{employee:person_type}}"}]
--- end JSON copy to the end of the ]
Find the [Company Name] and replace with your company name.
Using the Field Mappings Configuration Tool
The Field Mappings Configuration tool is accessed from the Product Settings screen by clicking on Edit Field Mappings.
Add Mappings and then use the Target Field to select the Microsoft Entra ID field to populate with the Mapping Value.
The defaults are the following:
Target Field | Mapping Value | Comments |
GivenName | KnownAs_Or_FirstName |
|
Surname | last_name |
|
DisplayName | KnownAs_Or_FirstName last_name ([your company name]) |
|
Mobile Phone | work_mobile |
|
JobTitle | job_title |
|
OfficeLocation | location |
|
EmployeeHireDate | JoinDate |
|
EmployeeId | id |
|
Department | Department |
|
Division | Division |
|
City | Location |
|
Country | country |
|
CompanyName | [Your Company Name] |
|
EmployeeType | person_type |
|
Please note the [Your Company Name] you would replace this with the text of your company name or use a different field which contains your company name details. For example, you might use division.
Please be aware that the mappings of text to date/time fields is not checked and so you need to be careful when mapping fields that the right mappings with the right data types are used.
- Click Submit to save your settings.
Configuring Event Handlers
The Event Handlers section will require that you have a Power Automate or Logic App or Webhook setup. For each event provide the URL to end point and enable that event.
The events are the following:
- User Created – when a user is created in Breathe HR it will then be created in Microsoft Entra ID.
- User Disabled – when a user has been flagged as leaving and the leave date plus time that has been set to disable is reached. This event will be flagged.
- Enable User Due To Start Event Handler is fired when a new user has been added to Breathe HR.
- Enable User Has started event handler is fired on the day that the user starts.
- Enable User is Leaving event handler is fired when iThink Connect Sync picks up that a user has been flagged as leaving.
Enable the events which you would like to initiate a workflow or be notified for. Provide the URL to the endpoint that will receive the workflow event.
Once you have configured all your settings.
- Click Save.
Consent the iThink Connect Sync Entra Application
First of all, you need to consent to the iThink Connect Sync application. The reason is this is the application that performs the synchronization process and creates users, disables users and it does need some additional permissions. The application needs to be a privileged administrator because it might need to disable an account that is a Global Admin!
To consent the application, do the following:
This will give the application the following permissions.
Setup permissions to be able to modify Privileged users
In order that the system can update Global Admins and other privileged users you will need to add the iThink Connect Sync tool into the Privileged Authentication Administrators Role.
- Browse to https://portal.azure.com
- Click on Microsoft Entra ID
- Choose Roles and administrators
- Search for Privileged Authentication Administrators
- Open Role
- Search for iThink Connect Sync
- Add and click save