ACI Documentation

Form Context Fields

Executive Summary

Form Context Fields is a read-only reference list of the profile attributes ("context fields") that AlayaCare makes available for use in forms, such as a client's name or address tags. Administrators use it to look up a field's tag and details when building or checking forms. Click Refresh from AlayaCare to load the latest list.

Key Features

  • Refresh the list of fields from AlayaCare, adding new fields and updating existing ones
  • See each field's description, tag, family, form type, input type, default flag and sort order
  • Filter by description or tag
  • Export the list to Excel, including extra details not shown in the grid (label, options and regular expression)

Typical Workflow

  1. Click Refresh from AlayaCare to load new or changed fields.
  2. Type part of a description in Filter Name and/or part of a tag in Filter Tag, then click Apply Filter.
  3. 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 context fields stored in the integration (14 rows per page). The first three columns stay in place when you scroll sideways.

ColumnDescription
AC IDAlayaCare field ID.
DescriptionDescription of the field.
TagTag used to reference the field.
FamilyGroup of fields the field belongs to.
Form TypeType of form the field applies to.
Input TypeKind of input the field represents.
Is DefaultChecked when the field is a default field.
Sort OrderDisplay order of the field.

Main Grid Filters

FilterPurpose
Filter NameShows only fields whose description contains the text entered (not case-sensitive).
Filter TagShows only fields whose tag contains the text entered (not case-sensitive).

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

Actions

ButtonDescription
Refresh from AlayaCareLoads the fields from AlayaCare (see Processing Overviews).
ExportExports the fields currently shown (after filters) to Excel with the columns AC ID, Description, Family Description, Family Id, Form Type, Input Type, Is Default, Label, Options, Regex, Sort Order and Tag. A warning "Nothing to export" is shown when the list is empty.
Apply Filter / Clear FilterApply or reset the filters.

Processing Overviews

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

Refresh from AlayaCare

  1. A Refresh Form Context Fields progress panel opens.
  2. The system signs in to AlayaCare if needed. If sign-in fails, the process stops.
  3. Every context field is read from AlayaCare.
  4. For each field, the panel shows "Processing Form Context Field description - n of total".
  5. A field not yet in the integration is added; if it cannot be added, the reason is shown as a warning and processing continues.
  6. An existing field is updated with the current description, family, form type, input type, default flag, label, options, regular expression, sort order and tag. Errors updating a field are not reported.
  7. Fields removed in AlayaCare are not deleted from the integration.
  8. The panel closes and the grid reloads.