Create custom tabs based on OData query filter

Prerequisite: You must have the CONFIGADM access code to configure the detail pages and create custom tabs.

You can create custom tabs for cases, documents, contacts, or custom types based on a manually inserted OData query filter, and add these custom tabs to the case, document, contact, or custom type detail pages. This way you can create advanced dynamic filters with as many conditions as you need applicable to the context of your current WorkZone item. See Querying data with OData for more information about OData queries.

  • After you create a custom tab, it will become available to all the other WorkZone users.
  • After you create a custom tab and add it to a detail page, it will be displayed for all the other WorkZone items of the same category.
  • You can update your OData filter at any time (this is done in the edit configuration mode).

Create a custom tab based on OData query filter

  1. In the Home ribbon, click Settings > Edit configuration.
  2. In the Edit configuration dialog > Select configuration to edit field, select an organizational configuration and click Edit.
  3. Open a detail page, for example, the case detail page. If you want to add custom tab with an OData query to the detail page of a document, contact, or custom type, make your changes on the document detail page, the contact detail page, or the custom type detail page, respectively.
  4. In the detail ribbon, click Select tabs to view > Add new tab > Advanced filter.
  5. In the Define advanced OData filter for custom tab dialog, fill in the relevant fields:
    • Collection to list items from: Select a collection of WorkZone items to which your filter should apply.
    • OData filter string: Enter your OData query as a code string.

      Lets say that you want to see all cases that have the same parties as your current case. Then, you need to select Cases under Collection to list items from, and use a code string, such as: "Parties/any(a: a/Name/Files/any(b: b/FileKey_Value eq '${Context.ID}'))".

    • OData filter preview: Preview your filter (context from your current item will be applied automatically).
    • Context preview: Click to see properties applied by the context.
    • Check filter: Click to see the items matching your filter.
  6. Click Save.
  7. In the Add tab dialog, enter the Tab name for your custom tab and click Save.
    • Optionally, select the Display counter check box to show the number of items matching your filter.
  8. Click Save to save your changes.
  9. In the Tab selector dialog, drag your newly created custom tab from the left (red) pane to the right (green) pane. You can also click on your newly created custom tab to add it to the right (green) pane.
  10. Click Save. Your custom tab will be available to all items of the same category (matching your selection from step 3).

Edit the OData query filter for an existing custom tab

  1. In the Home ribbon, click Settings > Edit configuration.
  2. In the Edit configuration dialog > Select configuration to edit field, select an organizational configuration and click Edit.
  3. Open the detail page with a custom tab containing OData query.
  4. In the detail ribbon, click Select tabs to view.
  5. In the Tab selector dialog, click on the custom tab containing OData query, and select Edit filter.
  6. In the Define advanced OData filter for custom tab dialog, make the needed changes and click Save.

See Also