ACI Documentation

Forms

Executive Summary

Forms lists the AlayaCare forms (version 2.0 forms) that the integration knows about, with their category, status, version and draft state. Administrators use it to bring the form list in line with AlayaCare and to adjust the category under which a form is shown in the integration. Other screens that work with forms, such as form selection dropdowns, depend on this list.

Key Features

  • Refresh the list of forms from AlayaCare, adding new forms and updating existing ones, with a progress panel
  • See each form's AlayaCare ID, name, category, status, version, schema and draft flag
  • Filter the list by form name
  • Change the category shown for a form
  • Export the list to Excel

Typical Workflow

  1. Click Refresh from AlayaCare to load new or changed forms.
  2. Optionally type part of a form name in Filter Name and click Apply Filter.
  3. To change a form's category, click the edit icon (or right-click the row and choose Edit), type the new category, and click Save.
  4. Click Export to save the list to Excel.

Available Permissions

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

AttributeWhat It Controls
ViewOpen the page

Main Grid

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

ColumnDescription
AC IDAlayaCare form ID.
NameForm name.
CategoryForm category.
StatusForm status in AlayaCare.
VersionForm schema version.
SchemaForm schema identifier.
Is DraftChecked when the form is a draft in AlayaCare.
Manage RecordsEdit icon for the row.

Main Grid Filters

FilterPurpose
Filter NameShows only forms whose name contains the text entered (not case-sensitive).

Click Apply Filter to refresh the list. Use Clear Filter to reset the filter.

Actions

ButtonDescription
Refresh from AlayaCareLoads the forms from AlayaCare (see Processing Overviews).
ExportExports the forms currently shown (after the filter) to Excel with the columns AC Id, Name, Type and Category. A warning "Nothing to export" is shown when the list is empty.
Apply Filter / Clear FilterApply or reset the name filter.
Edit (row icon, or right-click a row)Opens the edit dialog for the form.

Dialog Components

Edit Form

Opens from Edit. The title shows the form's AlayaCare ID and name. The only field you can change is Category. Click Save to store it or Cancel to close without saving. The category is replaced the next time the forms are refreshed from AlayaCare.

Processing Overviews

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

Refresh from AlayaCare

  1. A Refresh Forms progress panel opens.
  2. The system signs in to AlayaCare if needed. If sign-in fails, the process stops.
  3. The form categories and then every form (all versions, including drafts) are read from AlayaCare, and the refresh is recorded in the activity log.
  4. For each form, the panel shows "Processing Form name - n of total".
  5. A form that is not yet in the integration is added with its name, category, status, type, version, schema and draft flag.
  6. An existing form is updated with the current name, category, status, type, version and draft flag from AlayaCare. Any category you set manually on this screen is overwritten with the AlayaCare category.
  7. Forms removed in AlayaCare are not deleted from the integration. Errors saving an individual form are not reported and processing continues.
  8. The panel closes and the grid reloads.