Aeon Form Popup Client Addon
Name | Form Popup Addon |
|---|---|
Version | 2.0.0 |
Author | Atlas Systems, Inc. |
Description | Displays a popup box with a configurable message when a request, user, or activity is opened that contains a value in the specified field. |
Custom Fields Support | Yes |
Download
Release Notes
Release notes are available for Form Popup Client Addon v2.0.0 and later.
v2.0.0:
Added support for User and Activity form fields.
New setting: FormType
Addon name changed from Aeon Request Form Popup Client Addon to Aeon Form Popup Client addon to reflect this.
Configuration
Addon settings are configured in the Manage Addons form.
Name | Type | Default | Description |
|---|---|---|---|
FormType | String | Request | The type of form the field that will trigger the popup to display is on. Value can be Request, User, or Activity. |
PopupField | String |
| The field that will trigger the popup to display if it contains a value. If a custom field is selected, enter the short name for the field as defined in the Customization Manager's CustomFieldDefinitions table. Note: The AppointmentID field cannot be used with the Form Popup Addon. If a default field is selected, the name of the field must be entered exactly as it appears in the Aeon Database Tables documentation. If a custom field is selected, then this setting should contain the short name for the field as defined in the Customization Manager's CustomFieldDefinitions table. |
CustomField | Boolean | False (Unchecked) | Must be checked if the field configured in the PopupField setting is a custom field. Custom fields are fields defined in the Customization Manager's CustomFieldDefinitions table. |
Message | String |
| This setting should be configured to contain the message that you want to display in the popup box. |
Example Use Case and Configuration
This addon supports user-created custom fields. For more information on configuring custom fields, please see the Aeon documentation.
An example use case for this addon is to configure it to display a warning message when a request for a restricted item that requires special handling is opened in the Aeon Client. Configuration steps for this use case are as follows:
Set FormType to Request. This tells the addon that it should open on the Request form and look for a field in the Transactions table.
Decide which Aeon field will be used to indicate that a request is for a restricted item. You can either use a default Aeon field in the Transactions database table, such as the AccessRestrictions field added in Aeon 5.2, or a custom field configured in the Aeon Customization Manager.
If a default field is used, then enter the name of that field into the PopupField setting (e.g., ItemInfo1, AccessRestrictions, etc.)
The name of the field must match the name of the field in the Aeon database, which may differ from its label on the request form. Please refer to the relevant table entries in the Aeon Database Tables documentation to determine the database name for the field. AppointmentID cannot be used with the Request Form Popup Addon.If a custom field is used, enter the short name for that field as defined in the Customization Manager's CustomFieldDefinitions table
Check the checkbox for the addon's CustomField setting if the field selected for the PopupField setting is a custom field
Leave this setting unchecked if the PopupField is a default Aeon field such as AccessRestrictions or ItemInfo1
Change the Message setting to contain the text for the message you would like the popup to display when a request containing a value in the PopupField is opened (e.g., "This request is for a restricted item. Please check notes for handling instructions.")
Click Save Settings on the Manage Addons form to save the configuration settings for the addon
Each time a request is opened that contains a value in the PopupField, a popup box will appear displaying the message you configured in step three.
The popup message will display when the specified PopupField on an opened request contains any value at all. For example, if you select to use the AccessRestrictions field for the PopupField, the addon popup will display for requests containing a value in that field, even if that value is “No.” As a best practice, ensure that the PopupField selected is appropriate for the addon based on your institution’s standards for entering data into that field.
Addon Configuration Error Handling
If either the PopupField and/or CustomField settings are configured incorrectly (e.g., if the name of the PopupField is misspelled, the CustomField setting is not checked for a custom field, etc.), then an error message stating "Popup field not found. Check addon configuration" will display each time a request form is opened in the Aeon Client. This error message will also display if the PopupField setting contains a field that is not in the Transactions table or is not a Transaction-type custom field.
To resolve this error, check the addon settings and adjust your configuration appropriately.