Progress Report Templates
Executive Summary
Progress Report Templates is the setup screen where administrators maintain the templates used to build progress reports. A template has a name and description, a list of detail settings (text, multiline text, encrypted text, a form context field, or a signature image) that supply the content of the report, and a list of the travel premium codes that apply to it. The main page lists the templates and lets you add, open, or delete one; opening a template shows its detail page, where the settings and travel premium codes are managed.
Key Features
- List all progress report templates with their ID, name, description, discontinued flag, and who published and added them
- Add a new template with a name and description
- Open a template to edit its name and description
- Add, edit, and delete the template's detail settings, using five content types: Text, Multiline Text, Encrypted Text, Form Context Field, and Signature (a PNG image)
- Add and remove the travel premium codes linked to a template
- Delete a template
Typical Workflow
- Click Add, enter a Name and Description, and click Save. The template is created as not discontinued.
- Click the edit icon on the new row (or right-click it and choose Edit) to open the template page.
- On the Details tab, click Add and fill in the Setting, Description, and Content Type, then the value for that type. Click Save.
- On the Travel Premium Codes tab, click Add and pick the premium codes that apply.
- Use the back arrow at the top of the page to return to the list.
Available Permissions
The following permissions are available to be assigned to AlayaCare Roles:
| Attribute | What It Controls |
|---|---|
| View | Open the list page and the template page |
Main Grid
The grid lists the progress report templates, 14 rows per page.
| Column | Description |
|---|---|
| ID | Template ID. |
| Name | Template name. |
| Description | Template description. |
| Is Discontinued | Checked when the template is discontinued. |
| Published On | Date and time the template was published, in the tenant time zone. |
| Published By | User who published the template. |
| Added | Date and time the template was added. |
| Added By | User who added the template. |
| Manage Records | Delete and edit icons for the row. |
Actions
| Button | Description |
|---|---|
| Add | Opens the Report Templates dialog to create a template. |
| Edit icon (row) | Opens the template page. |
| Delete icon (row) | Asks "Are you sure you want to delete this Template?" and deletes it when confirmed. If the delete fails a "Delete Failed" message is shown. |
| Edit (right-click a row) | Same as the edit icon. |
| Delete (right-click a row) | Same as the delete icon. |
Dialog Components
Report Templates
Opens from Add. Enter the Name and Description (multi-line) and click Save, or Cancel to close.
Progress Report Template
This page opens from the edit icon or the right-click Edit option. Use the back arrow beside the page title to return to the list.
The top of the page shows the template's ID, Status, Name, Description, Published Date/Time, and Published By (all read-only). Click Edit to open the Template dialog and change the Name and Description; click Save or Cancel.
Tabs
| Tab | Purpose |
|---|---|
| Details | The settings that supply the content of the report. |
| Travel Premium Codes | The travel premium codes linked to the template. |
Details — Grid
Lists the template's settings, 10 rows per page.
| Column | Description |
|---|---|
| Setting | Name of the setting. |
| Description | Description of the setting. |
| Content Type | Text, Form Context Field, Signature, Encrypted Text, or Multiline Text. |
| Text Value | The text entered for the setting. |
| FCF Tag | Description of the selected form context field. |
| Manage Records | Delete and edit icons. |
Details — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Detail dialog for a new setting. |
| Edit | Opens the Detail dialog for the selected row. If no row is selected, "Please select a detail" is shown. |
| Edit icon (row) | Opens the Detail dialog for that row. |
| Delete icon (row) | Asks "Are you sure you want to delete this detail?" and deletes it when confirmed. |
| Add / Edit / Delete (right-click a row) | Same as the buttons and icons above. |
The Detail dialog has Setting, Description, and Content Type, then one of the following depending on the content type:
| Content Type | Extra field |
|---|---|
| Text | Text Value (single line). |
| Multiline Text | Text Value (multiple lines). |
| Encrypted Text | Text Value. The value is stored encrypted and shown decrypted when the setting is edited. |
| Form Context Field | Select A Form Context Field Code. Choose from the form context fields. |
| Signature | Shows the current image, with an uploader to replace it. Only .png files are accepted. |
Click Save to store or Cancel.
Travel Premium Codes — Grid
| Column | Description |
|---|---|
| AcId | AlayaCare ID of the premium code. |
| Code | Premium code name. |
| Manage Records | Delete icon. |
Travel Premium Codes — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Premium Code dialog. Choose a Premium Code from the list and click Save. |
| Delete icon (row) | Asks "Are you sure you want to delete this premium code?" and removes it from the template when confirmed. |
| Add / Delete (right-click a row) | Same as the button and icon above. |
Dependencies
The following tables must be configured for lookups on this view to work:
| Table | Description |
|---|---|
| Form Context Fields | Fields offered for Form Context Field settings. |
| Premium Codes | Premium codes offered on the Travel Premium Codes tab. |