Fullscreen Image

Add a Custom List to a Page or Form

Custom Lists allow you to store multiple values at the field-level. For example, you could create a custom list of comments related to a contract, allowing users to add and track comments over time. However, to use this functionality you must add the custom list to your form or create a custom list field that you can add to your page.

ClosedCreate a Custom List

There are some requirements you must meet before you can add a custom list to a form or page layout.

  1. Create your custom list.

  2. Add fields to your custom list.

  3. Add a layout to your custom list.

  4. Build your custom list layout.

ClosedAdd a Custom List to a Form

To add a custom list to a form:

  1. Click Admin in the toolbar in the upper-right corner of the window.

    The System Administrator Dashboard page opens.

  2. Click Manage Forms link in the Company Administration column.

    The Manage Forms page opens.

  3. Click Edit Fields link in the Actions column of the form type whose fields you want to manage.

    The Edit Fields window opens.

  4. Click Add Report / Form Field.

    The Add Report / Form Field window opens.

  5. Select the Custom Field option.

  6. Enter the field name in the Field Name field.

    To learn our best practices for naming custom list fields, see our Naming Conventions in Lucernex walkthrough.

  7. Enter the name this field should have in the database in the Integration Name field.

    To learn our best practices for database field names, see our Naming Conventions in Lucernex walkthrough.

  8. Select Custom List from the Form Field Type field.

  9. Select the custom list you want to add from the Custom Lists field.

  10. Click Add.

    The window closes. The field appears in the Edit Fields window.

  11. Click A small, white, square button with a plus symbol in its center. next to the form type whose layout you want to build.

    The layouts associated with the form type appear as child items.

  12. Click Build Layout link in the Actions column for the layout you want to build.

    The Layout Builder opens in a window.

  13. Expand the Available Fields > Forms > [Form Name] > [Custom List Name] folder in the Fields pane.

    This folder will contain both the fields that are in the custom list AND the fields which contain the custom list layouts.

  14. Find the name of the custom list layout that you want to add to your form.

    Custom lists can have multiple layouts. The name of the layout will correspond with the name you put in the Page Layout Name field.

  15. Drag and drop the custom list layout field on a A small square gray button with a plus symbol in its center. icon in the layout.

    The custom list is added to the cell.

  16. Click Save Layout.

    The window closes. Your changes are saved.

ClosedAdd a Custom List to a Page Layout

There are two steps to add a custom list to a page layout. First, you must create a data field to contain the custom list layout. Second, you must add the field you created to the page layout.

ClosedCreate a Custom List Data Field

To create a custom list data field:

  1. Click Admin in the toolbar in the upper-right corner of the window.

    The System Administrator Dashboard page opens.

  2. Click Manage Data Fields link in the Company Administration column.

    The Firm Fields page opens.

  3. Find the group to which you want to add the custom list field.

    Click A small, white, square button with a plus symbol in its center. and A small white square button with a minus symbol in its center. buttons to expand and collapse the groups on the Firm Fields page.

  4. Click Add Field link in the right-most column of the group.

    The Add Field window opens.

  5. Enter the field label that will be displayed on the page in the Label (Displayed on the UI) field.

    To learn our best practice recommendations for field labels, see our Naming Conventions in Lucernex walkthrough.

  6. Enter the field name in the Field Name (NOT displayed on the UI) field.

    This field name is used to identify the field in the database. To learn our best practice recommendations for custom list database field names, see our Naming Conventions in Lucernex walkthrough.

    Important!

    The Field Name must not contain spaces.

  7. Select the database table that the field should be associated with from the Table Association field.

    We recommend that you select an entity table, such as Contract, Facility, Project, and so on. This will simplify custom list reporting.

  8. Select the Choose Custom List Type option.

  9. Select the custom list from the Custom Lists field.

  10. Click Add.

    The window closes. The field appears on the Firm Fields page in the group you selected in Step 2.

ClosedAdd a Custom List Data Field to a Page Layout

To add a custom list data field to a page layout:

  1. Click Admin in the toolbar in the upper-right corner of the window.

    The System Administrator Dashboard page opens.

  2. Click Manage Page Layouts link in the Company Administration column.

    The Manage Summary Pages page opens.

  3. If you are adding the custom list to a sub-page or list layout page, click the appropriate tab.

  4. Click Build Layout link in the Actions column for the layout you want to build.

    The Layout Builder opens in a window.

  5. Expand the Available Fields folder in the Fields pane.

  6. Navigate to the sub-folder where your custom list field is located.

    The structure of the folder tree mirrors the structure of the groups on the Manage Data Fields page.

  7. Expand the folder for your custom list.

    This folder will contain both the fields that are in the custom list AND the fields which contain the custom list layouts.

  8. Find the name of the custom list layout that you want to add to your form.

    Custom lists can have multiple layouts. The name of the layout will correspond with the name you put in the Page Layout Name field.

  9. Drag and drop the custom list layout field on a A small square gray button with a plus symbol in its center. icon in the layout.

    The custom list is added to the cell.

  10. Click Save Layout.

    The window closes. Your changes are saved.