PushFunctions service description

PushFunctions is a service which allows to send Punch and miscellaneous transactions from third party systems to AMG Attendance System. API interface is the same for both desktop and web based systems.

PushFunctions service is hosted on AMG Attendance System’s Auto Process windows service as an XML-RPC service powered by XML-RPC.NET. AMG Attendance System desktop based version should be of version 1.15.12.6 or higher.

First make sure that Auto Process service is started and running.

Open a browser and enter http://[ip address]:3003/Services/PushFunctions.ashx to see inline documentation of the service.

If you use AMG Attendance System Online web based attendance system you have to connect to http://amgwebclock.com/Services/PushFunctions.ashx

 

The following methods are supported:

• SendMiscEntry
• SendPunches

 

Method SendMiscEntry

Receives miscellaneous entries log and stores into database. Category code should exist in AMG's database. The given category should be active.

Parameters

string	user - User login name registered in AMG Attendance System.
string	password - Password of the user account provided above.
array of MiscData	entries - Array of MiscData.

Return Value

string

Returns empty string if entries were successfully committed to system, otherwise returns error message.

 

Method SendPunches

Receives punch log from a device. Device's code should exist in AMG Attendance System's database.

Parameters

string	user - User login name registered in AMG Attendance System.
string	code - Device's code as registered in AMG Attendance System.
string	password - The password of Administrator user account.
array of PunchData	punches - Array of PunchData.

Return Value

string

Returns empty string if punches were successfully committed to system, otherwise returns error message.

 

MiscData Structure

Members

integer	UserId Employee's badge number.
dateTime	DateTime (optional) Date and time of miscellaneous entry. By default is system’s current date/time.
string	Category (optional) Category code, default value 'TIP', maximum 10 characters long.
double	Amount Either hours or money for miscellaneous entry. Range -99999.99 to 99999.99 except for 0.
string	Comment (optional) Comment for miscellaneous entry transaction. Maximum 255 characters long.

PunchData Structure

Members

integer	UserId Employee's badge number.
dateTime	DateTime Exact date and time of punch.
integer	Function Punch type. The following types are supported: Clock In = 33 Clock Out = 34 In From Lunch = 35 Out For Lunch = 36 In From Break = 37 Out For Break = 38 Enter Department = 39 Enter Job = 40 Door Access = 48 Swipe and Go (In) = 49 Swipe and Go (Out) = 50 Return Call = 51 Swipe And Go = 255
string	Data If the Function parameter is either Enter Job (40) or Enter Department (39) then this parameter holds corresponding job/department code, otherwise it should be an empty string.

 

This API is subject to change without informing users. This post will reflect latest changes to provide up-to-date documentation of API. You can subscribe to this blog to receive farther change notifications automatically.

Importing payroll data from AMG Attendance System into ADP RUN payroll

For importing payroll data from AMG Attendance System into RUN payroll powered by ADP there are the following two methods available:

1. Exporting RUN payroll file ("RUN_Payroll.json") and importing into ADP RUN payroll system - available both for AMG Attendance System Desktop (starting from 1.15.12.4 version) and AMG Attendance System Online
2. Importing payroll data directly from AMG Attendance System Online

Prerequisites

1. Use Google Chrome or Opera (starting from v15.0) browser
2. If using AMG Attendance System Desktop, make sure software version is 1.15.12.4 or higher
3. Make sure "Run payroll data import from AMG Attendance System" extension ("RUN Payroll.crx") is added into your browser extensions list (read below the description of how to add the extension)

Adding "RUN Payroll.crx" extension to extensions list
For adding "RUN Payroll.crx" extension follow these steps:

1. Click here to open extension page.
   
   
2. Click on "+ ADD TO CHROME" button in the top right corner. 
3. As a result in the top middle of the page will pop-up the following message box (see image below), where you should click on "Add extension" button, to add RUN payroll extension to your browser extensions.
   
   
   
   
4. After clicking on "Add extension" button, will appear another pop-up message in the right corner of the page (see image below), which means that "RUN payroll import from AMG Attendance System" extension is added into extensions list.
   
   

After adding "RUN Payroll.crx" extension, if opening RUN payroll system, in right corner of address bar will appear the following icon (see the red box in the image below):

Importing payroll data from ADP RUN payroll export file

For importing payroll data from ADP RUN payroll export file follow these steps:

1. Generate ADP RUN payroll export file ("RUN_Payroll.json") from AMG Attendance System Desktop or AMG Attendance System Online (whichever version you use).
2. Login into ADP RUN Payroll system (https://runpayroll.adp.com/enrollment.aspx?autofwd=0).
3. Navigate to Run Payroll page.
4. Click on the special icon in the right corner of the address bar. As a result will appear the following pop-up window (see image below):
   
5. Click on Choose File button, select generated "RUN_Payroll.json" file from your computer and click on Open button (or drag and drop "RUN_Payroll.json" file into Choose File button)

NOTE: After selecting file, pop-up window will be automatically closed, and will automatically start import of payroll data. After import is finished, all imported data will automatically appear in the table and you will see "Importing data has successfully finished." message, if there were no warnings.


Importing payroll data directly from AMG Attendance System Online

For importing payroll data directly from AMG Attendance System Online, follow these steps:

1. Navigate to Run Payroll page.
2. Click on the special icon in the right corner of the address bar. As a result will appear the following pop-up window (see image below):
   
3. Log in with your AMG Attendance System Online account (e-mail, password). After that you will see the following screen (see image below):
   
4. Click on Import Payroll Data button to start importing data right from the AMG Attendance System Online. (IMPORTANT: while importing data DO NOT navigate to any other page or tab).

NOTE: After import is finished all imported data will automatically appear in the table and you will see "Importing data has successfully finished." message, if there were no warnings.

IMPORTANT NOTES REGARDING PAYROLL DATA IMPORT:

1. Employees are being identified by their first name + middle name + last name, so be attentive that employees' names be spelled in ADP RUN payroll and AMG Attendance System in the same way.
2. Categories in ADP RUN payroll are being matched with categories in AMG Attendance System by categories' export code names, that's why, for example, if in the ADP RUN payroll you have "TEST Hours" category, then in the "AMG Attendance System -> Categories" for the corresponding category you should enter TEST as an export code name.
3. The system will output warnings in the following cases:
   • In the file being imported there are employees who are missing in ADP RUN payroll (e.g. in the file being imported there is Test Test employee, but in the ADP RUN payroll there is no such employee)
   • In the file being imported there is no information about some employees existing in ADP RUN payroll (e.g. in the ADP RUN payroll there is Test Test employee, but in the file being imported there is no such employee)
   • In the file being imported there are category export names which do not exist in ADP RUN payroll (e.g. in the file being imported there is VACATION category, but in the ADP RUN payroll there is no such category)
   • In the file being imported there are categories which do not have export names (e.g. in the file being imported there are some hours category export name of which is empty, because in the AMG system it was not entered)
   • In the file being imported there are categories the type of which is different from the one mentioned in ADP RUN payroll (e.g. in the file being imported there is VACATION category the type of which is Hours, but in the ADP RUN payroll the type of VACATION category is Money)

NOTE: If the system outputs any of the above mentioned warnings, then ONLY the record to which warning refers is NOT being imported, all other data are being successfully imported.