Table of Contents


Configuring List Layouts

There are several different types of layouts for Entity Lists in Magentrix that enable you to view and access records differently. List Layouts control how entity records appear in different contexts including the home tab, lookup dialogs, list views, search results, related lists, and mini layout cards.

Before You Begin

Requirements

To create and edit list layouts, users must have the following permissions:

  • Administrator System Role

Understanding List Layout Types

Magentrix provides six distinct list layout types, each designed for a specific context where entity records are displayed:

Home Tab

When you create a tab for an entity, this is the default list layout users will see when they click on the tab. This layout controls the columns, sorting, and buttons displayed on the main entity index page where records are listed with pagination (default 20 records per page).

Use Case: Main view when users navigate to the entity from the navigation menu.

Lookup Dialog

A Lookup Dialog appears when users click on the magnifying glass icon next to a Lookup field. It provides a list of records the user can select to populate a Lookup Field. The Lookup Dialog also appears automatically with type-ahead suggestions as users type in a Lookup field.

How it Works:

  • If the user has typed text, the dialog shows filtered results and the search bar is pre-populated
  • If no text is entered, the dialog shows the first 20 records based on the configured sort order
  • Users can search and select records from the configured columns

Use Case: Selecting related records when filling out Lookup fields.

List View

From the Entity Home page, portal users can create custom List Views to filter Entity Records. This List Layout will be used as a default template for all new List Views as well as allowing you to decide which buttons are shown in all List Views.

How it Works:

  • Users create personal or shared list views with custom filters
  • The List View layout provides the default column configuration
  • Users can modify columns in their personal views
  • Administrators control which buttons appear

Use Case: Custom filtered views that users create to organize their work.

Search

When you mark the entity as searchable for global search, this list layout will be used when displaying search results. The Search layout controls how records from this entity appear in global search results.

Use Case: Results displayed when users search for records using global search.

Related List

In the Layout Designer, you can drag and drop Related Lists onto a page layout that appears as tabs at the bottom of the detail page. This layout is used as a default template in Layout Designer for all related lists of that entity.

How it Works:

  • Related lists show child records or related records on a parent's detail page
  • The Related List layout defines the default columns and sorting
  • Individual related lists can be customized in the Layout Designer

Use Case: Displaying related records at the bottom of detail pages (e.g., Contacts related to an Account).

Mini Layout (Card)

A Mini Layout or Card is a snapshot of a record that pops up when users hover over a Lookup link. This provides a quick preview of key information without navigating to the full detail page.

How it Works:

  • When users hover over a clickable record name in a Lookup field, a card appears
  • The card shows key fields configured in the Mini Layout
  • Users can quickly view essential information without leaving the current page

Use Case: Hover preview cards for quick reference information.

Creating and Editing List Layouts

To create or edit a list layout:

  1. In the Setup Home page:

    • If you want to design a layout for a Magentrix Entity, click Create > Entities.
    • If you want to design a layout for a Salesforce integrated Entity, click Extend > Salesforce.

  2. Click on the Entity for which you want to create a List Layout.

  3. Scroll to the bottom of the page and click on the List Layouts tab.

  4. To create a new List Layout:

    • Click New

    To edit an existing List Layout:

    • Click the Downward Action Arrow next to the layout
    • Click Edit

  5. In the Information pane:

    a. If you are creating a new List Layout, select the type of Layout you wish to create in the Layout picklist:

    • Home Tab
    • Lookup Dialog
    • List View
    • Search
    • Related List
    • Mini Layout (Card)

    b. Columns: Select the columns you want in the List View. You can choose which columns appear and the order in which they appear.

    • Available columns appear on the left
    • Selected columns appear on the right
    • Use the arrow buttons to move columns between lists
    • Use the up/down arrows to reorder selected columns
    • The order determines the display order from left to right

    c. In the Sort By dropdown list, select a column to sort the List View.

    d. In the Sort Direction dropdown list, select Ascending or Descending.

  6. In the Buttons & Actions pane, select the Buttons and Actions to include in the layout:

    Buttons Section:

    • Shows buttons displayed on top of the list of records
    • Select which buttons to include (e.g., New, Import, Export)
    • Use arrow buttons to move buttons between available and selected
    • Use up/down arrows to control button order
    • Description: "Buttons displayed on top of the list of records"

    Inline Actions Section:

    • Shows buttons shown in dropdown menu for each record
    • Select which actions appear in the per-record action menu (e.g., Edit, Delete, Clone)
    • Use arrow buttons to move actions between available and selected
    • Use up/down arrows to control action order
    • Description: "Buttons shown in dropdown menu for each record"
       
    Note: Visibility formulas only evaluate fields in the list layout. Buttons can have visibility formulas that determine whether they appear based on field values visible in the list.

  7. Click Save.

The list layout is now configured and will be used in the appropriate context.

Configuring Columns

Columns determine which fields are displayed in the list layout. Effective column configuration improves usability and helps users quickly identify and access records.

Column Selection Best Practices

  • Include identifying information: Always include the Name field and other key identifiers
  • Limit column count: Too many columns make lists hard to scan. Aim for 5-8 columns for most layouts
  • Show relevant data: Include fields that help users make decisions (Status, Owner, Date, Amount, etc.)
  • Consider screen size: Remember users may view lists on different screen sizes
  • Order logically: Place most important columns first (left to right)

Layout-Specific Column Recommendations

Home Tab:

  • Name (always first)
  • Status or Stage
  • Owner
  • Modified Date or Created Date
  • Key amount or date fields

Lookup Dialog:

  • Name (always first)
  • Key identifying fields (Type, Category, etc.)
  • Owner (helps users find records)
  • Fewer columns than Home Tab (3-5 is ideal)

Search:

  • Name (always first)
  • Record Type or Type field
  • Key identifier fields
  • Modified Date (shows recency)

Related List:

  • Name (always first)
  • Fields relevant to the relationship
  • Status or Stage
  • Key dates or amounts

Mini Layout (Card):

  • Name
  • 2-4 most important fields only
  • Keep it minimal for quick scanning

Configuring Sort Options

Sort configuration determines the default order in which records appear in the list.

Sort By Field

Select which field to use for sorting. Common choices include:

  • Name (alphabetical)
  • Created Date or Modified Date (most recent first with Descending)
  • Status or Stage (logical progression)
  • Amount or Priority (high to low or low to high)

Sort Direction

Ascending: A to Z, 0 to 9, oldest to newest Descending: Z to A, 9 to 0, newest to oldest

Common Patterns:

  • Name fields: Ascending (alphabetical)
  • Date fields: Descending (most recent first)
  • Amount fields: Descending (highest first)
  • Priority/Status: Based on your workflow

Configuring Buttons and Actions

Buttons and inline actions provide users with ways to perform operations on records.

List Buttons vs Inline Actions

List Buttons (displayed on top of list):

  • Apply to the list as a whole or create new records
  • Examples: New, Import, Export, Mass Update
  • Appear as prominent buttons above the record list
  • Typically perform actions that don't require selecting a specific record

Inline Actions (shown in dropdown for each record):

  • Apply to individual records
  • Examples: Edit, Delete, Clone, Custom detail actions
  • Appear in a dropdown menu next to each record
  • Provide quick access to record-specific actions

Button Visibility Formulas

Buttons can include visibility formulas that evaluate fields in the list layout. The button only appears if the formula evaluates to true.

Important: Visibility formulas only have access to fields included in the list layout columns. If your formula references a field not in the layout, the button will not appear.

Example Use Cases:

  • Show "Approve" button only for records with Status = "Pending"
  • Show "Close" button only for records owned by current user
  • Show "Escalate" button only for high-priority records

List Layout Examples

Example 1: Opportunity Home Tab

Purpose: Main view for sales team to see their opportunities.

Configuration:

  • Layout Type: Home Tab
  • Columns: Name, Account, Stage, Amount, Close Date, Owner
  • Sort By: Close Date
  • Sort Direction: Ascending
  • Buttons: New, Import
  • Inline Actions: Edit, Delete, Clone

Result: Sales team sees opportunities sorted by close date with key information visible.

Example 2: Contact Lookup Dialog

Purpose: Quick selection of contacts when filling lookup fields.

Configuration:

  • Layout Type: Lookup Dialog
  • Columns: Name, Account, Phone, Email
  • Sort By: Name
  • Sort Direction: Ascending
  • Buttons: New
  • Inline Actions: Edit

Result: Users can quickly find and select contacts with essential identifying information.

Example 3: Case Related List

Purpose: Show cases related to an account on the account detail page.

Configuration:

  • Layout Type: Related List
  • Columns: Case Number, Subject, Status, Priority, Created Date
  • Sort By: Created Date
  • Sort Direction: Descending
  • Buttons: New
  • Inline Actions: Edit, Delete

Result: Account detail page shows related cases sorted by newest first.

Example 4: Product Mini Layout (Card)

Purpose: Quick preview when hovering over product lookup links.

Configuration:

  • Layout Type: Mini Layout (Card)
  • Columns: Name, Product Code, List Price, Category
  • Sort By: Not applicable for Mini Layout
  • Buttons: Not applicable for Mini Layout

Result: Hovering over a product name shows key product details in a popup card.

Best Practices and Recommendations

  • Test each layout type: Create and test all six layout types for each entity to ensure consistent user experience.
  • Keep columns focused: Include only fields users need for decision-making in that context.
  • Optimize for performance: Fewer columns load faster, especially for entities with many records.
  • Consider user workflows: Design layouts based on how users actually work with the data.
  • Use consistent patterns: Apply similar column choices across related entities.
  • Update regularly: Review list layouts periodically as business processes evolve.
  • Minimize Mini Layouts: Show only 3-4 fields in Mini Layouts for quick scanning.
  • Sort strategically: Default sort should match user's most common use case.
  • Test button visibility: Ensure visibility formulas reference fields in the layout.
  • Coordinate with permissions: Remember users only see records they have permission to view.
  • Consider mobile users: Fewer columns work better on smaller screens.
  • Document custom layouts: Maintain notes on why specific layouts were configured.

Troubleshooting Tips

Issue: Buttons not appearing on list layout.

Solution: Check button visibility formulas to ensure they reference fields included in the list layout columns. Also verify that the button is in the "Selected" list for the layout.

Issue: List view showing blank columns.

Solution: Verify that users have field-level read permission for all columns configured in the layout. Users without field permission see blank values.

Issue: Lookup Dialog showing wrong records.

Solution: Check the sort order and columns configured in the Lookup Dialog layout. Also verify that lookup filters are not overly restrictive.

Issue: Mini Layout card not appearing on hover.

Solution: Verify that the Mini Layout has been configured with columns. If no Mini Layout exists, cards will not display.

Issue: Search results not showing entity records.

Solution: Ensure the entity is marked as searchable and that a Search layout has been configured. Also verify users have read permission on the entity.

Issue: Related list showing incorrect columns.

Solution: Check both the Related List layout and any customization done in the Layout Designer. Individual related lists can override the default layout.

Issue: Sort not working as expected.

Solution: Verify that the Sort By field is included in the columns and that the correct Sort Direction is selected.

Issue: Too many columns making list hard to read.

Solution: Reduce the number of columns to 5-8 for better readability. Consider which fields are truly essential.

Issue: Users cannot create custom list views.

Solution: Verify that users have appropriate permissions on the entity and that the List View layout has been configured.

Issue: Inline actions not working for some records.

Solution: Check if the button has a visibility formula that evaluates to false for those records. The formula might be filtering out the action based on field values.

See Also

Jump to Magentrix Entity Checklist

<< Configuring Field Security for Entities | Configuring Record Types >>


Privacy & Security StatementTerms & Conditions
Copyright © 2025 by Magentrix Corporation - All rights reserved.
Powered by Magentrix