You configure the Content List widget to indicate how the widget retrieves the list of documents that are to be displayed.
Before you begin
You can configure the Content List widget to retrieve a list of documents:
- From a property list
- By running a Workplace XT stored search
A property list provides a list of the document IDs that the Content List widget uses to retrieve documents. The list is contained in the Display documents event that is received from a custom widget.Stored search
A stored search is a file containing the criteria that the Content List widget is to use to retrieve documents.
You create this file by using the Workplace XT Search Designer tool.
You can wire the Content List widget to substitute values in the stored search criteria. If you do, the widget retrieves and displays documents based on data that it receives from a published event. For example, you can configure the Content List widget to substitute the criteria values that are defined in the stored search. You can substitute these values with work item field values that are published by the In-basket widget or Step Completion widget. You can also substitute values with key-value pairs that are published by a custom widget.
If you want to substitute search criteria with event data at run time, you must set the stored search criteria as editable conditions. If you do not wire the Content List widget to substitute stored search criteria, the widget retrieves documents based on the predefined search criteria.
You will need the URL for the stored search when you configure the Content List widget. To obtain the URL:
- In Workplace XT, locate the stored search that you want to use.
- Right-click the stored search, select More Actions, then select Show Hyperlink to display the URL for the stored search.
- In the Show Hyperlink dialog box, select the appropriate stored search version. The URL for the stored search is displayed.
- Copy the displayed URL.
The Content List widget does not support certain MIME types that are specific to Workplace and Workplace XT. The widget does not display these document types correctly and, as a result, users might encounter errors when they attempt to open the documents. To avoid these errors, use a stored search that excludes the following MIME types:
application/x-filenet-customobjectentrytemplateIBM® Enterprise Records records
application/x-filenet-search Workflow-related files
About this task
To configure the Content List widget:
- Change to edit mode and then click Edit Settings on the widget menu.
- Click the Content Display tab.
- Select the method for populating the Content List widget:
|Property list||The Content List widget will retrieve documents by using the list of document IDs received in the Display documents event.|
|Stored search||The Content List widget will retrieve documents by running the specified stored search. To specify the stored search, paste the URL that you copied from Workplace XT in the Stored search URL field.|
- Set the other configuration options:
|Number of items to display per page||Indicates the number of documents that are to be displayed on a page within the Content List widget. By default, 15 documents are displayed.|
|Open documents in a separate browser window||Displays document content in a separate browser window when a user double-clicks a document in the search results. |
If you do not selected, the widget displays the document content in a viewer widget if a viewer widget is included on the page.
Restriction: Do not select this option if there is a viewer widget on the page.
You can use the Viewer widget provided with ECM Widgets or use a viewer from an independent software vendor.
What to do next
If you configured the Content List widget to use a property list, manually wire the Content List widget to the custom widget that publishes the Display documents event that provides the list.
If you configured the Content List widget to use a stored search that contains editable search criteria, manually wire the Content List widget to the widget that publishes the dynamic event data.
Parent topic: Configuring the Content List widget : ECM Widgets 126.96.36.199
Customizing the widget popup menu : ECM Widgets 188.8.131.52
Search creation process