1. Yomly
  2. Tutorials
  3. Integrating Yomly with external apps

Integrating T&A with the BioTime application

Peter Williams
Updated

Introduction

The BioTime application is used by customers of ZKTeco to manage their fleet of biometric terminals.

You can collect clocking information from the fleet of biometric terminals and sync it with the Time & Attendance (T&A) feature of the Yomly platform. You can do this using the EmiratesHR - BioTime adapter, which you can install on the same server as your BioTime application.

Objective

In this tutorial, you will learn how to integrate Time & Attendance with the BioTime application.

Procedure

To achieve the objective, you must do the following:

  1. Install the EmiratesHR - BioTime adaptor.
  2. Configure BioTime to enable the integration.
  3. Generate the Yomly API key.
  4. Configure Yomly to enable the integration.
  5. Review the configuration.
  6. Retest the integration.
  7. Run the job for the first time.

Step 1: Install the EmiratesHR - BioTime adaptor

  1. Download the installer for the EmiratesHR - BioTime adaptor. To do this, click here.

  2. Log in to the Windows server as an administrator.

  3. Upload the installer (EmiratesHR Biotime Collector.msi) onto the server.

  4. Run the installer.

Step 2: Configure BioTime to enable the integration

  1. Navigate to C:\Program Files\Yomly\BioTime Integration.

  2. Run emirateshrProxy-config.

  3. Enter "1" for Edit BioTime Configuration.

  4. Enter the number that corresponds to the details that you want to edit.

    The first time you do this, enter "1".

  5. Enter the following details:

    Field Description
    Host address

    IP address or URL for the admin login portal.

    For example, in the following image, the host address is "http://biotimedxb.com".
    Port

    Port for admin login.

    For example, in the following image, the port is "8085".
    BioTime user Username that enables the admin user to login with superuser access
    BioTime password Login password
    Initial date Start date for data collection

  6. The connection is automatically tested. You can review the details of any errors in the Log folder, which is available in the BioTime Integration folder.

    blobid0.png

Step 3: Generate the Yomly API key

To authorize integration with the Yomly API, an API key is required.

You must generate the key using an account that has the HRADMIN role. If you generate it using a user account with any other role, when the records are synchronized, all of them will be attributed to only the user.

  1. Log in to Yomly as an HR Admin user.

  2. In the sidebar, in the Business section, click Settings.

    blobid1.png

  3. Go to General > API Keys.

    integration-t-and-a-with-biotime-1.png

  4. Click + Add API Key.

  5. Enter an Issue Date and Valid for date, which are the start and end dates of validity of the API key, respectively.

    blobid3.png

  6. (Optional) In IPcdr, enter an IP address range from which the key will be used.

  7. (Optional) In Comments, enter a comment to document why you have generated the key. For example, enter "BioTime integration".

  8. Click Generate API Key.

    blobid4.png

  9. Click Copy API Key to copy the Generated API Key and paste it in a text file or note. Also copy and paste the associated API key ID.

    You can copy the Generated API Key only at this time (immediately after creating it).

    The API key ID is the number displayed in the new expandable section. For example, in the previous image, it is the number that starts with "15872...".

Step 4: Configure Yomly to enable the integration

  1. Navigate to C:\Program Files\Yomly\BioTime Integration.

  2. Run emirateshrProxy-config.

  3. Enter "2" for Edit Yomly Configuration.

  4. Enter the following details:

    Field Description
    API Key ID

    The associated API key ID generated in step 3 that you saved in an external file or note
    API Key

    The API Key generated in step 3 that you saved in an external file or note

  5. The connection is automatically tested. You can review the details of any errors in the Logs folder, which is available in the BioTime Integration folder.

Step 5: Review the configuration

To review the settings you just configured, do the following:

  1. Navigate to C:\Program Files\Yomly\BioTime Integration.

  2. Run emirateshrProxy-config.

  3. Enter "3" for View All Configuration.

Step 6: Retest the integration

To retest the connection between Yomly and BioTime, do the following:

  1. Navigate to C:\Program Files\Yomly\BioTime Integration.

  2. Run emirateshrProxy-config.

  3. Enter "4" for Test a Connection.

  4. Enter the number that corresponds to the connection you want to test.
  5. Review the log file to view view success and error messages. This file is available in the Log folder in the BioTime Integration folder.

Step 7: Run the integration for the first time

  1. Open the Windows Task Scheduler.

  2. View the Task Scheduler Library.

  3. Disable the scheduled job, Yomly-Biotime-Collector.

  4. Navigate to C:\Program Files\Yomly\BioTime Integration.

  5. Run emirateshrProxy. Contact us if any error occurs.

  6. After the program successfully finishes running, enable the job you disabled in step 3 of this procedure.

Was this article helpful?
1 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.

Articles in this section