Table of Contents

Web portal - Subviews

Overview

The Subviews page displays all subviews for a selected view. Each subview can be shown as a tab or joined data in the web portal. Use this guide to add, edit, remove, and reorder subviews to customize your portal views.

How to Configure Subviews

1. Add a New Subview

  • Click New or add a line in the Subviews section.
  • Use the Subview No. lookup to select a subview from available views.
  • Set the Subview Type (List, Form, Map) as needed.
  • The Display Name will auto-fill, but you can edit it.
  • Set API Multiplicity and Join Type if applicable.
  • Optionally, set Hide to prevent the subview from being shown in the portal.

2. Edit Subview Properties

  • Click on the subview to edit.
  • Change the Display Name for user-friendly labels or translations.
  • Adjust visibility using Hide.
  • Set or clear join and multiplicity options as needed.

3. Reorder Subviews

  • Use the Move Up and Move Down actions to change the sequence.
  • The order determines how subviews appear in the portal.

4. Translations

  • Use the Translations action to manage captions in different languages.

5. Advanced Settings

  • API Multiplicity: Controls how many related records are shown in the subview.
  • Join Type: Determines how data from the subview is joined to the main view.

Tips

  • Only valid subviews for the selected type (List, Form, Map) are available in the lookup.
  • Some properties are only editable depending on the subview type.
  • Use the lookup for Subview No. to avoid errors and ensure correct mapping.

Troubleshooting

  • If a subview does not appear, check its visibility settings and type.
  • For errors on joins or multiplicity, ensure the subview supports the selected options.
  • Use the ShowCaptions action if you encounter unexpected behavior with translations.

Example Workflow

  1. Add a new subview using the lookup.
  2. Set a user-friendly display name.
  3. Set API Multiplicity and Join Type as needed.
  4. Hide the subview if it should not be visible in the portal.
  5. Move the subview to the desired position.
  6. Add translations if needed.

Configure subviews for web portal views

Prerequisites

Before you begin, ensure you have:

  • Administrative access to the 3PL Web Portal
  • Understanding of your organization's data relationships

Add a new subview

To add a subview to a view:

  1. Click New or add a line in the Subviews section.
  2. Use the Subview No. lookup to select a subview from available views.
  3. Set the Subview Type (List, Form, Map) as needed.
  4. The Display Name auto-fills, but you can edit it for clarity or translation.
  5. Set API Multiplicity and Join Type if applicable.
  6. Optionally, set Hide to prevent the subview from being shown in the portal.

Edit subview properties

To modify a subview:

  1. Click on the subview to edit.
  2. Change the Display Name for user-friendly labels or translations.
  3. Adjust visibility using Hide.
  4. Set or clear join and multiplicity options as needed.

Reorder subviews

To change the order of subviews:

  1. Use the Move Up and Move Down actions to change the sequence.
  2. The order determines how subviews appear in the portal.

Manage translations

  • Use the Translations action to manage captions in different languages.

Advanced subview settings

  • API Multiplicity: Controls how many related records are shown in the subview
  • Join Type: Determines how data from the subview is joined to the main view

Best practices

  • Only valid subviews for the selected type (List, Form, Map) are available in the lookup
  • Some properties are only editable depending on the subview type
  • Use the lookup for Subview No. to avoid errors and ensure correct mapping

Troubleshooting

Use the following guidance to resolve common subview issues:

  • If a subview does not appear, check its visibility settings and type
  • For errors on joins or multiplicity, ensure the subview supports the selected options
  • Use the ShowCaptions action if you encounter unexpected behavior with translations

Example scenarios

  1. Add a new subview using the lookup
  2. Set a user-friendly display name
  3. Set API Multiplicity and Join Type as needed
  4. Hide the subview if it should not be visible in the portal
  5. Move the subview to the desired position
  6. Add translations if needed
Edit this page