Aeon Request Form Popup Client Addon
- Brittany de Gail
Name | Request Form Popup Addon |
|---|---|
Version | 1.0.0 |
Author | Atlas Systems, Inc. |
Description | Displays a popup box with a configurable message when a request is opened that contains a value in the specified field. |
Custom Fields Support | Yes |
Download
Configuration
Addon settings are configured in the Manage Addons form.
Name | Type | Default | Description |
|---|---|---|---|
PopupField | String |
| This setting should be configued to contain the name of the Aeon field that will trigger the popup to display if it contains a value. The field selected must be a default field in the Transactions database table or a Transaction-type custom field. Note: The AppointmentID field cannot be used with the Request Form Popup Addon. If a default field in the Transactions table 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. |
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
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:
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 Transaction-type 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 Transactions table entry 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.
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.