documents-view

The <documents-view> business component displays the case documents associated with either a selected work item or a specified case.

The component's internal controller invokes the CaseDocumentService.fetchDocuments operation to provide the list of case documents.

If you want to customize the contents of the <documents-view> business component, see Customizing a Business Component for more information.

Usage

<documents-view
   case-ref="string"|selected-work-item="object"
   [template-path="string"]>
</documents-view>

Attributes

Name Type Description
case-ref String Case reference for which documents should be shown.
selected-work-item WorkItem object Currently selected work item
template-path String (Optional) Relative pathname of a custom template file to use in place of the internal template.
Note: case-ref and selected-work-item are mutually exclusive.

Example

The <documents-view> business component is used:

  • on the CASE DOCUMENTS tab of the Component Showcase application.
  • on the WORK ITEM DETAILS tabs of the Component Showcase application, or in the My Work App application (when you select a work item in a Work View, then click DETAILS in the footer menu, then click Documents). In both cases, <documents-view> is called from the work-item-detail-nav business component.
  • in the Case Management application, when you click Case Documents on the Case Menu for a case.