ACI Documentation

Branches

Executive Summary

Branches lists the AlayaCare branches that are known to the integration. Administrators use it to bring the branch list in line with AlayaCare, so that other screens that depend on branches (for example filters and dropdowns) have current data. The screen is read-only: you cannot add, edit or delete a branch here. Click Refresh from AlayaCare to load any new branches from AlayaCare and to pick up changed branch descriptions.

Key Features

  • View every branch with its AlayaCare ID, description, master account, AlayaCare profile ID, email address and time zone
  • Refresh the list from AlayaCare, adding branches that are new in AlayaCare and updating the description of existing branches that were renamed
  • Progress panel shows each branch as it is processed

Typical Workflow

  1. Open Branches to see the branches currently stored.
  2. Click Refresh from AlayaCare after a branch has been added or renamed in AlayaCare.
  3. Wait for the progress panel to finish; the grid reloads with the updated list.

Available Permissions

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

AttributeWhat It Controls
ViewOpen the page (and use Refresh from AlayaCare)

Main Grid

Lists every branch stored in the integration (14 rows per page).

ColumnDescription
AC IDAlayaCare branch ID.
DescriptionBranch name.
Master AccountMaster account the branch belongs to in AlayaCare.
AC Profile IDAlayaCare profile ID of the branch.
Email AddressBranch email address. This is not filled in by the refresh from AlayaCare, so it may be blank.
TimezoneBranch time zone.

Actions

ButtonDescription
Refresh from AlayaCareLoads the branch list from AlayaCare and updates the grid (see Processing Overviews).

Processing Overviews

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

Refresh from AlayaCare

  1. A Refresh Branches progress panel opens.
  2. The system signs in to AlayaCare if the session has expired. If sign-in fails, the process stops and nothing is changed.
  3. The list of branches configured in AlayaCare is read.
  4. For each AlayaCare branch, the panel shows "Processing Branch name - n of total" and the progress bar advances.
  5. A branch that is not yet in the integration is added with its AlayaCare ID, description, master account, profile ID and time zone.
  6. A branch that already exists is updated only when its description has changed in AlayaCare. Other fields on existing branches are not changed.
  7. Branches that were removed in AlayaCare are not deleted from the integration.
  8. The panel closes automatically and the grid reloads.