The Custom Field List page, located in System Management, is used to extend the Framework database by allowing the addition of new fields. These fields are then usable through the field lists throughout the Framework.
 |
Custom Fields are accessed in field lists throughout the Framework. For example, when building a report, administrators can insert custom fields to display on the report. |
The following columns display on the custom fields page:
| Column Name | Description |
| Field Label | The name of the Custom Field. |
| Table Name | The name of the table in the Akcelerant database where the custom field is located. This is for troubleshooting purposes. |
| Column Name | The name of the column in the Akcelerant database where the custom field is located. This is for troubleshooting purposes. |
| Category | Displays the category in which the custom field was applied. |
| Calculated Field | Displays whether or not the field is calculated. |
The Custom Field List screen allows administrators to create custom and calculated fields.
|
Custom Fields cannot be created or edited when the Rules Management application is checked out to a user. When an attempt to save is made with the application checked out, an error message appears as shown below. |
Creating a Custom Field- Click
. Select Custom Field within the drop-down list. - The Create Field screen appears.
Custom Fields should be added to the Framework after business hours. If a new custom field is created during business hours, it could cause a potential deadlock within the workspace that would negatively impact end users.
- The following fields appear on the Create Field Screen:
Field Name Description Category Drop-down that contains a list of categories in which the custom field is saved and made available in the database.
For each of the following Categories, a maximum of 1,023 custom fields can be created in the Framework:
- Account
- Person
- Case
- Collateral
Upon creating a 1,024th field and clicking
or
, an error message is received stating the maximum number of fields for the Category has been reached and the new field cannot be created.
Custom fields created in the Case Bankruptcy, Case Foreclosure, Case Legal, Case Loan Modification, Case REO, Case Repossession and Case Short Sale categories are only available for addition to Case type screens; they are not available for addition to sub-item Case type screens such as Case Bankruptcy and Case Foreclosure. For example, a Case Bankruptcy type custom field is not available for addition to Case Bankruptcy type screens and panels; it can only be added to Case type screens and panels. Field Label The name of the custom field. This is what appears in the Field List.
The Field Label does not support special characters and must meet the following requirements or a validation error is received upon trying to save the custom field:
- Start with a letter
- Contain only alpha-numeric characters and spaces
- End with an alpha-numeric character
- Include less than 100 characters
Editable Determines whether an end-user has the ability to edit the custom field. Data Type Drop-down that determines the type of custom field that is being created. Description If necessary, provide a description of the new custom field. Lookup Drop-down of lookup values. Lookup is available when the Lookup Data Type is selected. This populates from Field Configurations. Click Create New Lookup List to create a new drop-down list. Field Length Determines how long the field should be. This is enabled when the Character Data Type is selected.
Decimal Places If a numeric Data type is selected, this determines how many decimal places the value has.
- When finished entering information, click to retain the new Custom Field and return to the Custom Fields page. Click
to return without saving. - Custom fields are available to insert into rules. For example, when building a new rule CustomField is an available condition as shown below:
- After selecting the CustomField condition, “…” appears in the rule. Select this option to open a list of custom fields to be inserted into the rule.
|
If authoring Business Rules, it is recommended to select the Sync.Custom Fields button on the Application Toolbar in Rules Manager before authoring a new rule in order to ensure the newly created custom field is available within the Rules Management Application. |
Create a new field by building a calculation using one or more fields and constants. There are two types of Calculated Fields that can be created: Standard and Advanced. The operators available for use in the calculations are addition, subtraction, multiplication, division and order of operation (i.e. parenthesis (A+B)/(C+D)). For date calculations, results are presented in days.
To Create a Standard Calculated Field:
- Click . Expand the Calculated Field option.
- Select Standard. The Standard Calculation Field screen appears.
- The following fields display on the screen:
Field Name Description Category Drop-down that contains a list of categories in which the custom field is located in the database.
Field Label The name of the custom field. This is what appears in the Field List. Data Type Drop-down that determines the type of custom field that is being created. Description If necessary, provide a description of the new standard calculated field. Decimal Places If the Decimal Data Type is selected, this determines how many decimal places the value has.
- After determining the field properties, navigate to the Build Calculation section and use the operator to build the Calculated Field. The fields that can be used in this section are determined by the Category selected. Click Add Field to add fields to the calculation.
- When finished building the calculation, click
. If the calculation is valid, a success message displays. If the calculation is not valid, an error message displays. When finished, click to retain the new Calculated Field and return to the Custom Fields page. The Calculated field is now available for use when building numerous custom Framework features. Click to return without saving.
To Create an Advanced Calculated Field:
- Click . Expand the Calculated Field option.
- Select Advanced.
- A message appears indicating to contact an Akcelerant Customer Care Specialist to set up or modify an Advanced Calculated Field.
It is important to contact Akcelerant prior to using the Advanced Calculated Field option. Inserting an Advanced Calculated field into a Framework feature with an invalid SQL Query can result in performance issues and hang the system.
