Employee Information Management

This solution describes how your application can access and manage information about employees in Attendance on Demand. It can help you determine which use case best meets your business needs and guide you through the implementation.

  1. Background
  2. Employee Information Types
  3. Use Cases

Background

Attendance on Demand is rarely the source for new or updated employee information, but there are significant opportunities to streamline the management of employee information between systems to reduce time spent by staff and reduce the risk of errors.

Attendance on Demand provides a comprehensive API for managing employee information, whether it is adding employees, updating information, or retrieving it. The best approach to integration will vary based on the clients needs, integration strategy, and system configuration.

Function

Add, update, or retrieve employee data in an Attendance on Demand system.

Employee Information Types

Employee Detail2 Information

  • Structure - TAeEmployeeDetail2
  • Employee demographics which consist of
    • Name
    • ID
    • SSN
    • Hire Date
    • Workgroups
    • Active Status Condition ID and Effective Date
    • Address
    • Average Weekly Hours
    • Birth Date
    • Clock Group ID
    • Current Rate and Effective Date
    • Emergency Contact
    • Hourly Status ID and Effective Date
    • Inactive Status Condition ID
    • Pay Class ID and Effective Date
    • Pay Type ID and Effective Date
    • Phone Numbers
    • Schedule Pattern ID and Effective Date
    • Union Code
    • Workgroup Effective Date
    • Set of 6 Static Custom Fields to store other pertinent information
    • ESS (Employee Self Service) Pin
    • Observes Daylight Savings Time
    • Corporate Time Zone Offset

Use Cases

Attendance on Demand has identified use case scenarios for managing employee information.

Consult the table below to find the use case that aligns with your business needs, click the entry for a detailed explanation.

Use Case 1 - Adding a New Employee

Add a new employee to the database using the EmployeeDetail2 (TAeEmployeeDetail2) Structure

Highly recommended/best practice to use the maintainEmployeeDetail2 method

Preconditions

Employee ID is known/generated prior to adding

API Usage

Read getEmployeeDetail2ByIDNum

  • Verify that the employee does not already exist in the database

Write maintainEmployeeDetail2

  • Adds the employee information to the database

Exception Scenarios

  • Condition: Employee ID already exists in database
  • Response Code: TMaintainEmployeeResult value of merDupID
  • How to Handle: verify Employee ID number/existence of Employee

Use Case 2 - Retrieving all Employees Detail2 Information

Gather all employee information to produce an HR specified report

Preconditions

Access to All Employees must be granted already

API Usage

Exception Scenarios

  • Condition: Incorrect parameter(s) on call
  • Response Code: HyperQuery name does not exist
  • How to Handle: Correct the parameter. To verify acceptable queries, execute the [getHyperQueriesSimple] method

Use Case 3 - Changing a Specific Employee’s Workgroup

Edit an employee’s workgroup to represent his/her new position within the company

Preconditions

  • Access to the specific employee and either his/her Badge No., Filekey, Employee ID or SSN
  • New workgroup codes

API Usage

Exception Scenario

  • Condition: Employee record not found
  • Response Code: Employee with ID supplied does not exist
  • How to Handle: Verify Employee ID is correct

Back to Top