Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maniamartial authored Sep 3, 2024
1 parent 9a02fe5 commit 97e0bc9
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# CAMS Biometric Integration with ERPNext
# CAMS Biometric Integration with FrappeHR

## Introduction
![checkin](https://github.com/user-attachments/assets/57857c26-a164-4f28-8c60-e7a4bcb4a67e)

Integrating the [CAMS biometric system](https://camsunit.com/application/biometric-web-api.html) with ERPNext enables real-time attendance tracking and automated data synchronization. This integration allows you to efficiently capture and manage punch logs directly from your biometric devices, ensuring accurate and up-to-date attendance records.
Integrating the [CAMS biometric system](https://camsunit.com/application/biometric-web-api.html) with FrappeHR enables real-time attendance tracking and automated data synchronization. This integration allows you to efficiently capture and manage punch logs directly from your biometric devices, ensuring accurate and up-to-date attendance records.

By setting up this integration, you can streamline your attendance processes, minimize manual data entry, and enhance overall accuracy in tracking employee time. The integration ensures that punch data from CAMS biometric devices is seamlessly transferred to ERPNext, where it is recorded in real-time, helping you maintain a reliable attendance management system.
By setting up this integration, you can streamline your attendance processes, minimize manual data entry, and enhance overall accuracy in tracking employee time. The integration ensures that punch data from CAMS biometric devices is seamlessly transferred to FrappeHR, where it is recorded in real-time, helping you maintain a reliable attendance management system.

## 1. Setup and Configuration

Expand All @@ -14,7 +14,7 @@ By setting up this integration, you can streamline your attendance processes, mi
1. **Service Tag ID and Auth Token:**

- After acquiring an account with CAMS, you will receive a `Service Tag ID` and `Auth Token`.
- These credentials are crucial for configuring the CAMS unit and integrating it with ERPNext.
- These credentials are crucial for configuring the CAMS unit and integrating it with FrappeHR.
- Fill those details in the respective field in the cams biometric settings doctype.
![cams biometric setting](https://github.com/user-attachments/assets/66520601-edfa-49bf-9af6-2f9602f57256)

Expand All @@ -26,10 +26,10 @@ By setting up this integration, you can streamline your attendance processes, mi
- CAMS operates there own server, where punches are recorded, and to ensure proper integration, you need to provide a callback URL.
- In our app, we have a function called attendance ,for handling attendance data. Our URL will generally follow this format:
`{site}/api/method/navari_cams_biometric.cams_biometric.controllers.cams_call.attendance`

- Example URL:

- Copy this API endpoint and remember to replace the {site} with your subdomain.
For Example if your site is https://example.erpnext.com then the link will be:
`https://example.erpnext.com/api/method/navari_cams_biometric.cams_biometric.controllers.cams_call.attendance`
- Copy this API endpoint.

2. **API Configuration in CAMS:**
Log into your [cams unit](https://camsunit.com/#) account
Expand All @@ -39,12 +39,12 @@ By setting up this integration, you can streamline your attendance processes, mi

3. **Punching Data:**
- Once the callback API is set up, you can use the biometric device to record employee punches.
- Each punch event will be sent to ERPNext, where it will be recorded in the Employee Check-in records.
- Each punch event will be sent to FrappeHR, where it will be recorded in the Employee Check-in records.

### 1.3 Employee Configuration

1. **Employee Biometric ID Mapping:**
- Each employee must be assigned a unique biometric ID in the ERPNext system, similar to the one registered in the cams device.
- Each employee must be assigned a unique biometric ID in the FrappeHR system, similar to the one registered in the cams device.
- It is recommended that this ID closely resembles the employee’s system ID for consistency.
- Since you have registered the employee on cam device, get the same id and fill it in the Attendance/biometric ID field on Employee doctype
![shifts](https://github.com/user-attachments/assets/0118e33f-dad1-4027-92da-694ab162d69a)
Expand All @@ -65,7 +65,7 @@ By setting up this integration, you can streamline your attendance processes, mi

**Fetching Historical Punch Logs:**
- In case where you want to retrieve old/historical punch logs, we have a feature on cams biometric settings doctype.
- To retrieve punch logs, navigate to the CAMS Biometric Settings in ERPNext.
- To retrieve punch logs, navigate to the CAMS Biometric Settings in FrappeHR.
- Enter the `Start Date` and `End Date` fields to specify the range for the punch logs.
- Click on `Load Punchlog` to fetch the attendance records. So that you know, this feature is available depending on your CAMS subscription plan.

Expand All @@ -77,9 +77,11 @@ By setting up this integration, you can streamline your attendance processes, mi

2. [Install ERPNext](https://github.com/frappe/erpnext#installation)

3. [Intsall FrappeHr](https://github.com/frappe/hrms#installation)



3. Once bench and ERPNext are installed, add navari_cams_biometric to your bench by running:
4. Once bench, ERPNext and FrappeHR are installed, add navari_cams_biometric to your bench by running:


```sh
Expand All @@ -90,10 +92,10 @@ $ bench get-app --branch {branch-name} https://github.com/navariltd/navari_
```


Replace `{branch-name}` with the desired branch name from the repository. Ensure compatibility with your installed versions of Frappe and ERPNext.
Replace `{branch-name}` with the desired branch name from the repository. Ensure compatibility with your installed versions of Frappe, ERPNext and Frappe HR.


4. Install the navari_cams_biometric app on your site by running:
5. Install the navari_cams_biometric app on your site by running:


```sh
Expand All @@ -114,7 +116,7 @@ Replace `{sitename}` with the name of your site.

- Create a new site.

- Choose Frappe Version-14/Version-15 or above, and select ERPNext, and Cams Biometric from the available Apps to Install.
- Choose Frappe Version-14/Version-15 or above, and select ERPNext, Frappe HR, and Cams Biometric from the available Apps to Install.

- Within minutes, the site will be up and running with a fresh install, ready to explore the app's simple and impressive features.

Expand Down

0 comments on commit 97e0bc9

Please sign in to comment.