Configuring coach views for storing and viewing Enterprise Content Management documents
You can store and view documents on an ECM server from a client application, such as Process Portal, by configuring one of the documents coach views (Document Explorer or Document List view) and, optionally, a Document Viewer view.
Before you begin
- IBM® BPM document store
- IBM BPM content store
- An external ECM server
- Toolkit dependencies
- Because you need access to ECM types, ensure that the Content Management (SYSCM) toolkit is added to the dependencies for the process application. For the Document Explorer view, ensure that you also add the Dashboards toolkit to the dependencies.
- Custom search service (Document List view only)
- You must have an ECM service with a search operation that provides
a search result. This search result is used to
present a list of documents in the Document List view. For information
on how to create the ECM service, see Building a query for an Enterprise Content Management search operation.
The search service that you create must comply with the interface of the Document List view. The Default ECM Search Service Ajax service that is provided in the Content Management (SYSCM) toolkit shows an example of the expected input and output definition. The parameter names in your search service must be the same as the names used in the Default ECM Search Service Ajax service: maxItems, skipCount, searchAllVersions, and cmisQuery.
If you do not have a search service, you can create one when you configure the Document List view. The What to do next section describes how to create a simple search service.
About this task
Add one of the documents coach views to a coach to enable Process Portal users to store or view documents on an ECM server. All the following steps apply to both the Document Explorer view and the Document List, except when otherwise specified.
Procedure
What to do next
You might want to update bindings in the documents coach view by using a script, for example, because the values for the inputs to your search service changed. If you run a script to update the binding, you must change the previous value. In the following JavaScript example, the columns are updated by appending text that changes the older values.
tw.local.cmisQueryString = "SELECT cmis:name, cmis:objectId ";
if (tw.local.photoCatagory) tw.local.cmisQueryString = tw.local.cmisQueryString + ", PhotoCatagory";
if (tw.local.photoSubject) tw.local.cmisQueryString = tw.local.cmisQueryString + ", PhotoSubject";
if (tw.local.photoLocation) tw.local.cmisQueryString = tw.local.cmisQueryString + ", PhotoLocation";
if (tw.local.photoDate) tw.local.cmisQueryString = tw.local.cmisQueryString + ", PhotoDate";
tw.local.cmisQueryString = tw.local.cmisQueryString + " FROM acpPhoto";
tw.local.testCoachRefresh = tw.local.testCoachRefresh + "XYZ ";
The following steps show how to create a search service for the Document List view.
- To ensure that you have the correct input and output variables and types, copy the Default ECM Search Service to your process application.
- Rename the Default ECM Search Service to an appropriate name, for example, MySearch.
- Complete one of the following steps:
- If you configured the Document List view for the IBM BPM document store, configure the search operation that is defined in the existing IBM BPM documents Content Integration step.
- If you configured the Document List view for an external ECM server, then add a Content Integration step to the ECM documents path and configure the search operation with an Enterprise Content Management server.
- Use the auto-map function to create the map between the input and output service parameters and the variables.