ACI Documentation

Facilities

Executive Summary

Facilities is the setup screen for the facilities (programs, clinics, chairs, routes and similar locations) that ACIntegrations uses alongside AlayaCare. Administrators use it to bring facilities and their groups in from AlayaCare, then complete the information AlayaCare does not hold: the integration type, the master/child (clinic and chair) relationships, route colours and starting/ending locations, scheduled sessions and activities, availability and unavailability, closure groups, service codes and FSM utilization settings. The list can be filtered, exported to Excel, and an Availability Details workbook can be produced for selected master facilities and a date range.

Key Features

  • Refresh all facilities and their groups from AlayaCare, or refresh a single facility chosen by branch
  • In Staging and UAT environments only, after refreshing all facilities, list facilities that are no longer in AlayaCare and optionally delete them with their related records
  • Filter the list by description and by integration type, and choose how many rows to show per page
  • Export the displayed list to Excel
  • Export an Availability Details workbook (available, unavailable and net available hours) for selected master facilities over a date range, with optional daily values
  • Open a facility (Edit button or right-click) to see its details across tabs: General, Groups, Sessions, Activities, child facilities (chairs), Closure Groups, Availability, Service Codes and FSM Settings
  • Edit the facility's integration type, default note type, short name, child sequence, route colour, weekday restrictions, starting and ending locations (with geocoding), and AIS details
  • Add and edit recurring sessions and activities, and add or remove service codes and closure groups
  • Bulk-add chairs (creating them in AlayaCare) or link existing facilities to a master facility
  • Add availability and unavailability, including single-day unavailability
  • Set the FSM target percentage and the utilization colour ranges

Typical Workflow

  1. Click Refresh All From AlayaCare (or Refresh Single Facility From AlayaCare) to bring the latest facilities, addresses and groups from AlayaCare.
  2. Use Filter Description and Filter Integration Type, then Apply Filter, to find the facility.
  3. Click the edit icon on the row (or right-click the row and choose Edit) to open Facility Details.
  4. On the General tab, click Edit to set the integration type, short name, route colour, starting/ending locations and AIS details, then Save.
  5. Use the other tabs to maintain sessions, activities, chairs, closure groups, availability, service codes and FSM settings as they apply to the facility.
  6. Click Close when finished. The list refreshes if anything that affects it was changed.
  7. Use Export for the on-screen list, or Availability Details for the availability workbook.

Available Permissions

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

AttributeWhat It Controls
ViewOpen the page and use all of its functions, including refreshing from AlayaCare and editing facilities

Main Grid

The grid lists every facility known to ACIntegrations that matches the filters. The first three columns stay in place while you scroll sideways. The default page size is 14 rows.

ColumnDescription
AC IDAlayaCare facility ID.
NameFacility name from AlayaCare. Can be filtered with a contains search from the column header.
TimezoneFacility time zone from AlayaCare. Can be filtered.
BranchAlayaCare branch ID of the facility.
Integration TypeThe integration type assigned to the facility on the General tab.
MasterChecked when the facility is a master facility (one that has child facilities such as chairs).
Child LabelThe label used for a master facility's children (for example the name for its chairs).
AlayaCare AddressAddress lines, city, state/province and postal/zip code from AlayaCare.
AlayaCare PhoneMain and other phone numbers from AlayaCare.
ColorRoute colour dot, when a colour has been set.
Route Starting LocationFile-as name and address of the starting location, when Use Starting Location is on.
Route Ending LocationEnding location, or "same as Starting Location", when Use Ending Location is on.
Manage RecordsEdit icon that opens Facility Details.

Main Grid Filters

FilterPurpose
Filter DescriptionShows only facilities whose name contains the text entered (not case-sensitive).
Filter Integration TypeMulti-select list of integration types (with Select All). Shows only facilities of the ticked types.
Items Per PageNumber of rows per page: 5, 14, 25, 50 or 100.

Click Apply Filter to refresh the list. Use Clear Filter to reset the filters and reload the list from the database.

Actions

ButtonDescription
Refresh All From AlayaCareRefreshes groups and all facilities from every AlayaCare branch. When there are more than 100 facilities you are asked to confirm first ("Are you sure you want to refresh all facilities?"). In Staging and UAT environments it then also checks for facilities that are no longer in AlayaCare. See Processing Overviews.
Refresh Single Facility From AlayaCareOpens the Refresh Single Facility From Alayacare dialog.
ExportExports the facilities currently in the list (after filters) to an Excel file named facilities_ followed by the local date and time. Columns: AC Id, Name, Integration Type, Color, Starting Location, Use For Mapping (YES when the starting location is in use). A warning is shown when there is nothing to export.
Availability DetailsOpens the Availability Details Export dialog.
Apply FilterApplies the description and integration type filters.
Clear FilterClears the filters.
Edit (right-click a row)Opens Facility Details for the row.

The buttons other than Refresh All From AlayaCare and Refresh Single Facility From AlayaCare are disabled while the list is loading.

Dialog Components

Refresh Single Facility From Alayacare

Opens from Refresh Single Facility From AlayaCare. Choose a branch with Select A Branch (it is pre-selected when AlayaCare has only one branch), then search for a facility in Search For Facility In AlayaCare. Choosing a branch switches AlayaCare to that branch and clears any facility already chosen. Click Refresh to bring that facility in (a warning appears if no facility was selected) or Cancel to close. Either way, the previously active AlayaCare branch is restored afterwards, and after Refresh the list is reloaded.

Facilities Not In AlayaCare

Opens automatically at the end of Refresh All From AlayaCare, in Staging and UAT environments only, when facilities stored here were not returned by AlayaCare. It is never shown in other environments. The dialog explains that these facilities are in the local database but were not in the facility list AlayaCare returned, and lists each one by AC ID and Name. When some branches could not be loaded, a note says that only facilities on the branches that were loaded are listed.

ButtonDescription
Delete Invalid RecordsAfter confirmation ("Delete these facilities, their child facilities, and related groups, sessions, activities, availability, closure groups, and service codes?"), deletes every listed facility, its child facilities, and its related groups, sessions, activities, availability, closure groups and service codes. The list is then reloaded and "Invalid facility records were deleted." is shown. If the deletion fails, an error message is shown.
CloseCloses the dialog without deleting anything.

Both buttons are disabled while a deletion is running.

Availability Details Export

Opens from Availability Details. It produces an Excel workbook of availability hours for the master facilities you choose.

FieldPurpose
Parent Facility TypeRequired. Lists the integration types that are master types. Choosing one limits the Locations list to master facilities of that type.
LocationsRequired. Multi-select (with Select All, grouped by state/province) of master facilities.
From Date / To DateRequired. Default to the Monday to Sunday of the current week. The To date cannot be before the From date.
Show Daily ValuesWhen ticked, the workbook shows Available, Unavailable and Net Available hours for each day plus period totals; otherwise only for the whole period.

Click OK to build the workbook, or Cancel. Warnings appear for any missing required value. The file is downloaded automatically as FacilityAvailabilityDetails_ followed by the local date and time. It contains a Criteria sheet (the selections, Exported At) and one sheet per selected master facility. Each facility sheet lists the availability and unavailability records that apply during the period, with the columns Facility Type, Facility Name, Description, Type, Frequency, Interval, Start Date, End Date, Start Time, End Time, Mon to Sun, Allow Visits, followed by Available, Unavailable and Net Available hours. Closure group dates appear as Closure rows, child facilities (chairs) are listed under their master, and a Facility Totals section sums the facility.

Facility Details

Opens from the edit icon or right-click Edit. The header shows the Facility Name, Short Name and Facility Timezone (read only). Everything in the tabs is read only until you use that tab's own buttons. Closing the dialog with Close refreshes the main list when a change affected it.

Tabs

TabPurpose
GeneralFacility type, default note type, clinic scheduling, routing, AlayaCare address and AIS details. Click Edit to change them.
GroupsGroups the facility belongs to in AlayaCare.
SessionsRecurring sessions. Shown only when the facility has no integration type or its type is Program.
ActivitiesRecurring activities. Shown only when the facility has no integration type or its type is Program.
Child label tab (for example the chairs tab)Child facilities of a master facility. Named after the facility's Child Label. Shown only for master facilities.
Closure GroupsClosure groups assigned to the facility. Shown only for master facilities.
AvailabilityAvailability and unavailability. Shown for master facilities, facilities that have children, and child facilities.
Service CodesService codes assigned to the facility. Shown when the facility has no integration type, or its type is Program or Infusion Clinic.
FSM SettingsTarget percentage and utilization colour ranges.
General

Read-only display of: Facility Type, Timezone, Default Note Type; under Clinic Scheduling, Is Master Facility and Child Sequence; under ACIntegrations Routing Details, Route Color, Use Only on certain Weekdays (route types only) with the weekday ticks, Use Starting Location (with Start Time, Depot Visit Time (Minutes), File As, Address, Unit, city, state/province, postal/zip code, Country, Longitude, Latitude), Use Ending Location and Use Starting Location As End (with the ending address fields); under AlayaCare Facility Address, the address, Longitude, Latitude, Main Phone and Other Phone; and under AIS, Mileage Radius UOM, Mileage Radius, Manager Last Name, Manager First Name, Manager MSID, Staffing Model and, for child facilities, AIS Chair Type, AIS Chair Visit Limit UOM and AIS Chair Visit Limit. The state/province and postal/zip labels follow the tenant's country.

Click Edit to open the Edit Facility dialog (see below).

Groups — Grid
ColumnDescription
GroupGroup name.
Sessions — Grid
ColumnDescription
Session NameName of the session.
Start DateFirst date of the session.
From Time / To TimeStart and end time (24-hour).
End DateLast date of the session.
FrequencyRecurrence frequency.
Week DaysDays of the week the session runs.
Employee Id / EmployeeAlayaCare employee assigned.
Service CodeService code of the session.
Manage RecordsEdit icon.
Sessions — Grid Filters
FilterPurpose
Name IncludesSession names containing the text.
StatusAll, Current or Expired.
Sort ByName, Start Date or End Date.

Click Apply Filter to refresh and Clear Filter to reset.

Sessions — Grid Actions
ButtonDescription
AddOpens the Session dialog for a new session.
Edit icon / right-click EditOpens the Session dialog for the row.
Activities — Grid
ColumnDescription
Activity NameName of the activity.
Start Date / End DateDate range.
From Time / To TimeStart and end time (24-hour).
FrequencyRecurrence frequency.
Week DaysDays of the week.
Default Service NameService name selected by default.
Service CodeService code of the activity.
TagsTag names, separated by commas.
Manage RecordsEdit icon.
Activities — Grid Filters
FilterPurpose
Name IncludesActivity names containing the text.
Sort ByName, Start Date or End Date.

Click Apply Filter to refresh and Clear Filter to reset.

Activities — Grid Actions
ButtonDescription
AddOpens the Activity dialog for a new activity.
Edit icon / right-click EditOpens the Activity dialog for the row.
Child label tab — Grid
ColumnDescription
NameName of the child facility.
SequenceOrder of the child under the master facility.
Manage RecordsEdit and delete icons.
Child label tab — Grid Actions
ButtonDescription
Bulk AddOpens the Bulk Add dialog.
Link To Existing FacilityOpens the Add Chair dialog to link an existing facility.
Edit icon / right-click EditOpens the Add Chair dialog to change the Sequence.
Delete icon / right-click DeleteAfter confirmation ("Are you sure you want to delete this chair from the Master facility?"), unlinks the child from the master facility. The facility itself is not deleted.
Closure Groups — Grid
ColumnDescription
NameClosure group name.
Manage RecordsDelete icon.
Closure Groups — Grid Actions
ButtonDescription
AddOpens the Add Closure Group dialog.
Delete icon / right-click DeleteAfter confirmation, removes the group from the facility.
Availability — Grid
ColumnDescription
DescriptionDescription of the record.
TypeAvailability or Unavailability.
Allow VisitsChecked when visits are still allowed.
FrequencyDaily or Weekly.
IntervalEvery N days or weeks.
Start Date / End DateDate range of the recurrence.
Start Time / End TimeTime range (24-hour).
Monday to SundayDays the record applies to.
Manage RecordsEdit and delete icons.
Availability — Grid Actions
ButtonDescription
AddOpens the Facility Availability dialog.
Add Single Day UnavailabilityOpens the Facility Unavailability dialog.
Edit icon / right-click EditOpens the Facility Availability dialog for the row.
Delete icon / right-click DeleteAfter confirmation ("Are you sure you want to delete this availability?"), deletes the record.
Service Codes — Grid
ColumnDescription
DescriptionService code name.
TypeService code description.
Manage RecordsDelete icon (an edit icon is also shown but has no effect).
Service Codes — Grid Actions
ButtonDescription
AddOpens the Add Service Code dialog.
Delete icon / right-click DeleteAfter confirmation ("Are you sure you want to delete this service code assignment from the facility?"), removes the assignment.
FSM Settings

Shows Target % (read only) and the Utilization Colour Ranges grid with Utilization % To and Cell Colour. Click Edit to open the FSM Settings dialog.

Edit Facility

Opens from Edit on the General tab. The header shows the AlayaCare ID and name. Fields shown in the read-only General tab are the same here; those marked read only below cannot be changed.

FieldNotes
Select An Integration TypeDropdown of integration types. Can be changed only when the facility has no child facilities; otherwise the type is displayed read only. Choosing a type also sets the facility's child label.
TimezoneRead only (comes from AlayaCare).
Select A Default Note TypeDropdown of note types.
Is Master FacilityRead only (set by the integration type).
Short NameFor master and child facilities.
Child LabelRead only, master facilities only.
Child SequenceNon-master facilities only.
Route ColorColour picker (text value read only).
Use Only on certain WeekdaysRoute types only; reveals Monday to Sunday checkboxes.
Use Starting LocationReveals Start Time, Depot Visit Time (Minutes), File As, Address, Unit, City, state/province, postal/zip code (with the format of the tenant's country), Country (read only), Longitude, Latitude and a GEO Code button that looks up the coordinates from the address.
Use Ending Location / Use Starting Location As EndWhen ending location is used and is not the starting location, reveals the same address fields (File As (Leave blank for same as starting fileas), Address, Unit, City, state/province, postal/zip, Country, Longitude, Latitude, GEO Code).
AlayaCare Facility AddressAll fields read only.
Mileage Radius UOMMiles or KMs.
Mileage Radius / Mileage Radius NoRNNumbers, minimum 0.
Manager Last Name, Manager First Name, Manager MSIDText.
Staffing ModelFully Staffed, Partial Staffed, Not Staffed.
AIS Chair Type, AIS Chair Visit Limit UOM, AIS Chair Visit LimitChild facilities only. Types: Private, Semi-Private, Lab Station; units: Minutes or Hours.

Click Save or Cancel. On Save, when a starting location is used the system checks the state/province and postal/zip code, requires an address, and requires valid longitude and latitude values (use GEO Code); the same checks apply to a separate ending location. Warnings such as "Please enter a valid starting location", "Starting location not geo coded" or "Ending location not geo coded" explain what to correct.

Session Dialog

Opens from Add or editing a row on the Sessions tab. Header: "Session For" the facility.

FieldNotes
File AsSession name. Required.
CapacityOptional number.
EmployeeSearch for an AlayaCare employee.
Service CodeDropdown of service codes.
Service NameRequired.
Start Time / End TimeRequired; the end must be after the start.
Start Date / End DateBoth required; the end cannot be before the start.
Frequency TypeWeekly.
Every N Weeks1 or 2 (cannot be 0).
Su Mo Tu We Th Fr SaDays the session runs.

Click Save or Cancel.

Activity Dialog

Opens from Add or editing a row on the Activities tab.

FieldNotes
File AsActivity name. Required.
CapacityOptional number.
Default Service Name To SelectText.
Default Intervention To Add (If Required) And Mark As CompleteText.
Service CodeSearchable dropdown.
TagsMulti-select of tags.
Start Time / End TimeRequired; the end must be after the start.
Start Date / End DateStart date required; end date optional but not before the start.
Frequency TypeWeekly.
Every N Weeks1 or 2 (cannot be 0).
Su Mo Tu We Th Fr SaAt least one day required.

Click Save or Cancel.

Bulk Add

Opens from Bulk Add on the child tab. Enter the First Number (defaults to the next unused sequence) and Number of children, then Save. Each child is created in AlayaCare as a new facility named "{master name} - {child label, singular} {number}", with the master's time zone and groups, and then added here under the master. A warning is shown for any that AlayaCare rejects. Both numbers are required.

Add Chair

Opens from Link To Existing Facility or from editing a child. Search for a facility (master facilities and facilities that already have a master are not offered), enter the Sequence (defaults to the next number) and Save. The facility is linked to the master, and takes the child facility type defined for the master's integration type. When editing a child, only the Sequence can be changed. A warning appears if no facility is selected.

Facility Unavailability

Opens from Add Single Day Unavailability. Enter Description, Start Date, Start Time, End Time and tick Allow Visits if visits may still be scheduled. The record applies to that single day. Description, a valid date and valid times are required.

Facility Availability

Opens from Add or editing a row on the Availability tab.

FieldNotes
DescriptionRequired.
TypeAvailability or Unavailability. Can be changed only for master facilities; child facilities can only have Unavailability (a warning appears otherwise).
Allow VisitsCheckbox.
Start DateRequired.
Start Time / End TimeRequired.
Frequency TypeDaily or Weekly.
Every N Weeks / Every N Days1 or 2, depending on the frequency.
Recurrence End DateOptional.
Su Mo Tu We Th Fr SaWeekly only; at least one day required.

Click Save or Cancel.

Add Closure Group

Select a group in Select A Group and click Save. A warning appears if the group is already assigned to the facility.

Add Service Code

Select a service code in Select A Service Code and click Save.

FSM Settings

Opens from Edit on the FSM Settings tab.

FieldPurpose
Target %Target utilization percentage (0 to 100).
Utilization % ToUpper limit of each range. Each row applies up to its To value, starting after the previous row's value. Rows re-sort automatically.
Cell ColourColour used for the range.
Add Row / RemoveAdd or remove a range.

Click Save or Cancel. A confirmation "FSM settings saved." is shown.

Dependencies

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

TableDescription
Closure GroupsClosure groups that can be assigned on the Closure Groups tab.
Facility TypesIntegration types used for the filter, editing a facility and the Availability Details export.
GroupsGroups shown on the Groups tab and refreshed from AlayaCare.
Note TypesDefault note type on the General tab.
Service CodesService codes on sessions, activities and the Service Codes tab.
TagsTags on activities.

Processing Overviews

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

Refresh All From AlayaCare

After clicking Refresh All From AlayaCare (and confirming when there are more than 100 facilities):

  1. Connects to AlayaCare. If the connection cannot be made, nothing further happens.
  2. Reads the groups from the AlayaCare configuration. A group that is not yet known is added; known groups have their name and disabled flag updated.
  3. Switches to each AlayaCare branch in turn and reads that branch's facilities. A branch that cannot be switched to is skipped.
  4. For each facility, reads its details from AlayaCare. A new facility is added (with a blank integration type); an existing one is updated only when the name, time zone, branch, address, coordinates or phone numbers have changed.
  5. Replaces the facility's groups with the groups AlayaCare returns.
  6. Switches back to the original branch and reloads the list. A progress bar shows the group and facility being processed.
  7. In Staging and UAT environments only, compares the facilities stored here with the facilities AlayaCare returned:
    • If AlayaCare returned no facility list for any branch, the warning "Could not compare local facilities because AlayaCare did not return a facility list." is shown and no comparison is made.
    • If some branches could not be loaded, only facilities on the branches that were loaded are compared. If nothing is missing in that case, the warning "Some branches could not be loaded from AlayaCare, so facilities on those branches were not checked." is shown.
    • If any facilities are missing from AlayaCare, the Facilities Not In AlayaCare dialog opens, listing them by name. Nothing is deleted unless you click Delete Invalid Records and confirm.
    • If the comparison itself fails, an error message is shown.

Refresh Single Facility From AlayaCare

After clicking Refresh in the single-facility dialog:

  1. Connects to AlayaCare (nothing further happens if the connection cannot be made) and refreshes the groups in the same way as Refresh All From AlayaCare.
  2. Reads the selected facility's details from AlayaCare and adds or updates it (name, time zone, branch, address, coordinates and phone numbers).
  3. Replaces the facility's groups with the groups AlayaCare returns.
  4. Restores the original branch and reloads the list.

Delete Invalid Records

Available only in Staging and UAT environments, from the Facilities Not In AlayaCare dialog. After confirming:

  1. Deletes each listed facility together with its child facilities and its related groups, sessions, activities, availability, closure groups and service codes.
  2. Records the deletion, closes the dialog and reloads the list.

Bulk Add (Facility Details)

After clicking Save in the Bulk Add dialog:

  1. Reads the master facility's groups from AlayaCare.
  2. For each number in the range, creates a new facility in AlayaCare with the master's time zone and groups.
  3. Reads the new facility back from AlayaCare and adds it here as a child of the master, with its sequence number.
  4. Reloads the child list. The main list is refreshed when the details dialog is closed.

Availability Details Export

After clicking OK, the system validates the selections, reads availability records, closure dates and child facilities for each selected master facility, calculates available, unavailable and net hours for the period, and downloads the workbook.