Heritage Document Explorer control (deprecated)

Use the control to display a list of documents and folders for a case instance that are stored in the BPM content store. You can set configuration options so that users can view, add, or delete individual folders, check documents in and out of the content store, and view, add, or delete documents.

For information about how to map deprecated functions to UI functions, see the topic Mapping deprecated functions to UI functions.

To run a process that uses the Basic Case Management feature to manage documents and folders, you must have installed the Basic Case Management feature from a previous release.

Restrictions and limitations

Restrictions

This view supports only the Required, Hidden, and None visibility properties.

Limitations

This control is available only for case instances. To display a list of documents for process instances, use the Heritage Document List control.

Data binding

Set the data binding for the control in the General properties tab.

Table 1. Heritage Document Explorer data binding
Description	Data type
Each `ECMDocumentInfo` contains the URL for the document.	`ECMDocumentInfo (List)`

Configuration properties

Set or modify control configuration in the Configuration properties tab.

Table 2. Heritage Document Explorer control configuration properties
Configuration property	Description	Data type
Section title	The title that is displayed in the section header.	`sectionTitle (String)` Default: "Documents"
Collapsible	Indicates whether the section can be collapsed.	`collapsible (Boolean)` Default: `false` (not collapsible)
Collapsed	Indicates whether the section is collapsed when the view opens.	`collapsed (Boolean)` Default: `false` (not collapsed)
Folder ID	Displays the list of documents and folders for the folder ID. If this property is configured, the instance ID is ignored. If the Folder ID property is not configured, the folder ID is derived from the associated Instance ID configuration. If an instance ID is not specified, the folder ID is derived from the human service context. For client-side human services, the `tw.system.processInstance.id` and `tw.system.processInstance.caseFolderId` properties are used for the context. For heritage human services, `tw.system.currentProcessInstance.id` and `tw.system.currentProcessInstance.caseFolderId` properties are used for the context.	`folderId (String)` Default: (empty)
Refresh trigger	Enables the contents of the view to be refreshed. Bind this property to the private variable that is used by Refresh Controller, Refresh Button, or both. When the value of the bound variable changes to `true`, the view is refreshed. After the view is refreshed, the value of the variable returns to `false`.	`refreshTrigger (Boolean)` Default: `false` (no refresh pending)
Instance ID	Displays the list of documents and folders for the instance ID. If the Folder ID property is configured, the Instance ID configuration is ignored. If neither the Folder ID nor the Instance ID properties are configured, the folder ID is derived from the human service context. For client-side human services, the `tw.system.processInstance.id` and `tw.system.processInstance.caseFolderId` properties are used for the context. For heritage human services, `tw.system.currentProcessInstance.id` and `tw.system.currentProcessInstance.caseFolderId` properties are used for the context.	`instanceId (String)` Default: (empty)
Content Store Search Service	The service that is used to search for folders and documents in the BPM content store. The control builds the search query based on the values of the other configuration options for the control, and then passes the query to the search service.	`Content Store Search Service` Input: `maxItems(Integer)` `skipCount(Integer)` `searchAllVersions(Boolean)` `cmisQuery (String)` The input parameters have no default values. Output: `searchResult(ECMSearchResult)`
ECM Get document service	The default service that returns the document.	`ECM Get document service` Input: `documentId (ECMID)` `serverName (String)` The name of the ECM Server repository. The input parameters have no default values. Output: `document (ECMDocument)`
ECM Get type definition service	The default service that returns the type definition for the document control.	`ECM Get type definition service` Input: `objectTypeId (ECMID)` `serverName (String)` The name of the ECM Server repository. The input parameters have no default values. Output: `typeDefinition (ECMObjectTypeDefinition)`
ECM Get type descendants service	The service that returns a list of type descendants to a given depth.	`ECM Get type descendants service` Input: `objectTypeId (ECMID)` Used to pass the `documentClassId` `serverName (String)` The name of the ECM Server repository. `depth (integer)` Sets the descendants hierarchy depth. The default value is `-1`. `includePropertyDefintions (Boolean)` Output: `typeDefinitions (ECMObjectTypeDefinition)(List)`
ECM Get folder service	The service that returns a folder.	`ECM Get folder service` Input: `folderId (ECMID)` `serverName (String)` The name of the ECM Server repository. The input parameters have no default values. Output: `folder (ECMFolder)`
ECM Check In Document Service	The service that is used to check in a document.	`ECM Check In Document Service` Input: `checkedOutId (ECMID)` The ID of the working copy of the document that is checked out. `properties (ECMProperty ( List))` The list of document properties. `serverName (String)` The input parameters have no default values. Output: `documentId (ECMID)`
ECM Check-Out Document Service	The service that is used to check out a document from the specified server.	`ECM Check-Out Document Service` Input: `documentId (ECMID)` `serverName (String)` The input parameters have no default values. Output: `checkedoutId (ECMID)`
ECM Cancel checkout service	The service that is used to cancel the check out a document from the specified server.	`ECM Cancel checkout service` Input: `documentId (ECMID)` `serverName (String)` The name of the ECM Server repository. The input parameters have no default values. Output: None
ECM Remove document service	The service that removes a specified document from a specified folder. Removing a document unfiles the document from the folder but does not delete it from the repository.	`ECM Remove document service` Input: `documentId (ECMID)` `folderID (ECMID)` `serverName (String)` The name of the ECM Server repository. The input parameters have no default values. Output: None
ECM Create folder service	The service that creates the specified folder, with a given name, in the specified parent folder. The property sets the case subfolder ID.	`ECM Create folder service` Input: `objectTypeId(ECMID)` `parentFolderId (ECMID)` `folderName (String)` `serverName (String)` The name of the ECM Server repository. The input parameters have no default values. Output: `newFolderID (ECMID)`
ECM Delete folder service	The service that permanently deletes folders.	`ECM Delete folder service` Input: `folderId (ECMID)` `serverName (String)` The name of the ECM Server repository. The input parameters have no default values. Output: None
ECM Update folder properties service	The service that updates folder properties, for example, renaming the folder.	`ECM Update folder properties service` Input: `folderId (ECMID)` `serverName (String)` The name of the ECM Server repository. `name (String)` The input parameters have no default values. Output: `modifiedFolderId (ECMID)`
Localization Service	The service that is used to retrieve the globalized strings for use with this coach view.
Hide Document Explorer	Indicates whether the Document Explorer control is hidden, for example, for a BPD.
Instance Status	Determines whether the Document Explorer that is displayed in the view is in read-only mode.

Customizing the Heritage Document Explorer coach view

You can customize the Heritage Document Explorer coach view in the following ways:

Customize the header of the section in the following ways:
- Change the name of the section by updating the Section title configuration property
- Change the expand and collapse behavior of the view by updating the Collapsible and Collapsed configuration properties
Modify resource strings in the Localization Service resource file, for example, to change the title of the section
Modify the style settings in the .css file