Responsive Document Explorer view (deprecated)

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Use the Responsive Document Explorer view to display a list of documents and folders for a process instance that is stored in the BPM content store. You can configure a Responsive Document Explorer so that users can add, view, or delete individual folders, and add, view, checkout, download, and remove documents. The Document Explorer uses services to perform these functions.

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

When users open a coach that contains a Responsive Document Explorer instance, the instance displays the contents of its root folder. This root folder is called Documents; however the Responsive Document Explorer displays this name in a breadcrumb trail when you are browsing one of its sub-folders. The root folder for a Responsive Document Explorer instance is specific to that instance. Different instances can have different root folders and they can be anywhere in the content management system. The root folder for the Responsive Document Explorer is either:
  • Specified directly by identifying the specific folder using the Folder ID configuration option. If the folder is not on the default content management server, the Server name configuration option identifies the server that contains the folder.
  • Derived by identifying an instance ID, which has an associated folder and server in the content management system.
  • Derived from the human service context, which has an associated folder in the content management system.
There is an order of precedence to determining the root folder with a value in the Folder ID overriding any value in the Instance ID and any value in the Instance ID overriding using the human service context to derive the root folder.
The root folder contains folders and documents (files and their associated properties). The actual contents that any individual user sees in the Responsive Document Explorer what that user can do with the contents depends on the permissions that user has in the content management system. Assuming that they have the appropriate permissions, users can add new folders and documents. From the action menu of a folder or document, user can select an action to perform on that folder or document.
Table 1. Folder actions
Action Description
Open Displays the contents of the folder. The Responsive Document Explorer adds a breadcrumb trail so that the user can return to a parent folder.
Rename Renames the folder.
Delete or remove Deletes the folder or reference from the ECM server. Remove only deletes references from the Responsive Document Explorer. The reference remains on the ECM server.
Table 2. Document actions
Action Description
View Displays the contents of the document in the browser or, if the browser does not support the file format, downloads the document.
Download Downloads the document.
Properties Displays the properties associated with the document. The document type acts as a template to determine the properties that a give document has.
Check out Locks the file. After checking out a file, you can check in a different version of it or change its properties.
Check in or cancel check in Unlocks the file. Use the check in action to replace the file contents and update its properties. These actions are available only for locked files.
Delete Removes the document from the folder. The document still exists in the content management system.

Integrating with an Enterprise Content Management server

To integrate the Responsive Document Explorer with an Enterprise Content Management (ECM) server, the process application must have a connection to that server. See Adding an Enterprise Content Management server. For information about building ECM services, see Building a service that integrates with an ECM system or a BPM store. For additional information, see the topics under Enabling document support.

Restrictions and limitations

Restrictions
  • This view supports only the Required, Hidden, and None visibility properties.
Limitations
  • The Responsive Document Explorer view is available only for process instances.
  • If you are using the Responsive Document Explorer in process applications created before Business Automation Workflow 8.5.7, you must add the Responsive Coaches 8.5.7.0 toolkit (deprecated) to your application.

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.

Data binding

Set the data binding for the view in the General properties tab.
Table 3. Responsive Document Explorer data binding
Description Data type
Each ECMDocumentInfo contains the URL for the document. ECMDocumentInfo (List)

Configuration properties

Set or modify view configuration in the Configuration properties tab.
Table 4. Responsive Document Explorer view configuration properties
Configuration property Description Data type
Section title The title that is displayed in the section header. The default value is "Documents". String
Collapsible Indicates whether the section can be collapsed. Boolean
Collapsed Indicates whether the section is collapsed when the view opens. Boolean
Use Document Viewer By default, the document opens in a new browser tab. To open documents in a Document Viewer view that is bound to the same variable that this Responsive Document Explorer is, enable this option. Boolean
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.

 Boolean

Default: false (no refresh pending)
Default ECM document properties A list of ECMDefaultProperty objects. When users create an ECM document, the list contains the default values for the document properties. The values might be read-only or hidden from users when they create the document. ECMDefaultProperty (list)
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.processInstanceFolderId properties are used for the context. For heritage human services, tw.system.currentProcessInstance.id and tw.system.currentProcessInstance.processInstanceFolderId properties are used for the context.

 String

Default: (empty)
Folder Configuration > 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.processInstanceFolderId properties are used for the context. For heritage human services, tw.system.currentProcessInstance.id and tw.system.currentProcessInstance.processInstanceFolderId properties are used for the context.

 String

Default: (empty)
Folder Configuration > Server name If a Folder ID is configured, the name of the external ECM server. The server name can be typed into the field. You can also use a variable that represents the server name and add the variable to this field. For an external ECM server name, check the Process App Settings page for the external ECM systems available.

If you are working with the internal ECM content repositories - BPM managed store, BPM content store, or BPM document store - constants are available for them; for example, ECMServerNames.IBM_BPM_MANAGED_STORE.

String

Default: (empty)
BPM Document Upload Options > Add properties By default, properties are not added to new BPM documents. Enabling this configuration option adds the properties defined in the Upload properties configuration option. If you want to control when the properties are added to the document, bind this configuration option to a variable. Boolean
BPM Document Upload Options > Upload properties Lists the properties to add to a BPM document when it is being created when Add properties is enabled (true). NameValuePair
BPM Document Upload Options > Hide in Portal Prevents the document from being displayed in Portal. Boolean
Services > BPM content store search service The service that is used to search for folders and documents in the BPM content store.

The view builds the search query based on the values of the other configuration options for the view, 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)
Services > ECM add external reference service Adds an external document or folder reference to the BPM managed store. ECM Add external reference service
Input:
  • objectId (ECMID)
  • parentFolderId (ECMID)
  • referenceServerName (String)
  • referenceName (String)
  • serverName (String)
  • type (String)
The input parameters have no default value.

Output: None
Services > 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)
Services > ECM get type definition service The default service that returns the type definition for the document view. 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)
Services > 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)
Services > 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)
Services > ECM get folder by path service Gets a folder based on the specified path. ECM Get folder by path service
Input:
  • path (String)
  • serverName (String)
The input parameters have no default value.
Output:
  • folder (ECMFolder)
Services > Default get related ECM folders service Gets the root ECM folder information on all available servers in the current snapshot. Default get related ECM folders service
Input:
  • processInstanceId (String)
The input parameter has no default value.
Output:
  • folderInfos (ECMFolderInfo)(List)
Services > 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)
Services > 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
Services > 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
Services > ECM create folder service The service that creates the specified folder, with a given name, in the specified parent folder. The property sets the process 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)
Services > ECM remove folder service The service that removes a specified folder from a specified folder. Removing a folder unfiles the folder from the parent folder but does not delete it from the repository. ECM Remove folder service
Input:
  • parentFolderId (ECMID)
  • objectID (ECMID)
  • referenceServerName (String)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.

Output: None
Services > 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
Services > ECM delete document service Specify the service used to delete documents. Service
Input:
  • documentId(ECMID)
  • serverName(String)
  • allVersions(Boolean)
Services > ECM rename folder reference service The service that renames the folder reference (not the name of the folder on the ECM system). ECM Rename folder reference service
Input:
  • parentFolderId (ECMID)
  • folderId (ECMID)
  • folderServerName (String)
  • referenceName (String)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.

Output: None
Services > 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)
ServicesLocalization service The service that is used to retrieve the globalized strings for use with this view. ECM Localization Service
Instance Status Determines whether the Document Explorer is editable or read-only. ACTIVE instances are editable. Instances with different status values (COMPLETED, FAILED, TERMINATED, and SUSPENDED) are read-only. String
Hide Document Explorer Indicates whether the Document Explorer view is hidden, for example, for a BPD. Boolean
Calendar type Select the type of calendar to show when creating or showing documents:
  • Gregorian (default)
  • Hebrew
  • Islamic
 CalendarType
Style > Theme color type Set the color of the header and border according to a type defined in the theme. In the Classic theme in the System Data toolkit, the colors and types are:
  • Dark blue for primary (default)
  • White for alternate
  • Light blue for info
  • Green for success
  • Yellow for warning
  • Red for alert
 ThemeColors
Style > Header text size Set the size of the text in the header and the amount of padding between the text and the borders of the header. The default value is Medium. TextSizes