Table of Contents

Web Portal - List Views

How to Set Up a Web Portal List View

Step 1: Create a New View

  1. Navigate to the 3PL Web Portal View page
  2. Click on one of the "New" actions:
    • New List View - for tabular data display

Step 2: Configure Basic Settings

General Information

  • View No.: Unique identifier for the view bases on the number serie
  • Display Name: User-friendly name shown in the portal
  • Category Code: Organize views into logical groups
  • Published: Make the view available to users

API Settings

  • Endpoint: Select the Business Central API endpoint to use
  • View Page Size: Set maximum records per page (default: 100)
  • Cache TTL: Configure caching duration (5 minutes to 24 hours)

Step 3: Set Up Data Access

Dynamic Filtering

Configure automatic data filtering based on user context:

  • Access Filter Type: Choose from Customer, Address, Shipping Agent, User ID, or Web Portal Role
  • Access Filter On: Select the field to apply the filter to

Default Sorting

  • Sort On: Choose the default sorting field
  • Sort Descending: Set sort direction

Step 4: Configure View-Specific Settings

For List Views:

  • Set up fields to display in the Fields section
  • Configure actions and file attachments in Page Details
  • Define sub-views for related data
Page Details Configuration:

The Page Details section is crucial for List Views as it allows you to enhance functionality by linking to predefined objects:

Files Management:

  • File Count: Shows the number of file object configurations for this view
  • Click on the File Count field to open the file configuration where you can:
    • Object ID: Link to specific Business Central Record Link objects (reports, documents, attachments)
      • Enter the ID of a Business Central Record Link object
    • Download: Check to allow users to download files with this Object ID
    • Image: Check to show image previews for supported file types (.jpeg , .png)

Note: Object IDs must reference existing Record Link attachments in Business Central. These are typically documents, reports, or files that have been attached to records. Files with Object ID '0' will not be shown.

Actions Management:

  • Action Count: Shows the number of predefined actions linked to this view
  • Click on the Action Count field to open the action configuration where you can:
    • Action No.: Link to predefined Web Portal Actions (must be set up separately)
    • Sequence: Set the order in which actions appear
    • Condition Type: Define when the action should be visible (None, Equals, IsNotEmpty)
    • Condition OData Field Name: Field to check for the condition
    • Condition Value: Value to compare against (for Equals condition)
    • Show on List: Control whether the action appears in list views

Important Note: Both Files and Actions reference predefined objects that must be configured separately in the system. The Page Details section only links existing Action definitions and Object IDs to your specific view.

Step 5: Configuring Fields and Subviews

  1. Click to see how to conigure Fields

  2. Click to see how to configure Subviews

    • For example Customer Items (Document Lines) in a Receipt or Shipment.
    • For example the goods on an tms-order.

Step 6: Test and Publish

  1. Use the Test action to verify your configuration
  2. Check data access and filtering
  3. Verify performance and caching
  4. Set Published to Yes to make available to users
Edit this page