SugarCRM Implementation
As part of Moorepay's transformation strategy, the SugarCRM solution is now integrated with Moorepayhr's main database to centrally manage all customer master data and optimise the system using effective workflow management. In order to facilitate this, SugarCRM provides a daily web service that will allow Moorepay (via Payroll application) to retrieve daily changes made to the master data in Sugar API, thus ensuring that the data is synchronised and up-to-date.
Overview
The three main components of the SugarCRM implementation are master data requirements, data mapping, and data transport. Click on the corresponding dropdown to view more information on each component:
Master Data
Master data is defined as Company and Contact Information.
The current list of data in Moorepayhr/Payroll includes:
- Company Code
- Company Name
- Address Line 1
- Address Line 2
- Address Line 3
- Address Line 4
- Country
- Post Code
- Contact Name 1
- Contact Name 1 Telephone No.
- Contact Name 1 Email Address
- Contact Name 2
- Contact Name 2 Telephone No.
- Contact Name 2 Email Address
- Management Contact Name 1
- Management Contact Name 1 Telephone No.
- Management Contact Name 1 Email Address
- Management Contact Name 2
- Management Contact Name 2 Telephone No.
- Management Contact Name 2 Email Address
In Moorepayhr, these details are displayed as read-only fields on the Employer Contacts screen.
Data Mapping
To enable data mapping from SugarCRM, the customer payroll ID is mapped to the payroll product code in Sugar so that each customer will have a master parent account and subsequent products that identify each payroll company. SugarCRM will hold the 5-digit payroll reference code that will be used by both Moorepay and the customer to identify the payroll. As each payroll will have the individual details against each product, there is no need in payroll to hold the overall parent company details.
The table below shows the SugarCRM Product Contact Details and the equivalent Payroll Company Contact Details:
| SugarCRM | Payroll/MPHR Name | Payroll/MPHR Field Length |
|---|---|---|
| <Payroll ID> New Field @ Product Code | Payroll ID | 5 Char |
| Company Name | Company Name | 40 Char |
| Mailing Address | Address 1 | 40 Char |
| Mailing City | Address 2 | 40 Char |
| Mailing State / Province | Address 3 | 40 Char |
| Mailing ZIP / Postal Code | Post Code | 14 Char |
| Mailing Country | Country | 30 Char |
| Contact Owner 1 | Contact Name 1 | 50 Char |
| Mobile | Telephone Number | 30 Num |
| TBC | Email Address | 62 Char |
| Contact Owner 2 | Contact Name 2 | 50 Char |
| Mobile | Telephone Number | 30 Char |
| TBC | Email Address | 62 Char |
| Contact Owner 3 | Management Name 1 | 50 Char |
| Mobile | Telephone Number | 30 Char |
| TBC | Email Address | 62 Char |
| Contact Owner 4 | Management Name 2 | 50 Char |
| Mobile | Telephone Number | 30 Char |
| TBC | Email Address | 62 Char |
Data Transport
To facilitate data transport, Sugar will provide a web services Application Program Interface (API) for reading and writing data and a service program (REST Version 10) that will define how all information is exchanged within the application.
Data changed in Sugar will be written in a changes table that is available via API.
Validation failures from Moorepayhr or Sugar’s end will also be written to a new Global Sugar Failures screen. This screen identifies and records error-related details such as the date and time the interference ran, payroll reference, and the error message. Once an investigation has been conducted, the error will be audited and a report will be generated on the screen. At 7:00AM on a daily basis, this report will be forwarded to the Tech Support (smb.tech.support@ngahr.com) and Tech Delivery (smb.tech.delivery@ngahr.com) teams.
Logging into SugarCRM
REST (Version 10) is a core component of Sugar that defines how all information is exchanged within the application.
Consuming the Sugar API
The base endpoint for the V10 REST Service for the Sugar Sandbox instance is be found by navigating to https://sandbox.providentcrm.com/Moorepay/sugar/rest/v10/help.
First, you will need to authenticate to Sugar API. Sugar 7 uses two-legged 'OAuth2' for authentication.
Next, call the endpoint using 'GET' or 'POST' request.
Finally, receive JSON data from server. JSON is the the default input/output datatype for Sugar REST.
Other System Integrations
Custom Sugar REST API methods are also available in order to facilitate SugarCRM communication with other Moorepay systems.
Payroll Integration
A 'getModifiedInfo' (GET) method is available in the Sugar REST API to allow Moorepay to retrieve 'Contacts', 'Products', and 'Accounts' updates/changes on a daily basis. In turn, the API will return modifications to the records using a specified format. NB: For this purpose, master data is identified as 'Contacts', 'Products', and 'Accounts'.
HR Hub Integration
With Sugar replacing the Advice line database, all advise will be recorded as cases in 'Accounts' within Sugar. HR Hub will communicate with Sugar to retrieve search filters and cases relating to a specific Account Reference Number using two custom methods: 'getSearchFilters' (GET) and 'getCasesInformation' (POST).