ACI Documentation

Facility Clock In/Out

Executive Summary

Facility Clock In/Out lets facility staff record attendance for the clients booked at a facility on a given day. Staff choose a branch, a service date, and a facility, then load the visits scheduled there from AlayaCare. The visits are grouped by session time, and each client can be clocked in and clocked out, singly or in bulk, using either the scheduled visit time or the actual time. Staff with the right permissions can also add a client to a session, delete a client's visit, cancel a visit with a cancel code, and edit a visit's service instructions. Every change is made directly in AlayaCare, and the employee recorded on the visit is the signed-in user or an employee chosen on the screen, depending on the page settings.

Key Features

  • Load the visits for one facility and one service date, grouped into session time buttons
  • Work from three tabs: Clock In (clients not yet clocked in), Clock Out (clients currently clocked in), and All Clients (everyone for the session time)
  • Clock clients in or out one at a time, or clock in or out all selected clients at once
  • Choose whether the clock in or clock out time is the scheduled visit time or the actual time (unless the page settings fix this choice)
  • Stop a clock in when the employee already has an open session with the same client and service, and review the problems in a results list
  • Clock out an employee's conflicting open session directly from the results list
  • Add a client to the selected session time by choosing the client and one of the client's active services
  • Delete selected clients, and see which ones could not be deleted
  • Cancel clients with a cancel code (when permitted and when AlayaCare cancel reasons are set up)
  • View and edit the service instructions for a client, with or without clocking in or out at the same time
  • Optionally write an audit note on the visit in AlayaCare each time a client is clocked in or out
  • Limit the screen to today's date, the signed-in user as the employee, and a fixed time type through the page settings

Typical Workflow

  1. Confirm the Branch shown in the top right (users with the All Branches permission can change it).
  2. Choose the Service Date (when not fixed to today) and a facility, then click Apply. Visits are loaded from AlayaCare.
  3. Choose the Employee To Use For Clock In if the field is editable.
  4. Click a session time button under Session Times.
  5. On the Clock In tab, choose the time to use, tick the clients, and click Clock In Selected. Review the Results list if any client could not be clocked in.
  6. Later, on the Clock Out tab, choose the time to use, tick the clients, and click Clock Out Selected.
  7. Use Add Client, Delete Selected, Cancel Selected, or the notes icon as needed, then click Clear to start over with another facility or date.

Configurable Settings

Open View Settings or Edit Settings from this screen (when permitted) to change these options. The dialog is titled Facility Clock In/Out Settings.

GroupSettingTypePurpose
GeneralNumber Of RowsDropdownNumber of rows per page in the client grid. Defaults to 14 when blank.
GeneralUse Logged In EmployeeYes/NoWhen on, the signed-in user is the employee for every clock in and the employee box is read only. When off, an employee must be chosen on the screen.
GeneralWrite Audit Visit NoteYes/NoWhen on, a note naming the signed-in user and the time is added to the visit in AlayaCare after each successful clock in or clock out.
GeneralAllow Current Date OnlyYes/NoWhen on, the Service Date is fixed to today and cannot be changed.
GeneralInclude Service NameYes/NoWhen on, each session time button starts with the service name.
GeneralStart Time To UseDropdownFixes the time used for clock in and clock out: Visit Time or Actual. When blank, users choose the time on the Clock In and Clock Out tabs.
Update Visit OverridesOverlapping VisitsYes/NoAllow the visit to be updated even if it overlaps another visit.
Update Visit OverridesService InstructionsYes/NoAllow the update despite a service instructions rule in AlayaCare.
Update Visit OverridesReason CodeYes/NoAllow the update despite a reason code rule in AlayaCare.
Update Visit OverridesLocked VisitYes/NoAllow the update on a locked visit.
Update Visit OverridesBlocked EmployeeYes/NoAllow the update when the employee is blocked.
Update Visit OverridesUnavailable EmployeeYes/NoAllow the update when the employee is unavailable.
Update Visit OverridesBlocked FacilityYes/NoAllow the update when the facility is blocked.
Update Visit OverridesAuthorizationYes/NoAllow the update despite an authorization rule in AlayaCare.

The overrides are sent to AlayaCare when a client is clocked in (the employee is assigned to the visit first) and when a client is added.

Available Permissions

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

AttributeWhat It Controls
ViewOpen the page
Settings ViewOpen View Settings to see the page configuration
Settings EditOpen Edit Settings and change the page configuration
All BranchesChoose any branch in the Branch box. Without it, the page is limited to the user's own branch.
AddShow the Add Client button
DeleteShow Delete Selected and the delete icon in Manage Records
CancelShow Cancel Selected and the cancel icon in Manage Records. Also requires cancel reasons to be set up in the AlayaCare account.

Main Grid

The grid, tabs, and session time buttons appear only after you click Apply. The grid lists the clients booked for the selected session time (14 rows per page unless the Number Of Rows setting changes it), in client name order. Tick the checkbox on each row to select it.

The three tabs decide which clients are listed:

TabClients listedControls on the tab
Clock InClients not yet clocked in for the session time.Time to use for clock in, Clock In Selected, Delete Selected, Cancel Selected, Add Client (each as permitted).
Clock OutClients currently clocked in.Time to use for clock out, Clock Out Selected.
All ClientsEvery client for the session time, clocked in, clocked out, or neither.None. Rows can only be viewed, and the service instructions edited.
ColumnDescription
ClientClient name, last name first.
ServiceService code of the visit.
StatusClocked In, Clocked Out, or blank when the client has not been clocked in.
Service InstructionsService instructions saved on the visit.
Manage RecordsRow icons, described below.

Manage Records icons:

IconDescription
NotesOpens the service instructions dialog for the client.
ClockClocks the client in (on the Clock In tab) or out (on the Clock Out tab). Shown only when the client can be clocked in or out on that tab.
DeleteDeletes the client's visit. Shown only with the Delete permission, and only for clients not yet clocked in.
CancelCancels the client's visit. Shown only with the Cancel permission, on the Clock In tab.

Main Grid Filters

FilterPurpose
BranchBranch whose facilities are searched. Locked to the user's own branch without the All Branches permission. Disabled while a filter is applied.
Service DateDay whose visits are loaded. Fixed to today when Allow Current Date Only is on. Disabled while a filter is applied.
FacilityFacility to load. Type to search. Required: "Please select a facility" is shown otherwise. Disabled while a filter is applied.
Employee To Use For Clock InEmployee recorded on the visit and on the clock in. A search box when Use Logged In Employee is off. When it is on, the signed-in user's name is shown and cannot be changed.
Session TimesOne button per distinct visit time at the facility on that date. The selected button decides which clients the grid lists.
Time to use for clock in / Time to use for clock outVisit Start Time or Actual Time for clock in. Visit End Time or Actual Time for clock out. Cannot be changed when Start Time To Use is set.

Click Apply to load the visits. Use Clear to reset the filters, remove the loaded clients, and choose again.

Actions

ButtonDescription
View Settings / Edit SettingsOpens the settings dialog. Shown only with the Settings View or Settings Edit permission.
ApplyLoads the visits for the facility and date.
ClearClears the loaded visits and re-enables the filters.
Clock In SelectedClocks in the selected clients (Clock In tab). Disabled until at least one client is ticked.
Clock Out SelectedClocks out the selected clients (Clock Out tab). Disabled until at least one client is ticked.
Delete SelectedDeletes the selected clients' visits (Clock In tab). Shown only with the Delete permission.
Cancel SelectedCancels the selected clients' visits (Clock In tab). Shown only with the Cancel permission and when AlayaCare cancel reasons exist.
Add ClientOpens the dialog to add a client to the session time (Clock In tab). Shown only with the Add permission.
Clock In/Out, Delete, Cancel (right-click a row)Acts on the row that was right-clicked. The first item reads Clock In on the Clock In tab and Clock Out on the Clock Out tab, and each item appears only when it applies to that client.
Clock In/Out Selected, Delete Selected, Cancel Selected (right-click a row)Acts on all ticked rows. The first item reads Clock In Selected or Clock Out Selected by tab. There is no right-click menu on the All Clients tab.

Dialog Components

Add Client

Opens from Add Client. Before it opens, an employee must be selected ("Please select an employee") and a facility must be chosen ("Please select a Facility").

FieldPurpose
ClientClient to add. Type to search; suggestions come from AlayaCare.
ServiceOne of the client's active services in AlayaCare. Required: "Please select a service" is shown otherwise.

Click Ok to add the client to the selected session time, or Cancel to close. If the client is already listed for the session time with the same service, "Client already exists with this service" is shown. On success the client appears in the grid and "Client successfully added" is shown; otherwise "Error adding client" is shown.

Service Instructions

Opens from the notes icon in Manage Records. A Service Instructions box holds the instructions saved on the visit. The title and buttons depend on the tab.

TabTitleButtons
Clock InClock In With Service InstructionsClock In, Save, Cancel
Clock OutClock Out With Service InstructionsClock Out, Save, Cancel
All ClientsEdit Service InstructionsSave, Cancel

Save saves the instructions only. Clock In or Clock Out saves any change to the instructions and then clocks the client in or out. If AlayaCare rejects the update, "Visit Update Failed in Alayacare" is shown and nothing else happens.

Cancel Code

Opens after you confirm a cancel ("Are you sure you want to cancel this client?" for one client, or "Are you sure you want to cancel the selected clients?"). Choose a code in Select A Cancel Code and click Ok. The codes offered are those set up for this screen. A cancelled client is removed from the grid. A client who has already been clocked in or out cannot be cancelled ("Client cannot be cancelled").

Results

Opens after Clock In Selected when any client could not be clocked in. Close it to refresh the grid.

ColumnDescription
Conflict Visit IdAlayaCare visit where the employee already has an open session, for a conflict.
Date/TimeStart of that conflicting visit, in your time zone.
NameClient the clock in was for.
EmployeeEmployee on the visit.
ServiceService code of the visit.
SuccessWhether the client was clocked in. Only failures are listed.
Error TypeConflict (the employee already has an open session with the same client and service), UpdateEmployee (the employee could not be assigned to the visit), Create (the clock in was refused), or Exception (an unexpected error).
Error MessageDescription of the problem.
Manage RecordsClock icon, shown for a conflict whose open session can still be clocked out.

Click the clock icon (or right-click the row and choose Clock Out) and confirm "Are you sure you want to clock out this session?" to clock out the employee's open session on the other visit. The row is removed when this succeeds.

Clients Not Deleted

Opens after Delete Selected when some visits could not be deleted. It lists Name, Service, Status, and Service Instructions for each, with a Close button.

Dependencies

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

TableDescription
BranchesBranches offered in the Branch box.
Cancel CodesCancel codes offered in the Cancel Code dialog, set up for this screen.
FacilitiesFacility time zone, used to work out the day's start and end and the visit time when clocking in or out.

Processing Overviews

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

Apply

  1. Requires a facility. Locks the filters and shows a progress panel.
  2. Works out the start and end of the chosen date in the facility's time zone.
  3. Loads the facility's visits from AlayaCare for that day, leaving out cancelled visits and non-visit calendar entries.
  4. For each visit, loads the visit detail for its service instructions and its work sessions. A client with an open session is treated as clocked in, and one with only closed sessions is treated as clocked out.
  5. Builds the session time buttons from the distinct visit times, selects the first one, and shows the grid. If no clients are found, "No Clients found for facility" is shown.

Clock In Selected

  1. Requires an employee and at least one ticked client. A progress panel with a message list is shown.
  2. For each client, works out the clock in time: the visit start time, or the current time to the minute.
  3. Checks AlayaCare for an open session for the employee with the same client and service. If one exists, the client is listed in Results as a Conflict and skipped.
  4. Assigns the employee to the visit, sending the update overrides from the settings. If this fails, the client is listed as UpdateEmployee.
  5. Clocks the client in. If this is refused, the client is listed as Create.
  6. When Visit Start Time is chosen, edits the new session so its start time matches the visit start time.
  7. When Write Audit Visit Note is on, adds a note to the visit naming the signed-in user.
  8. Shows Results if any client failed; otherwise refreshes the grid.

Clock Out Selected

  1. Shows a progress panel with a message list.
  2. For each client, works out the clock out time: the visit end time, or the current time to the minute.
  3. Clocks out the client's open session in AlayaCare and marks the client Clocked Out. A failure adds a message to the list.
  4. When Write Audit Visit Note is on, adds a note to the visit naming the signed-in user.
  5. Shows "Clients Clocked Out", or "One or multiple errors clocking out" if any failed, and refreshes the grid.

Clock In / Clock Out (one client)

Follows the same steps as the selected versions for a single client. Problems are shown as messages instead of in Results: "Please select an employee" when none is chosen, a warning when the employee already has an open session with that client, and the AlayaCare message when the employee cannot be assigned. The result is "Client Clocked In" or "Client Clocked Out" on success, and "Client Clock In Failed" or "Error Clocking Out" otherwise.

Delete Selected

  1. Asks "Are you sure you want to delete the selected clients?". One client asks "Are you sure you want to delete this client?".
  2. For each ticked client, deletes the visit in AlayaCare. Only clients not yet clocked in can be deleted.
  3. Removes deleted clients from the grid. Failures are listed in Clients Not Deleted.
  4. Shows "Clients deleted", or "One or more clients could not be deleted".

Cancel Selected

  1. Asks for confirmation, then for a cancel code.
  2. For each ticked client, cancels the visit in AlayaCare with the chosen code and removes the client from the grid.
  3. Shows "Clients cancelled", or "one or more errors canceling clients".