Responsive Document Viewer control (deprecated)

Use the control to display the contents of a document for a given URL.

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

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 an IBM BPM store. For additional information, see the topics under Enabling document support.

Data binding

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

Table 1. Responsive Document Viewer control data binding
Binding description	Data type
Contains the URL for a document.	`ECMDocumentInfo`

Configuration properties

Set or modify control configuration in the Configuration properties tab.

Table 2. Responsive Document Explorer control configuration properties
Configuration property	Description	Data type
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 Responsive Document Viewer control that is bound to the same variable that this Responsive Document Explorer is, enable this option. Important: The rendering of the document is delegated to the browser. Depending on your browser and its plug-ins, you might not be able to view some common file formats, such as Microsoft Office documents and TIFF image files. For files types that cannot be rendered by the browser, you can download them and try to view them outside of your browser. Alternatively, you could implement a custom coach view to render formats that are not supported by the browser. For a sample document viewer that supports a wide range of file formats, see the bpm-ui-Daeja Document Viewer project.	`Boolean`
Refresh trigger	Enables the contents of the control to be refreshed. Bind this property to the private variable that is used by the Refresh Controller control, the Refresh Button controls, or both controls. 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)
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 IBM® 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)`
Services > ECM add external reference service	Adds an external document or folder reference to the IBM 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 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)`
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
Localization service	The service that is used to retrieve the globalized strings for use with this coach view.	`ECM Localization Service`
Style > Theme color type	Set the color of the header and border according to a type defined in the theme. In the BPM 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`