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
- Click Refresh All From AlayaCare (or Refresh Single Facility From AlayaCare) to bring the latest facilities, addresses and groups from AlayaCare.
- Use Filter Description and Filter Integration Type, then Apply Filter, to find the facility.
- Click the edit icon on the row (or right-click the row and choose Edit) to open Facility Details.
- On the General tab, click Edit to set the integration type, short name, route colour, starting/ending locations and AIS details, then Save.
- Use the other tabs to maintain sessions, activities, chairs, closure groups, availability, service codes and FSM settings as they apply to the facility.
- Click Close when finished. The list refreshes if anything that affects it was changed.
- 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:
| Attribute | What It Controls |
|---|---|
| View | Open 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.
| Column | Description |
|---|---|
| AC ID | AlayaCare facility ID. |
| Name | Facility name from AlayaCare. Can be filtered with a contains search from the column header. |
| Timezone | Facility time zone from AlayaCare. Can be filtered. |
| Branch | AlayaCare branch ID of the facility. |
| Integration Type | The integration type assigned to the facility on the General tab. |
| Master | Checked when the facility is a master facility (one that has child facilities such as chairs). |
| Child Label | The label used for a master facility's children (for example the name for its chairs). |
| AlayaCare Address | Address lines, city, state/province and postal/zip code from AlayaCare. |
| AlayaCare Phone | Main and other phone numbers from AlayaCare. |
| Color | Route colour dot, when a colour has been set. |
| Route Starting Location | File-as name and address of the starting location, when Use Starting Location is on. |
| Route Ending Location | Ending location, or "same as Starting Location", when Use Ending Location is on. |
| Manage Records | Edit icon that opens Facility Details. |
Main Grid Filters
| Filter | Purpose |
|---|---|
| Filter Description | Shows only facilities whose name contains the text entered (not case-sensitive). |
| Filter Integration Type | Multi-select list of integration types (with Select All). Shows only facilities of the ticked types. |
| Items Per Page | Number 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
| Button | Description |
|---|---|
| Refresh All From AlayaCare | Refreshes 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 AlayaCare | Opens the Refresh Single Facility From Alayacare dialog. |
| Export | Exports 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 Details | Opens the Availability Details Export dialog. |
| Apply Filter | Applies the description and integration type filters. |
| Clear Filter | Clears 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.
| Button | Description |
|---|---|
| Delete Invalid Records | After 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. |
| Close | Closes 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.
| Field | Purpose |
|---|---|
| Parent Facility Type | Required. Lists the integration types that are master types. Choosing one limits the Locations list to master facilities of that type. |
| Locations | Required. Multi-select (with Select All, grouped by state/province) of master facilities. |
| From Date / To Date | Required. Default to the Monday to Sunday of the current week. The To date cannot be before the From date. |
| Show Daily Values | When 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
| Tab | Purpose |
|---|---|
| General | Facility type, default note type, clinic scheduling, routing, AlayaCare address and AIS details. Click Edit to change them. |
| Groups | Groups the facility belongs to in AlayaCare. |
| Sessions | Recurring sessions. Shown only when the facility has no integration type or its type is Program. |
| Activities | Recurring 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 Groups | Closure groups assigned to the facility. Shown only for master facilities. |
| Availability | Availability and unavailability. Shown for master facilities, facilities that have children, and child facilities. |
| Service Codes | Service codes assigned to the facility. Shown when the facility has no integration type, or its type is Program or Infusion Clinic. |
| FSM Settings | Target 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
| Column | Description |
|---|---|
| Group | Group name. |
Sessions — Grid
| Column | Description |
|---|---|
| Session Name | Name of the session. |
| Start Date | First date of the session. |
| From Time / To Time | Start and end time (24-hour). |
| End Date | Last date of the session. |
| Frequency | Recurrence frequency. |
| Week Days | Days of the week the session runs. |
| Employee Id / Employee | AlayaCare employee assigned. |
| Service Code | Service code of the session. |
| Manage Records | Edit icon. |
Sessions — Grid Filters
| Filter | Purpose |
|---|---|
| Name Includes | Session names containing the text. |
| Status | All, Current or Expired. |
| Sort By | Name, Start Date or End Date. |
Click Apply Filter to refresh and Clear Filter to reset.
Sessions — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Session dialog for a new session. |
| Edit icon / right-click Edit | Opens the Session dialog for the row. |
Activities — Grid
| Column | Description |
|---|---|
| Activity Name | Name of the activity. |
| Start Date / End Date | Date range. |
| From Time / To Time | Start and end time (24-hour). |
| Frequency | Recurrence frequency. |
| Week Days | Days of the week. |
| Default Service Name | Service name selected by default. |
| Service Code | Service code of the activity. |
| Tags | Tag names, separated by commas. |
| Manage Records | Edit icon. |
Activities — Grid Filters
| Filter | Purpose |
|---|---|
| Name Includes | Activity names containing the text. |
| Sort By | Name, Start Date or End Date. |
Click Apply Filter to refresh and Clear Filter to reset.
Activities — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Activity dialog for a new activity. |
| Edit icon / right-click Edit | Opens the Activity dialog for the row. |
Child label tab — Grid
| Column | Description |
|---|---|
| Name | Name of the child facility. |
| Sequence | Order of the child under the master facility. |
| Manage Records | Edit and delete icons. |
Child label tab — Grid Actions
| Button | Description |
|---|---|
| Bulk Add | Opens the Bulk Add dialog. |
| Link To Existing Facility | Opens the Add Chair dialog to link an existing facility. |
| Edit icon / right-click Edit | Opens the Add Chair dialog to change the Sequence. |
| Delete icon / right-click Delete | After 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
| Column | Description |
|---|---|
| Name | Closure group name. |
| Manage Records | Delete icon. |
Closure Groups — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Add Closure Group dialog. |
| Delete icon / right-click Delete | After confirmation, removes the group from the facility. |
Availability — Grid
| Column | Description |
|---|---|
| Description | Description of the record. |
| Type | Availability or Unavailability. |
| Allow Visits | Checked when visits are still allowed. |
| Frequency | Daily or Weekly. |
| Interval | Every N days or weeks. |
| Start Date / End Date | Date range of the recurrence. |
| Start Time / End Time | Time range (24-hour). |
| Monday to Sunday | Days the record applies to. |
| Manage Records | Edit and delete icons. |
Availability — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Facility Availability dialog. |
| Add Single Day Unavailability | Opens the Facility Unavailability dialog. |
| Edit icon / right-click Edit | Opens the Facility Availability dialog for the row. |
| Delete icon / right-click Delete | After confirmation ("Are you sure you want to delete this availability?"), deletes the record. |
Service Codes — Grid
| Column | Description |
|---|---|
| Description | Service code name. |
| Type | Service code description. |
| Manage Records | Delete icon (an edit icon is also shown but has no effect). |
Service Codes — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Add Service Code dialog. |
| Delete icon / right-click Delete | After 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.
| Field | Notes |
|---|---|
| Select An Integration Type | Dropdown 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. |
| Timezone | Read only (comes from AlayaCare). |
| Select A Default Note Type | Dropdown of note types. |
| Is Master Facility | Read only (set by the integration type). |
| Short Name | For master and child facilities. |
| Child Label | Read only, master facilities only. |
| Child Sequence | Non-master facilities only. |
| Route Color | Colour picker (text value read only). |
| Use Only on certain Weekdays | Route types only; reveals Monday to Sunday checkboxes. |
| Use Starting Location | Reveals 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 End | When 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 Address | All fields read only. |
| Mileage Radius UOM | Miles or KMs. |
| Mileage Radius / Mileage Radius NoRN | Numbers, minimum 0. |
| Manager Last Name, Manager First Name, Manager MSID | Text. |
| Staffing Model | Fully Staffed, Partial Staffed, Not Staffed. |
| AIS Chair Type, AIS Chair Visit Limit UOM, AIS Chair Visit Limit | Child 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.
| Field | Notes |
|---|---|
| File As | Session name. Required. |
| Capacity | Optional number. |
| Employee | Search for an AlayaCare employee. |
| Service Code | Dropdown of service codes. |
| Service Name | Required. |
| Start Time / End Time | Required; the end must be after the start. |
| Start Date / End Date | Both required; the end cannot be before the start. |
| Frequency Type | Weekly. |
| Every N Weeks | 1 or 2 (cannot be 0). |
| Su Mo Tu We Th Fr Sa | Days the session runs. |
Click Save or Cancel.
Activity Dialog
Opens from Add or editing a row on the Activities tab.
| Field | Notes |
|---|---|
| File As | Activity name. Required. |
| Capacity | Optional number. |
| Default Service Name To Select | Text. |
| Default Intervention To Add (If Required) And Mark As Complete | Text. |
| Service Code | Searchable dropdown. |
| Tags | Multi-select of tags. |
| Start Time / End Time | Required; the end must be after the start. |
| Start Date / End Date | Start date required; end date optional but not before the start. |
| Frequency Type | Weekly. |
| Every N Weeks | 1 or 2 (cannot be 0). |
| Su Mo Tu We Th Fr Sa | At 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.
| Field | Notes |
|---|---|
| Description | Required. |
| Type | Availability or Unavailability. Can be changed only for master facilities; child facilities can only have Unavailability (a warning appears otherwise). |
| Allow Visits | Checkbox. |
| Start Date | Required. |
| Start Time / End Time | Required. |
| Frequency Type | Daily or Weekly. |
| Every N Weeks / Every N Days | 1 or 2, depending on the frequency. |
| Recurrence End Date | Optional. |
| Su Mo Tu We Th Fr Sa | Weekly 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.
| Field | Purpose |
|---|---|
| Target % | Target utilization percentage (0 to 100). |
| Utilization % To | Upper limit of each range. Each row applies up to its To value, starting after the previous row's value. Rows re-sort automatically. |
| Cell Colour | Colour used for the range. |
| Add Row / Remove | Add 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:
| Table | Description |
|---|---|
| Closure Groups | Closure groups that can be assigned on the Closure Groups tab. |
| Facility Types | Integration types used for the filter, editing a facility and the Availability Details export. |
| Groups | Groups shown on the Groups tab and refreshed from AlayaCare. |
| Note Types | Default note type on the General tab. |
| Service Codes | Service codes on sessions, activities and the Service Codes tab. |
| Tags | Tags 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):
- Connects to AlayaCare. If the connection cannot be made, nothing further happens.
- 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.
- Switches to each AlayaCare branch in turn and reads that branch's facilities. A branch that cannot be switched to is skipped.
- 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.
- Replaces the facility's groups with the groups AlayaCare returns.
- Switches back to the original branch and reloads the list. A progress bar shows the group and facility being processed.
- 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:
- 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.
- Reads the selected facility's details from AlayaCare and adds or updates it (name, time zone, branch, address, coordinates and phone numbers).
- Replaces the facility's groups with the groups AlayaCare returns.
- 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:
- Deletes each listed facility together with its child facilities and its related groups, sessions, activities, availability, closure groups and service codes.
- Records the deletion, closes the dialog and reloads the list.
Bulk Add (Facility Details)
After clicking Save in the Bulk Add dialog:
- Reads the master facility's groups from AlayaCare.
- For each number in the range, creates a new facility in AlayaCare with the master's time zone and groups.
- Reads the new facility back from AlayaCare and adds it here as a child of the master, with its sequence number.
- 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.