Integration Hub (iHUB)

Integration Hub (iHUB) Overview

Integration Hub is a separate portal designed to run integration jobs to synchronise data between Citation HR Software and third party applications.

Note: The iHub and API refers to enableHR. enableHR is a sister company to Citation HR and Citation HR Software is powered by enableHR technology.

As an Account Admin, you can do the following;

Connections Page:

  • Setup integrations by adding connections to third party applications. (You will be required to enter credentials in both systems)
  • Delete connections to third party applications to remove the integration

Jobs Page:

  • Initiate an integration job on an on-demand basis
  • Initiate/cancel integration jobs to run at a defined schedule

Reports Page:

  • View synchronisation job details, error details etc

 

How to access iHUB

You will need to contact our Customer Support Team to request access to iHub. We will update the settings on your account and assign the require User Access Roles. Once setup, Account Admins can login to iHUB using the same credentials that you login to Citation HR Software with. 

 

How to setup a connection between Citation HR Software and other systems

After being granted access by our Customer Support Team, login to the iHUB portal - (https://ihub.enablehr.com/), you should see the landing page below:

Landing Page.png

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. Citation HR Software Support users will have ‘read only’ access to this page.

  1. Add a new connection between source and target systems

Add connection.png

2. Click on ‘Connect’ button on Source (enableHR) and Destination/target systems by authenicating with the credentials for each system.

connections page.png

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.

connections_page2.png

 

How to schedule an Integration job between Citation HR Software 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 Citation HR Software 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. 

schedule job.png

 

How to 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.

manual job.png

 

How to '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.

cancel job.png

 

How to see the Integration job details

iHUB users are able to view the results of integration job for each and every run under 'Reports' page.

Note: Both account admin and as well as Citation HR Software Support users are allowed to access the ‘Reports’ page, this is mainly to track the job status and run details to know

 

Reports Page:

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#.

 

Reportspage.png

 

Report Details:

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.

 

Reports detail.png

Related to