As of Aeon v5.1, support for custom fields configured in the Aeon Customization Manager's CustomFieldDefinitions table has been added to the Aeon web interface. This article will overview the options for configuring custom fields on the Aeon web pages.
Configuring DLL Tags | Configuring Display Options | Adding Custom Fields to Web Forms | Adding Custom Fields to the WebValidation Table | OpenURL Mapping
Configuring DLL Tags
Custom fields can be added to existing DLL tags and can be displayed on any of the web pages using the format for each tag below:
<#PARAM name="[Context].CustomFields.[ShortName]">
<#USER field="CustomFields.[ShortName]">
<#TRANSACTION field="CustomFields.[ShortName]">
<#ACTIVITY field="CustomFields.[ShortName]">
<#DATAROW field="[Context].CustomFields.[ShortName]">When formatting these tags, "[Context]" should be replaced with the custom field's context type (Transaction, User, or Activity), and "[ShortName]" replaced with the custom field's short name.
Configuring Display Options
Additional display options are available for custom fields of certain data types:
| Data Type | Display Options |
| DateTime | "ISO8601" - Format date according to the ISO8601 standard. |
| Boolean |
"YesNo" - The value of the field will display as "Yes" when True and "No" when False "TrueFalse" - The value of the field will display as "True" when True and "False" when False |
These options are set in the tag's "display" attribute. For example:
<#USER field="CustomFields.[ShortName]" display="YesNo">Adding Custom Fields to Web Forms
Configuring Input Fields
After configuration in the Customization Manager, a custom field can be added as an additional input field on any of the relevant web forms. For specific configuration instructions and examples, please see Adding Custom Fields to Web Forms.
Configuring Hidden Inputs
The following format should be used to configure a custom field as a hidden input on an Aeon web form:
- Non-EAD Request Forms:
<input type="hidden" name="[ContextType].CustomFields.[ShortName]" value="[Value]"> -
EAD Request Form (EADRequest.html):
<input type="hidden" name="FormDataField" id="[ContextType].CustomFields.[ShortName]" value="[Value]">
In each of the lines of code above, "[ContextType]" should be replaced with the custom field's context type (Transaction, User, or Activity), and "[ShortName]" replaced with the custom field's short name as defined in the CustomFieldDefinitions table. [Value] should be replaced with the value that should be stored in the field when the request is created.
Adding Custom Fields to the WebValidation Table
After configuration in the Customization Manager, a custom field can be added as a required field to the Customization Manager's WebValidation table (located under Web Interface | Validation). The Fieldname and Error Tag columns for the custom field's entry in this table should use the following formatting when referencing the field, where ContextType is Transaction, User, or Activity and ShortName is the short name defined for the field in the CustomFieldDefinitions table:
| Fieldname | [ContextType].CustomFields.[ShortName] |
| Error Tag | ERRORCustomFields.[ShortName] |
OpenURL Mapping
Custom fields can be mapped via OpenURL:
- The Aeon Field Name value in the Customization Manager's OpenURLMapping table entry should be in the format "Transaction.CustomFields.[ShortName]"
- The Open URL Field Values value should be set to the name configured for the custom field in the OpenURL link, formatted in tag format (i.e., <#CustomFieldName>). You can use any name of your choice when configuring the custom field in the OpenURL link, however, it is recommended to use the short name defined for the field in the CustomFieldDefinitions table as a best practice