HCM Connector for JIRA Technical
1. Purpose:
The purpose of this document is to show the implementation design of HCM Connector JIRA plugin.
2. Introduction:
It is JIRA plugin that enables seamless integration/automation between SAP SuccessFactors & Atlassian JIRA. It syncs the employee from SuccessFactors and automatically creates user in JIRA. It provides automatic and manual mode to sync employee from SuccessFactors.
3. Scope:
HCM Connector JIRA plugin provides automation to create user when employee add on SuccessFactors platform. Now It supports only for new hire event.
4. High Level Design:
HCM Connector JIRA plugin high level design and description.
4.2 Description:
- Manual Sync - Once user click on manual sync records from HCMConnectorJIRA plugin then it looks new hire employees in SuccessFactors database for given time period. If any new hire employees are available then it creates user in JIRA for those employee based on settings.
- Automatic Sync - Once user add any new employee on SuccessFactors platform then immediately it triggers the new hire event and it calls rest api of HCMConnectorJIRA plugin through the intelligence service of SuccessFactors. Once event is triggered then it creates user in JIRA for the employee based on settings.
5. Modules:
These four modules are available in HCMConnector:
- Integration Setting - This page is responsible to save the SuccessFactors connection settings and events setup. User can configure the connection settings, events and sync mode(Manual or Automatic).
- User Settings - This is the configuration page for auto user creation on syn employee.
- Field Mangament - This is the configurationa page for enable user properties. It adds extra information to user in JIRA.
- User Managemengt - This page to view all the sync employees from SuccessFactors. It use to view, create and mapped SuccessFactors employee to JIRA user.
6. Process Flow Diagram:
6.1 Process Flow Design:
6.2 Process Flow Description:
6.2.1 Steps below for the Integration Settings:
Step 1: Login as JIRA admin user and go to Add-ons section and click on integration setting page.
Step 2: Click on edit Setting and provide tenant id, user, password, data center, SF API URl and configure module. Click on the "Test Connection".
Note:
- If sync frequency is Manual means it syncs the records as manual mode for given time range.
- If sync frequency is Automatic means it syncs the records through intelligence service (Real Time Sync).
Step 3: If test connection is success then click on "Save Connection" button. Screen below will appear.