What is Integration Hub (iHUB)?
Integration Hub (iHUB - https://ihub.enablehr.com/) is a separate portal designed to run integration jobs to synchronise data between enableHR/HRA and third party applications.
How do I get access to iHUB?
Account admins can login to iHUB through their same enableHR / HRA credentials. Before to that our enableHR's Client Support team should assign the necessary roles, please reach them at firstname.lastname@example.org to get the relevant access to iHUB portal.
What can I do on the iHUB portal?
As an account Admin, you can do the below..
Setup integrations by adding connections
Initiate/cancel Integration job to run at defined schedule
- Run an integration job on-demand basis
View synchronisation job details, error details etc.,
Delete the connections
How can you setup a connection between enableHR and other systems?
Once an user logs onto iHUB portal, they will be redirected to the Landing page as below.
Using each page you can do the below:
Connections Page: Setup ‘active’ connection between source and target systems by entering the credentials in both systems.
Jobs Page: Initiate the integration job (scheduled one or on-demand one).
Reports Page: View the results and details about the jobs
Note: Only Account Admins are allowed to setup a connection as they are asked to enter the credentials while making connections to both source and target systems. enableHR Support users will have ‘read only’ access to this page.
To setup a connection between enableHR/HRA and third party system.
Add a new connection between source and target systems
2. Click on ‘Connect’ button on Source(enableHR) and Destination/target systems by authenicating with the credentials for each system.
A new page will open up each time you click ‘Connect’ button to enter the credentials for both Source and Destination systems. After successful logins, the page will route you back to iHUB page by updating the status as ‘Connected’. First time, you will be asked to authorise to allow the user to access enableHR API or third patry API to access data.
After successful logins to both Source and Target systems, the connection will have an ‘Active’ status, which means that it is now ready to initiate job to export data from enableHR to third patry system.
How do you schedule a Integration job between enableHR and other systems?
Once an active connection is established between Source and Target systems, you are allowed to initiate an integration job to transfer data from source to target systems from the 'Jobs' page.
Note: Both account admin and as well as enableHR Support users are allowed to Job management activities through this page.
Schedule Job - Click on ‘Create’ button to initiate a schedule job between source and target systems.
How can you run an 'on-demand' job to sync data immediately?
When there is a need to transmit data immediately instead of waiting for the scheduled job run, you will have option to run the job manually. Using this option will kick off the data transfer immediately, and it does not interrupt the regular scheduled data transfer.
How can you 'cancel' a scheduled integration job?
For any reason, if you want to pause/stop the scheduled data transfer between the source and target systems, can do that using ‘Cancel Schedule’ option under the hamburger menu on the ‘Jobs’ page. One can see this option only when there exists an active schedule enabled for an integration job.
How can I see the Integration job details?
iHUB user is able to view the results of integration job for each and every run under 'Reports' page.
Note: Both account admin and as well as enableHR Support users are allowed to access the ‘Reports’ page, this is mainly to track the job status and run details to know
Through the 'Reports' page, for a chosen integration from the dropdown list on the left, we can easily track what jobs have run to completion/errored during the data sync.
Status - Will be as 'COMPLETE' when the data sync has been successfull or 'ERROR' when there was any issue with data sync. The job can fail for various reasons like Connection failure, unable to connect to the target system and unable to sync the data for any reason.
Type - This field can be either 'Scheduled' for a scheduled job or 'Manual' for an on-demand job.
Start & End Time - Will provide the timings in AEST timezone when the job has been started and ended.
Records Read - Number of records read from the source system before syncing them to target system.
Record Filtered - Number of records filtered from the source system due to various reasons like mandatory fields missing or have incomplete data.
Record Written - Number of records synced with the destination/target system.
Record Errors - While syncing or writing the data on the target system, the records that were unable to be written for reasons
More details about the job run can be viewed when clicked on the Job run ID#.
When user click on Job run ID# URL, it gives further details about the records that were processed by the integration job. This page includes
Record - Employee name
Source ID - Unique ID of employee in the source system
Target ID -Unique ID of employee in the target system
Processor - Compares data between source and target system and identifies what type of action to be taken
Writer - Action performed with the employee data. Ex: Created, Updated.