ACI Documentation

Employee Locate

Executive Summary

Employee Locate shows where an employee was during a service day. For a chosen employee and date, the screen plots the employee's scheduled visits on a map as a numbered route, adds the clock-in and clock-out locations reported from the mobile app, and adds the GPS tracking points recorded by AlayaCare. Supervisors use it to check that visits were attended at the right address, to see how far clock events were from the visit address, and to review the employee's travel path. Results can be exported to Excel, and each lookup is saved to a locate history that can be searched when permitted.

Key Features

  • Choose a branch, an employee, and a service date, then plot the day on a map
  • Show the employee's visits as numbered stops, optionally starting and ending at the employee's home address
  • Show clock-in and clock-out pins from each visit's work session, with an optional different colour when a clock event is further from the visit address than a set distance
  • Show GPS tracking points, limited by their reported error margin and their distance from the previous point
  • See per-employee totals: clients, skipped stops, visit time, travel time, and kilometres
  • Click a numbered stop in the list to zoom the map to it
  • Export the visits and tracking points to Excel
  • Review the history of earlier lookups (when permitted)
  • View the AlayaCare employee tracking endpoint settings (when permitted)
  • Configure pin colours, route options, and filters in the page settings (when permitted)

Typical Workflow

  1. Confirm the Branch (top right) and select an Employee. Choose the Service Date (defaults to today).
  2. Click Show Map. A processing panel shows progress; you can cancel it.
  3. Review the map and the lists beside it. Expand the employee row to see each visit, with its clock-in and clock-out details.
  4. Click a numbered stop to zoom the map to it.
  5. Click Export for an Excel copy, then Clear Map to look up another employee or date.

Report Output

Export creates an Excel workbook (.xlsx) named emplocate_ followed by the employee's name and the date and time. It downloads automatically. The workbook has two sheets:

  • Visits: one row per stop on the route, including the employee's start and end at home when those options are on. Columns are Waypoint, Start, Visit Time, Client, Address Source, Address, Lat, Lon, ClockIn Time, ClockIn Lat, ClockIn Lon, ClockIn Distance From Address, ClockOut Time, ClockOut Lat, ClockOut Lon, and ClockOut Distance From Address. Distances are in metres.
  • Coordinates: one row per GPS tracking point. Columns are Waypoint, Time, Coordinates(Lat,Lon), GPS Error Margin, and Distance From Prior Included Location.

Report Contents

ContentHow it is determined
WaypointThe stop's number on the map. Stops without a usable location have no number.
StartVisit start time (24-hour) in the employee's time zone.
Visit TimeScheduled length of the visit in minutes.
ClientClient name (last name, first name) from AlayaCare, or the facility name for facility visits.
Address Source / AddressThe address used to place the visit, labelled with where it came from (for example the client or a facility). A facility's saved location is used when the visit is at a facility that has one.
ClockIn / ClockOut Time, Lat, LonTime and location reported when the employee clocked in and out of the visit's first work session.
ClockIn / ClockOut Distance From AddressStraight-line distance in metres between the clock location and the visit address.
GPS Error MarginAccuracy in metres reported with the tracking point.
Distance From Prior Included LocationStraight-line distance in metres from the previous tracking point that was kept.

Configurable Settings

Open View Settings or Edit Settings from this screen (when permitted) to change these options. Settings cannot be opened while a map is showing.

GroupSettingTypePurpose
RouteStart with the employee home address?Yes/NoAdds the employee's home as the first stop of the route.
RouteEnd with the employee home address?Yes/NoAdds the employee's home as the last stop of the route.
RouteTracking Pin ColourColourColour of the GPS tracking points.
RouteClock In Pin ColourColourColour of clock-in pins.
RouteHide Clock In Pins?Yes/NoHides clock-in pins.
RouteClock In Pin Color out of GEO FenceColourColour of a clock-in pin that is further from the visit address than the maximum distance.
RouteShow Clock In Pin in different color if out of GEO Fence?Yes/NoUses the out-of-fence colour for clock-in pins that are too far.
RouteClock Out Pin ColourColourColour of clock-out pins.
RouteHide Clock Out Pins?Yes/NoHides clock-out pins.
RouteClock Out Pin Color out of GEO FenceColourColour of a clock-out pin that is further from the visit address than the maximum distance.
RouteShow Clock Out Pin in different color if out of GEO Fence?Yes/NoUses the out-of-fence colour for clock-out pins that are too far.
RouteMax Distance in meters for Clock In/OutText (number)Distance in metres beyond which a clock event counts as outside the geo-fence. 0 or blank turns the check off.
RouteShow Map Location With A Reported GPS Error Margin Less Than Or Equal To (m)DropdownTracking points with a larger reported error margin are not shown. Choices: 10, 25, 50, 150, All. Defaults to 150.
RouteShow Locations With A Distance From The Previous Location Greater Than Or Equal To (m)DropdownTracking points closer than this to the previous shown point are not shown. Choices: 50, 100, 200, 500, All. Defaults to 100.

The group heading Route is shown in the dialog; the setting labels above are taken from the earlier documentation because the labels are stored in a configuration table.

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

AttributeWhat It Controls
ViewOpen the page
All BranchesChoose any branch in the Branch selector. Without it, the selector is limited to your own branch.
Settings ViewOpen View Settings to see the page configuration
Settings EditOpen Edit Settings and change the page configuration
Endpoint Configuration ViewShow View Endpoint to see the AlayaCare tracking settings
Endpoint Configuration EditAlso shows View Endpoint; the settings are view-only on this screen
HistoryShow Show History to open the locate history

Actions

ButtonDescription
Show MapPlots the selected employee's visits, clock events, and GPS tracking points for the service date. A warning asks for a Service Date or an Employee if missing.
Clear MapClears the map and returns to the lookup fields. Shown while a map is displayed.
ExportExports the visits and tracking points to Excel. Shown while a map is displayed.
View SettingsOpens the page settings in read-only mode (when settings view is permitted).
Edit SettingsOpens the page settings for editing (when settings edit is permitted).
View EndpointOpens the Endpoint Configuration dialog (when permitted).
Show HistoryOpens the Locate History dialog (when permitted).
Information buttonShown beside the title when help documentation is available for the page; opens it.

The Branch, Employee, Service Date, settings, endpoint, and history controls are disabled while a map is displayed.

Dialog Components

Map Results

Shown after Show Map. The left side lists the results and the right side shows the map, with the splitter between them adjustable.

Employee grid

ColumnDescription
Employee NameThe employee, with a dot in the route's colour.
ClientsNumber of visits on the route.
SkippedNumber of stops that could not be placed on the map because they have no usable location.
Visit Time ColumnTotal scheduled visit time.
Travel Time ColumnDriving time of the route as calculated by the mapping service.
KMDriving distance of the route in kilometres.

Expand the employee row to see the visits.

Visit columnDescription
(stop)The stop's number (click it to zoom the map) and a status bar coloured by the visit's state, such as scheduled, clocked in, completed, approved, late, missed, cancelled, or vacant.
StartVisit start time.
Visit TimeScheduled length in minutes.
ClientClient name, the address with its source, the coordinates, the clock-in time and location with In Distance From Address, and the clock-out time and location with Out Distance From Address (in metres).

Tracking points grid

Shown below the employee grid when GPS tracking points exist for the day.

ColumnDescription
(stop)The point's number on the map.
TimeWhen the point was recorded.
Coordinates (Lat, Lon)Latitude and longitude.
GPS Error MarginReported accuracy in metres.
Distance From Prior Included LocationDistance in metres from the previous point that was kept.

Locate History

Opens from Show History (when permitted). It lists earlier lookups made on this page.

Field / ButtonPurpose
EmployeeOptional. Limit the history to one employee. Leave blank for all employees.
RefreshLoads the history.
CloseCloses the dialog.
ColumnDescription
IDHistory number (numbered within the year).
EmployeeEmployee that was looked up (last name, first name).
DateThe service date that was looked up.
AddedWhen the lookup was made.
Added ByUser who made the lookup.

Endpoint Configuration

Opens from View Endpoint (when permitted). It shows the employee-tracking settings held in AlayaCare for the mobile app. On this screen they are read-only.

FieldDescription
Accuracy MetersAccuracy threshold for recorded locations.
Polling FrequencyHow often the app records a location.
Rollup Value MetersDistance rollup value.
Static Location Timeout MinutesTimeout for a location that has not moved.
Upload FrequencyHow often the app uploads locations.

Click Close to leave the dialog.

Dependencies

The following tables must be configured for lookups on this view to work:

TableDescription
BranchesBranch selector and the employee's branch.
FacilitiesSaved location of the facility for visits held at a facility.
Service CodesService codes marked to be excluded from employee routing and mapping are left off the route.

Processing Overviews

This section describes what happens after you confirm a processing action.

Show Map

  1. The system checks that a service date and an employee are selected and that AlayaCare can be reached.
  2. The employee's profile is loaded. The employee must have a geocoded home address, otherwise a warning names the employee and nothing is shown. The employee's own time zone is used for the day.
  3. The employee's visits for the day (midnight to 11:59:59 PM) are loaded from AlayaCare. Visits on hold are left out. If the employee has no visits, the route is skipped.
  4. For each visit, its details and the service details are loaded. Visits whose service code is excluded from employee routing are left out. Client details are loaded for client visits. The visit's address is taken (a facility's saved location is used for facility visits when available). A visit with no usable address is skipped with a message.
  5. The route is built. When configured, the employee's home is added as the first and/or last stop. Stops with an address are numbered; stops without one are counted as Skipped.
  6. For each visit the first work session is loaded to get the clock-in and clock-out times and locations. If visit verification features are enabled in AlayaCare, the visit's verification is also retrieved. Clock-in and clock-out pins are added unless hidden. When the distance check is on and a clock event is further from the visit address than the maximum distance, the out-of-fence colour is used.
  7. The employee's GPS tracking points for the day are loaded from AlayaCare. Points with a larger error margin than allowed are hidden, and points that are not far enough from the previous shown point are hidden. The last point is always shown.
  8. The mapping service draws the route and returns the distance and travel time, which fill the employee grid.
  9. A locate history entry is saved for this lookup. If nothing was found (no visits), the message No scheduled visits or tracking coordinates were found is shown instead of a map.