Minimum Software Version8.18.10
Solution(s)Cases International ✓ Cases US ✓ Institutions ⨉ Counsel ✓

The Worksheet portal component allows users to share structured worksheet data with portal users, enabling them to view and, where permitted, edit selected fields directly within the portal.


The Worksheet component presents data from an existing worksheet in a tabular format within the portal. It is ideal for sharing structured records such as procedural steps, statuses, or tracked events. Administrators control which worksheet is displayed, which metadata columns are visible, and which fields portal users are allowed to edit.

Portal users can view individual records in more detail and edit only the fields explicitly enabled, ensuring controlled collaboration while preserving data integrity.

Step 1: Prepare a Worksheet and Form

Before configuring the Worksheet component:

  1. Ensure the required worksheet has been created in the platform.
  2. Create at least one form view if record detail display is required.

Important:
A worksheet is mandatory. A form must exist before it can be selected for use.

Example:
Create a worksheet named “Procedural Steps” with fields for step name, responsible party, and status.

Step 2: Add a Worksheet Component

  1. Open the Portal Builder.
  2. Add the Worksheet component to the desired portal page.
  3. Open the Properties tab to begin configuration.

Step 3: Configure Worksheet Properties

Configure the following options in the Properties tab:

OptionExplanation
HeadingHeading text for the Worksheet component (maximum 100 characters).
WorksheetRequired. Select the source worksheet for the displayed data.
FilterApply filters such as date, party responsible, procedural step, status, date added, added by, date updated, or updated by.
FormSelect the form used to display detailed record views.
Columns to showChoose which metadata columns are visible to portal users.
Editable fieldsSelect fields that portal users are allowed to edit.
Primary sort field: FieldChoose a field for primary sorting.
Primary sort field: OrderSet sorting order as A–Z or Z–A.
HeightSet the display area to fit to content, at least half a page, or at least a full page.

Example:
Configure a Worksheet component titled “Case Status Tracker” showing step name and status, with status set as an editable field.

Step 4: Portal User Worksheet Experience

When viewed by portal users:

  • The heading appears at the top of the component
  • Worksheet records are displayed in a table format
  • Only selected columns are visible
  • Sorting and filtering rules determine the order and visibility of records

Portal users can:

  • Click on a record to view its details using the configured form
  • Click Edit to update fields that have been enabled as editable

Example:
A portal user opens a procedural step record and updates the status field from “Pending” to “Completed”.

Display example of 'worksheet' component:


Use the Worksheet component to present structured data clearly in the portal while enabling secure, controlled collaboration through editable fields.