ACI Documentation

Bulk Update Visits

Executive Summary

Bulk Update Visits lets coordinators apply the same change to many AlayaCare visits in one controlled batch. A coordinator starts a session for a branch, a purpose (delete visits or place visits on hold) and a date and time range, then selects the visits to include by client, employee, facility, department, service and status. Once the selection looks right, one action deletes the visits from AlayaCare or places them on hold. Each session keeps its own record of the visits chosen, how they were chosen, and whether each visit passed or failed, and the session results can be exported to Excel.

Key Features

  • Start a session for a branch, a purpose, and a visit date and time range
  • Select visits in several rounds, using any mix of client, employee, facility type and facilities, departments, service type and service codes, visit schedule status and approval status
  • Review the visits in the batch and the history of every selection that was made
  • Remove a visit from the batch before processing starts
  • Delete the visits from AlayaCare, or place them on hold with a status reason (when permitted)
  • Locked visits are never changed
  • Review how many visits passed and failed, and the message for each failure
  • Filter past sessions by branch and export a session to Excel

Typical Workflow

  1. Click Start A New Session, choose a Purpose, enter the Start Date and Time and End Date and Time, and click Save, then confirm the range.
  2. On the session page, click Select Visits, choose the criteria, and click Save. Repeat to add more visits.
  3. Review the Visits tab and click the delete icon on any visit that should not be changed.
  4. Click Delete Selected Visits From Alayacare or Place Selected Visits On Hold In Alayacare and confirm.
  5. Check the counts and each visit's Processing Status and Last Action Message.
  6. Back on the main list, select the session and click Export Selected to keep a copy of the results.

Available Permissions

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

AttributeWhat It Controls
ViewOpen the page, see sessions, and start new sessions
All BranchesSee sessions for all branches, and choose All Branches in the filter
DeleteOffer the Delete Visits purpose and show Delete Selected Visits From Alayacare
HoldOffer the Hold Visits purpose and show Place Selected Visits On Hold In Alayacare

A role with neither Delete nor Hold cannot start a session, because Purpose has no choices to pick from.

Main Grid

The grid lists the bulk-update sessions, newest first (14 rows per page). Times are shown in your time zone.

ColumnDescription
IDSession number.
BranchBranch the session belongs to.
PurposeDelete Visits or Hold Visits.
AddedWhen the session was started.
Added ByUser who started the session.
From Date/TimeStart of the visit window.
To Date/TimeEnd of the visit window.
Visits SelectedNumber of visits in the batch.
Update FailedNumber of visits that could not be updated.
Update PassedNumber of visits that were updated.
StatusProcessing status of the session, for example Deleting, Hold, or Finished. Blank until processing starts.
CancelledWhen the session was cancelled, if it was.
Processing StartWhen processing began.
Processing EndWhen processing finished.
DurationElapsed processing time.
Manage RecordsEdit icon that opens the session.

Main Grid Filters

FilterPurpose
BranchShows only the sessions for the chosen branch. With the All Branches permission, All Branches can also be chosen. Without it, the filter is fixed to your own branch.

Click Apply to refresh the list. Use Clear to reset the filter to your own branch.

Actions

ButtonDescription
Start A New SessionOpens the Bulk Update Visits dialog.
Export SelectedExports the selected session to an Excel file. Exactly one session must be selected; otherwise nothing happens.
ApplyRefreshes the list for the chosen branch.
ClearResets the branch filter and refreshes the list.
Edit (row icon, or right-click a row)Opens the session page.

Dialog Components

Bulk Update Visits

Opens from Start A New Session. Click Save to create the session, or Cancel to close.

FieldPurpose
BranchBranch of the session. Fixed to your branch unless you have the All Branches permission.
PurposeDelete Visits (needs the Delete permission) or Hold Visits (needs the Hold permission). Required.
Start Date and TimeStart of the window for the visits to be selected. Required.
End Date and TimeEnd of the window. Required. If it falls on the same day as the start and is set to 12:00 AM, it becomes 11:59 PM.

Warnings: "Please select a valid date range", "End Date cannot be prior to Start Date" and "Purpose is required". Before saving, you are asked to confirm "You have selected from {start} to {end}. Is this range correct?". After saving, the session page opens.

Session Page

Opens from Edit, or straight after a session is saved. The header shows Purpose, From Date/Time, To Date/Time, Visits Selected, Update Failed and Visits Updated. Until processing starts, the page also shows the action button that matches the purpose. Once processing has started, the session can no longer be changed: the action button, Select Visits and the delete icons are removed.

ButtonDescription
Delete Selected Visits From AlayacareShown for the Delete Visits purpose with the Delete permission. Asks "You are about to delete these visits. This process cannot be undone. Are you sure you want to delete the selected visits?".
Place Selected Visits On Hold In AlayacareShown for the Hold Visits purpose with the Hold permission. Opens Visits on Hold.

If the batch is empty, the warning "No visits to delete" or "No visits to hold" is shown.

Tabs

TabPurpose
VisitsThe visits in the batch and their results.
Selection HistoryThe criteria used each time visits were selected.
Visits — Grid

Lists the visits in the batch (14 rows per page).

ColumnDescription
Visit IDAlayaCare visit number.
ClientClient on the visit.
EmployeeEmployee on the visit.
FacilityFacility on the visit.
Service CodeService code on the visit.
LockedTicked when the visit is locked. Locked visits are skipped.
Start Date/TimeVisit start, in your time zone.
End Date/TimeVisit end, in your time zone.
Approval StatusApproved or Not Approved.
Visit StatusScheduled or Vacant.
Processing StatusDeleted, Hold or Failed after processing. Blank before.
Last Action MessageThe reason an update failed.
Manage RecordsDelete icon that removes the visit from the batch. Shown only before processing.
Visits — Grid Actions
ButtonDescription
Select VisitsOpens Select Visits. Shown only before processing.
Delete (row icon, or right-click a row)Removes the visit from the batch after you confirm "Are you sure you want to remove this visit from the selection?". This does not touch AlayaCare. Not available once processing has started.
Selection History — Grid

One row for each time Select Visits was saved.

ColumnDescription
Client NameClient chosen, if any.
Client UIDAlayaCare client ID.
DepartmentsDepartments chosen.
Employee NameEmployee chosen, if any.
Employee UIDAlayaCare employee ID.
Facility TypeFacility type chosen.
FacilitiesFacilities chosen.
Service TypeService type chosen.
Service CodesService codes chosen.
Visit StatusVisit schedule status chosen.
Approval StatusApproval status chosen.

Select Visits

Opens from Select Visits. Leave a field blank to include everything for it. Facilities and clients and employees offered are those of the session's branch.

FieldPurpose
Client (leave blank for All)One client.
Employee (leave blank for all)One employee.
Facility TypeNarrows the Facilities list to that type.
Facilities (leave blank for All)Facilities to include.
Departments (leave blank for All)Departments to include.
Service TypeNarrows the Service Codes list to that type, and limits the visits to services of that type.
Service Codes (leave blank for All)Service codes to include.
Visit Schedule StatusAll, Vacant or Scheduled. Required; starts as All.
Approval StatusAll, Not Approved or Approved. Required; starts as All.

Click Save to add the matching visits, or Cancel to close. Warnings: "Please select a valid Schedule Status" and "Please select a valid Approval Status". You are asked to confirm: "Are you sure you want to apply these selections?", or, when nothing is narrowed, "You have chosen to select all visits for the date range. Are you sure?".

Visits on Hold

Opens from Place Selected Visits On Hold In Alayacare. Choose the Status Reason (reasons come from AlayaCare) and click Save to place the visits on hold, or Cancel to close.

Dependencies

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

TableDescription
BranchesBranches offered in the filter and when starting a session.
DepartmentsDepartments offered in Select Visits.
FacilitiesFacility types and facilities offered in Select Visits, and facility names on the visits.
Service CodesService types and service codes offered in Select Visits.

Processing Overviews

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

Start A New Session

  1. Saves the session with its branch, purpose, and visit date and time range, and records it in the action log.
  2. Opens the session page. No visits are loaded until you use Select Visits.

Select Visits

  1. Saves the criteria as a new line in Selection History.
  2. Loads the visits in the session's date and time range from AlayaCare, using any client, employee and department choices.
  3. Skips cancelled visits, then applies the Visit Schedule Status (vacant or scheduled) and Approval Status choices.
  4. For each remaining visit not already in the batch, loads its details and keeps it only if it belongs to the session's branch and matches any facilities, service codes and service type chosen. Whether the visit is locked is read from its accounting details.
  5. Adds the matching visits to the batch and increases Visits Selected.

Delete Selected Visits From Alayacare

  1. Marks the session as started with the status Deleting.
  2. For each visit that is not locked, deletes the visit in AlayaCare. A visit that is deleted is marked Deleted; one that fails is marked Failed with the reason in Last Action Message.
  3. Saves the end time, duration, and the Update Passed and Update Failed counts, and sets the status to Finished. Locked visits are left unchanged and unmarked.

Place Selected Visits On Hold In Alayacare

  1. Marks the session as started with the status Hold.
  2. For each visit that is not locked, obtains AlayaCare's security token and places the visit on hold with the chosen status reason. A visit placed on hold is marked Hold; one that fails is marked Failed with the message "Hold Failed" (or "Hold Failed - CSFR" when the security token could not be obtained).
  3. Saves the end time, duration, and the passed and failed counts, and sets the status to Finished.

Export Selected

  1. Builds an Excel file named with the session ID and the current date and time.
  2. The Home sheet holds the session summary: ID, purpose, date range, who added it and when, counts, and processing times.
  3. The Selected Visits sheet lists each visit with its client, employee, facility, service code, times, approval and visit status, processing status, and last action message.
  4. The Selections sheet lists each selection that was made, with departments, facilities and service codes shown by name.
  5. Downloads the file and shows "Exported Successfully".