Portal Widget: Work item portal pane

Was this article helpful?

The Work item portal pane widget displays the portal page of another work item inside the current page. From Clio Operate 7.13, end-users can select a row in a list view and work on that work item in the pane. They do not leave the page that they are on.

A typical page has a list of child work items on one side and the pane on the other. For example, a matter page lists its proceedings. When the user selects a proceeding, the pane displays the proceeding's page, with its page tabs and its actions.

[SCREENSHOT: A matter page with a list of proceedings on the left and the Work item portal pane on the right, displaying the selected proceeding. Alt text: "A matter page with a list of proceedings beside a pane that displays the selected proceeding."]

Before you start

  • You need access to Modeller, to edit portal pages in the portal designer.
  • The work items that the pane displays must have a portal page of their own.
  • Decide which list will drive the pane. The list scope must return work items with their own portal pages, such as proceedings or matters.
  • No portal includes the pane by default. You must add it to a page yourself.

How the pane and a list view work together

The pane displays one work item at a time. It finds out which work item to display in one of two ways:

  • From a list view. The list view and the pane share a topic. When the user selects a row, the list view broadcasts the selection on that topic, and the pane displays the work item.
  • From its own settings. Specific work item pins the pane to one work item. The pane then ignores every list on the page.

A topic is a name that two or more widgets share, so that they exchange events only with each other. Widgets on the same page can use different topics, for example to pair two lists with two panes.

Add a list view and a pane to a page

  1. In Modeller, navigate to Forms and views > Portal editor.
  2. Select the portal of the parent work type, then select Design on the page that you want to change.
  3. Add a List view widget to a zone, and choose its list scope.
  4. In the settings of the list view, turn on Select row instead of opening it.
  5. Optional: turn on Select the first row automatically, so that the pane is filled when the page opens.
  6. Add a Work item portal pane widget to another zone.
  7. Leave Specific work item empty in the settings of the pane.
  8. On the page canvas, select the checkbox on the list view and on the pane.
  9. On the ribbon, select Set topic.
  10. Select an existing topic, or enter a name in Or a new topic and select Apply.
  11. Save the page.

When an end-user selects a row in the list, the pane displays that work item. Double-clicking a row still opens the work item on its own page.

[SCREENSHOT: The page canvas with a list view and a Work item portal pane selected, and the Set topic dialog open. Alt text: "The Set topic dialog, listing existing topics, No topic, and a box for a new topic."]

You can also set the topic on each widget separately. Open the settings of the widget and enter the same name in Topic name, in the Messaging section. In the settings of the pane, the same topic as a list view link opens the Messaging section.

 

Pin the pane to one work item

Pin the pane when the page always relates to the same work item, for example a single linked proceeding.

  1. Open the settings of the Work item portal pane widget.
  2. In Specific work item, enter the ID of the work item.
  3. Save the page.

On a work type portal, you can enter a tag instead of an ID. Select the tag icon on Specific work item, then pick the value in the Context Browser, for example Work Item > Id. The pane resolves the tag against the work item whose page it is on. On a global portal page, there is no tag icon, and the field takes an ID only.

Settings for the Work item portal pane

The settings of the pane are in three sections: Work item, Display and Zones.

Work item

Setting Default Description
Specific work item Empty Pins the pane to one work item, by ID or by tag. Leave it empty for the pane to follow a list view selection.
Page to show Empty The system name of a page in the portal of the work item. Leave it empty to display the default page. The name can contain letters, numbers, hyphens and underscores only. If it contains anything else, the field displays in red and the pane displays the default page.

Display

Setting Default Description
Show header On Displays the title of the work item, its type, its phase and its reference where it has one. The header also has an Open full page icon, which opens the work item on its own page.
Hide this widget's title bar On Displays only when Show header is off. Without a header, the title bar of the widget is the only heading on the pane. Turn this setting on for a pane with no heading. When Show header is on, the title bar is always hidden.
Show work item actions On Displays the ribbon commands of the work item as buttons in the pane. Commands with options display as a menu.
Show page tabs On Displays the portal pages of the work item as tabs. Selecting a tab changes the page inside the pane.
Stay on same page when changing work item context Off Displays only when Show page tabs is on. When the user selects another work item, the pane stays on the page that the user was viewing. If the new work item does not have that page, the pane displays its default page.
Fill available height On Extends the pane to the bottom of the browser window, so that the page does not jump when the selection changes. When the setting is off, the pane is only as tall as its content.
Empty state message "Select a work item to see its portal" The message that displays before the user selects a work item.
Empty state icon A hand pointer The icon that displays with the empty state message.

Zones

A portal page places widgets in zones. The pane leaves out page furniture, such as menus, hero banners and the radar, because it draws its own header, actions and tabs.

Setting Default Description
Zones to show Empty A comma-separated list of the zones to display, in the order that you want them. When you list zones here, the pane displays only those zones and ignores Zones to exclude. Leave it empty to display all the content zones of the page.
Zones to exclude nav, top-menu, hero, hero-nav, above-nav, radar, above-radar A comma-separated list of zones to leave out. The pane uses this setting only when Zones to show is empty. For a standard page layout, the pane also leaves out every zone outside the content area of the layout, such as a logo zone.

[SCREENSHOT: The settings of the Work item portal pane, with the Work item, Display and Zones sections expanded. Alt text: "The settings of the Work item portal pane, in three sections: Work item, Display and Zones."]

What end-users see

  • Before the user selects a row, the pane displays the empty state message.
  • When the user selects a row, the row is highlighted, and the pane displays the work item. The page does not navigate.
  • The widgets in the pane display the work item in the pane, not the work item whose page the user is on. Edits from these widgets, such as a key date or a participant, save to the work item in the pane.
  • The actions in the pane work in the same way as on the full page of the work item. After a phase change, the header displays the new phase.
  • The layout of the pane follows the width of the pane, not the width of the browser window. In a narrow zone, the content stacks into one column.
  • To open the work item on its own page, the user selects the Open full page icon. Ctrl-click or middle-click opens it in a new browser tab.
  • The selection is not kept. If the user reloads the page, or comes back from the full page, the pane returns to its empty state or to the first row.

Messages in the pane

Message Cause
"You do not have permission to see this item." The user does not have permission to view the selected work item. The pane displays no header, actions or tabs.
"This item has no 'page name' page." The work item does not have the page that Page to show names. The message gives the page name.
"This item could not be opened here." The work item has no portal page, or the ID in Specific work item does not match a work item.
"This pane's work item could not be found." The value in Specific work item is not a work item ID, or its tag did not resolve to one.

Troubleshoot the pane

If the pane does not change when the user selects a row, check these settings:

  • The topic is exactly the same on the list view and the pane, with no trailing space.
  • Specific work item on the pane is empty.
  • Select row instead of opening it is on for the list view.

If a saved change to the page does not display, reload the page. If the change still does not display, ask your administrator to clear the configuration cache.

Some widgets and panels opened from inside the pane can act on the wrong work item. They use the work item whose page the user is on, instead of the work item in the pane. If you find one, contact Clio Operate support and name the widget.

Was this article helpful?

Related articles

Related articles in the knowledge base