Use a service to allow a business process developed in IBM® Process
Designer to
work with an Enterprise Content Management system.
Before you begin
You should have added your Enterprise Content Management
(ECM) servers to your process application as shown in Adding an Enterprise Content Management server.
You should
add the Content Management (SYSCM) toolkit to your dependencies, if
it has not been added as you will need access to the ECM types. To
add this toolkit dependency, select + beside TOOLKITS.
In the Add dependency menu, select the Content
Management toolkit version you require.
About this task
To build an Enterprise Content Management service, follow
these steps:
Procedure
- Select any service from the library area that supports Content
Integration steps. The following services contain a Content
Integration step.
- Select Implementation in the library section
and then +. From the menu, select Integration
Service
- Select User Interface and then +.
From the menu, select Ajax Service.
- Select User Interface and then +.
From the menu, select Human Service.
Enter a name for the service on the following dialog box
and click Finish. The editor opens with the Diagram view
in focus.
- From the palette, drag a Content Integration step
to the canvas and provide a meaningful name for it.
- Click Implementation in the Properties view.
Under Enterprise Content Management Server, <Use
data mapping> is the default selection. It means that
in the Data Mapping tab section, the Server
name input map is enabled and editable. You can pass a
server name by using a variable in that field.
Alternatively,
select an Enterprise Content Management server from the list of known
servers in the Server field. These servers
are initially defined under Process App Settings (see Adding an Enterprise Content Management server). If there are no
entries in the list, then no servers have yet been specified. Add
a server to the list by clicking the Use Process Application
Settings to add a server link and adding a server in the Process
App Settings section.
- Under Content Operation, select
the appropriate operation.
- Add document to folder: Adds a document
to a folder.
- Cancel check-out document: Releases a document
from the check-out state, making it possible for other users work
with it.
- Check-in document: Checks in a document,
giving all users access to it.
- Check-out document: Checks out a document;
only the person who checked it out can use it.
- Create document: Creates a document.
- Copy document: Copies a document.
- Create folder: Creates a folder.
- Delete document: Deletes a document.
- Delete folder: Deletes a folder.
- Get all document versions: Gets all versions
of a document.
- Get documents in folder: Gets all documents
in a folder.
- Get document: Gets a document matching
a document identifier.
- Get document content: Gets a stream of
data that is the content of the document.
- Get folder: Gets a folder that matches
a folder identifier.
- Get folder by path: Gets a folder as determined
by a path to it.
- Get folder tree: Gets a set of folders
in an array.
- Get type definition: Gets the type definition
of a document or folder including its properties.
- Get type descendants: Gets the type definition
descendants as determined by the depth level.
- Move document: Moves a document from one
folder to another.
- Move folder: Moves a folder.
- Remove document from folder: Removes a
document from a folder.
- Set document content: Updates a document
with content.
- Search: Retrieves a set of document or
folder references according to a query. See Building a query for an Enterprise Content Management search operation.
- Update document properties: Updates the
properties of a document.
- Click Data Mapping. In this section
you can create the map between the variables for input and output.
These variables need to be created. You can create them manually by
yourself or use the auto-map function. The auto-map function creates
private variables for the business objects, which are used by the
service you create. Click the auto-map icon to create these private
variables.
The mapping structure for each operation
is discussed in Data mapping in Enterprise Content Management operations.
- Save your work to update the process application with any
changes to your service.
What to do next
As with any service, if you have errors at run time, use
catching error events to handle errors thrown by a content integration
step. A content integration step may raise an error with error code ECMError and
error data of type ECMError. See Handling errors
in services.