The samples shown here are intended to give you a taste of what ECM programming is like using the Documentum platform. The samples all use Documentum Foundation Services (DFS). DFS can be used either as a local Java API, or consumed remotely as SOAP services. All of the samples shown here demonstrate remote consumption using the optional client productivity layer provided on the DFS SDK.
Using the client productivity layer as shown here is absolutely not required to consume DFS as a remote SOAP API. To find out how to consume the services using JAX-WS, for example, refer to the JAX-WS DFS Consumer Sample.
For more information about Documentum Foundation Services, refer to the DFS technical publications, which include:
- the Enterprise Content Services 6.5 SP1 Reference, which includes reference information and additional samples demonstrating service operations
- the Documentum Foundation Services 6.5 Development Guide, which includes tutorials to help you get started, more samples showing how to consume DFS without the productivity layer, information on how to create your own services, and more
Instantiate a Service
All of the samples require that you create a service context and a service instance. This sample shows a basic way of doing this. Some (not all) of the samples below assume that the service instance is stored as an instance variable.
Create an Object
The Object service Create operation creates a set of new repository objects based on the DataObject instances contained in a DataPackage passed to the operation.
Get an Object
The following example uses an ObjectId to reference a repository object and retrieves it from the repository.
Create Documents and Link to Folders
This sample creates a document and links it to a specific folder in the repository.
Create a Folder by Path
The createPath operation creates a folder structure (from the cabinet down) in a repository.
Delete an Object
The Object service delete operation deletes a set of objects from the repository.
Get Checkout Information
This example provides checkout information about the specified objects, specifically whether the objects are checked out, and the user name of the user who has them checked out.
Check an object in
The checkin operation checks in a set of repository objects using data contained in a DataPackage. It provides control over how the checked in object is versioned. It also controls the check-out and lock states of the object after the changes are versioned. Using this service, you can also apply symbolic version labels to checked‑in versions.
Get Version Information about an Object
The Object version operation provides information about a version of a repository object.
Perform a Passthrough Query
The Query service is a primary mechanism for retrieving information from a repository.