ACI Documentation

Facility Route Mapping

Executive Summary

Facility Route Mapping shows on a map the clients that a facility's route visits on a chosen day. A coordinator picks a service date, a facility type and one or more facilities (each facility represents a route), and clicks Show Map. The system reads the day's visits for each facility from AlayaCare, places each client at the visit address, and draws a coloured route per facility with numbered waypoints. A side grid summarises every route and can be expanded to list the stops in order. From the grid a coordinator can also change the start time of individual stops; those changes are written back to the visits in AlayaCare.

Key Features

  • Map one or more facility routes for a service date, one colour per route
  • Optionally show a chosen client's home location on the map
  • Show the route's starting and ending location (depot) as the first and last stops when they are set up for the facility
  • See per route: clients, skipped clients (no map location), mapped clients, total visit time, travel time and distance in KM
  • Expand a route to list each stop with start time, visit time, client and address
  • Change the start time of stops in a route and update the matching visits in AlayaCare
  • Print the map

Typical Workflow

  1. Choose a Service Date. Optionally choose a Client to show that client's home on the map.
  2. Choose a Facility Type (it is pre-selected when only one type exists), then choose one or more Facilities.
  3. Click Show Map. A progress panel lists the routes and visits as they are processed and can be cancelled.
  4. Review the routes on the map and the grid. Expand a route to see its stops.
  5. To change start times, click the edit icon on a route (or right-click it and choose Edit). Edit the stops' start times, then click Ok to update the visits in AlayaCare.
  6. Click Print Map to print the map, or Clear Map to start again.

Available Permissions

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

AttributeWhat It Controls
ViewOpen the page, including changing visit start times

Main Grid

The route grid appears beside the map after Show Map. It lists one row per facility route.

ColumnDescription
Route NameThe facility, with the route's colour.
ClientsNumber of stops (client visits, grouped as described under Processing Overviews).
SkippedStops that could not be placed on the map because they have no location.
Visit TimeTotal scheduled visit time in minutes.
Travel TimeDriving time of the route in minutes.
KMDriving distance of the route.
MappedStops placed on the map.
Manage RecordsAn edit icon that opens the route for editing start times.

Expand a route to list its stops.

ColumnDescription
(numbered dot)The waypoint number on the map. Blank when the stop has no location.
StartStart time of the stop.
Visit TimeStart and end time of the stop.
ClientClient name and address. A depot stop shows the starting or ending location name and address.

Main Grid Filters

These selections decide what is mapped and are locked while a map is displayed.

FilterPurpose
Service DateThe day whose visits are mapped. Changing it refreshes the facility list to facilities in use on that date and clears the facility selection.
ClientOptional. Shows the client's home location as a marker on the map.
Facility TypeThe type of facility. Choosing it loads the facilities of that type.
FacilitiesThe facilities (routes) to map. Appears once a facility type is chosen. Use Select All to choose every facility listed.

Actions

ButtonDescription
Show MapBuilds the routes and shows the map. Replaced by Clear Map and Print Map once a map is showing.
Clear MapClears the map and re-enables the selections.
Print MapPrints the map.
Edit (icon on a route row, or right-click a route row)Opens the route's start times for editing.

Dialog Components

Route (edit start times)

Opens from the edit icon or right-click Edit on a route. The title is the route (facility) name. It lists the client stops of the route (the starting and ending depot stops are not editable) and lets the start time of each be changed.

Grid

ColumnDescription
ClientClient name.
Start TimeCurrent start time of the stop.
New Start TimeThe new start time entered for the stop, when one has been entered.
Manage RecordsAn edit icon (also right-click Edit) that opens Edit Start Time.

The grid has 14 rows per page.

Grid Actions

ButtonDescription
OkSaves the new start times: updates every visit at the changed stops in AlayaCare, redraws the map and shows how many visits were updated or failed.
CancelCloses the dialog. New start times already entered stay on the stops, but no visits are changed.

Edit Start Time

Opens from a stop in the route dialog.

FieldPurpose
Current Start TimeThe stop's current start time (read-only).
New Start TimeThe new start time (hours and minutes), in the facility's time zone.

Click Ok to keep the new time on the stop (it is not sent to AlayaCare until Ok is clicked on the route dialog), or Cancel to discard it.

Dependencies

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

TableDescription
FacilitiesFacility types, the facilities offered for the date, each facility's time zone, route colour, and its optional starting and ending location (name, address, coordinates, starting time and depot visit time).

Processing Overviews

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

Show Map

  1. Opens a progress panel that can be cancelled, signs in to AlayaCare and records the request in the activity log.
  2. If a client was chosen, loads the client's record so the client's home location can be shown.
  3. For each selected facility, works out the start and end of the service day in the facility's time zone and loads the facility's visits for that day from AlayaCare, keeping only visits that have a client.
  4. Leaves out cancelled visits, visits on hold and visits without a client. For each remaining visit, loads the client, the service and the visit's details.
  5. Works out each visit's location: the service's own address when the service overrides the address, otherwise the client's home address.
  6. Groups visits for the same client, address and start time into one stop. Stops with a location count as Mapped; stops without a location count as Skipped.
  7. Orders the stops by start time. When the facility has a starting location, adds it as the first stop (at the facility's starting time, if set, with the depot visit time). When the facility has an ending location (or is set to end where it starts), adds it as the last stop, five minutes after the last visit starts. An ending location is only used when its longitude falls in the range used for the service area.
  8. Draws a route per facility, in the facility's route colour or in a colour from the standard sequence (red, orange, green, blue, indigo, violet). The map calculates the driving route, travel time and distance, which fill the grid. If a facility has no stops, "Route has no clients" is shown. If none of the routes have stops, "Routes do not have any clients" is shown.
  9. If no facility was selected, "Please select at least one route" is shown.

Ok (on the Route dialog)

  1. For every stop with a new start time, works out the new start (in the facility's time zone) and keeps the same visit length for the new end time.
  2. For each visit grouped at that stop, updates the visit's start and end time in AlayaCare, keeping its service and employee. The update is sent with every AlayaCare override switched on (overlapping visit, service instructions, reason code, locked visit, blocked employee, unavailable employee, blocked facility and authorization), so AlayaCare accepts the change even when those checks would normally stop it.
  3. Closes the dialog, redraws the map with the new times, and shows "{n} Visit(s) updated", or "{x} Visits failed, {n} Visit(s) updated" when AlayaCare rejects any.