IBM BPM, V8.0.1, All platforms > Create processes in IBM Process Designer > Create user interfaces for business processes

Stock content controls

Stock content controls are Coach Views that are included with IBM BPM. They are contained within the Content Management (SYSCM) toolkit.

For each stock control, the business object binding table lists the business object that the stock control uses for its data. The configuration options table lists the configuration options that are available on the Configuration page when you drop an instance of the stock control onto a Coach View layout. The definition configuration column contains the corresponding configuration options as they are defined in the Variables page of the stock control. You cannot edit the definition of a stock control, but you can edit instances of a stock control by setting their configuration options.

For each stock control instance, the configuration options are optional. The configuration options that you do not set use default values. The data binding is also optional. However, if you define a binding for an instance, it must match the type in the stock control definition. If the type of the business object does not match the type of the data binding defined for the Coach View, you receive a warning.


Document List

This stock control creates a list of Enterprise Content Management documents in the document repository found by a CMIS query.

Document List business object binding
Binding Description
ECMDocumentInfo (List) Each ECMDocumentInfo contains the URL for the document.

Document List configuration options
Instance Configuration Label Description Definition Configuration Option Default values
Allow create Select this option if the user can add a document to the Enterprise Content Management document repository. allowCreate(Boolean) false
Allow update Select this option to allow the user to update document content and properties allowUpdate(Boolean) false
Open in new window Select this option to open the document in a new browser window. openInNewWindow(Boolean) false
Number of results to show Set the maximum number of documents in a search result that the user can see in the list at any one time. numberOfResultsToShow(Integer) 10
Show all content

Select this option to show all documents. The Number of results to show sets the maximum number of documents in the list.

Clear this option to show the documents in a series of pages if the search result returns more than Number of results to show documents.

showAllContent(Boolean) false
Parent folder path Sets the path to the parent folder where users create or upload documents. parentFolderPath(String) None
Search (required) Specify the service used to search for documents in the Enterprise Content Management document repository.

You must provide a service. Use the Default ECM Search Service Ajax service provided in the Content Management (SYSCM) toolkit as a template. The default service shows an example of the expected input and output definition.

search(Service)

Input:

  • maxItems(Integer)
  • skipCount(Integer)
  • searchAllVersions(Boolean)

Output:

  • searchResult(ECMSearchResult)

None
Get all document versions Specify the service used to get all versions of a specific document in the Enterprise Content Management document repository. getAllDocumentVersions(Service)

Input:

  • documentId(ECMID)
  • serverName(String)

Output:

  • documents(ECMDocument)(List)

ECM Get All Document Versions in SYSCM
Get document Specify the service used to get a specific document in the Enterprise Content Management document repository. getDocument(Service)

Input:

  • documentId(ECMID)
  • serverName(String)

Output:

  • documents(ECMDocument)

ECM Get Document Service in SYSCM
Get type definition Specify the service used to get the type metadata of a document or folder in the Enterprise Content Management document repository. getTypeDefinition(Service)

Input:

  • objectTypeId(ECMID)
  • serverName(String)

Output:

  • typeDefinition(ECMObjectTypeDefinition)

ECM Get Type Definition Service in SYSCM
Get type descendants Specify the service used to get the descendants of a type in the Enterprise Content Management document repository. getTypeDescendants(Service)

Input:

  • objectTypeId(ECMID)
  • serverName(String)
  • depth(Integer)
  • includePropertyDefinitions(Boolean)

Output:

  • typeDefinitions(ECMObjectTypeDefinition)

ECM Get Type Descendants Service in SYSCM


Document Viewer

This stock control displays the contents of a document for a given URL

Document View business object binding
Binding Description
ECMDocumentInfo Contains the URL for a document.

Create user interfaces for business processes


Related reference:
Stock controls


Related information:
Building Coaches