TAeEmployeeTransactionSampling Structure

Field Data Type Description Notes
Accuracy Double Reserved for future use
AllowTransCreation Boolean Create live transactions as configured in the FKey operation 1
Altitude Double Reserved for future use
Comments String Comments an employee may enter while punching 1
Filekey Integer AoD Employee Identifier - used when IDNum not supplied 1
FKeyGUID String Identifies the ESS Profile FKey Operation to execute 1, 5
Gatekeeper Boolean Set to True, uses the values within ESS Profile settings 11, 12, 13
IDNum String Employee identifier
IPAddr String v4 IP Address in dot notation 1, 2
Latitude Double Used to validate presence in a GeoZone 1, 6
Longitude Double Used to validate presence in a GeoZone 1, 7
ObservesDST Integer 0=Off, 1=On 4
Recompute Boolean Recompute employee’s current pay period time card 1, 9
SkipDupTest Boolean If set to True, will skip duplicate punch test 1, 8
TimeZoneOffset Integer Offset, in minutess, from the Corporate Time Zone 4
TimeZoneProvided Boolean Use Time Zone other than Corporate 3, 10

Notes

  1. Optional
  2. Used when client system is configured to restrict punch activity based on IP Address
  3. If set to True, TimeZoneOffset and ObservesDST will be used.
  4. Used when TimeZoneProvided is True
  5. When blank, the system will auto-locate FKey Operations
  6. When used, Longitude value must be supplied
  7. When used, Latitude value must be supplied
  8. Ignored when AllowTransCreation is set to True
  9. Applies only when AllowTransCreation is set to True
  10. Uses UTC time when time zone is other than Corporate
  11. Options are Both, IPAddress Only, GeoZone Only, None
  12. Selecting Both checks both IP and Geozone and if one of them passes it allows it to move forward with other checks
  13. Selecting None essentially ignores the IPAddress and GeoZone results and allows the operation to proceed

Methods Referencing Structure

employeeTransactionSampling

Back to Top