Skip to content

Documentum Connector Example

Documentum Connector can be used to perform operations on OpenText Documentum Enterprise content management system.

What you'll build

This example explains how to use Documentum Connector to create a folder and retrieve cabinet details from Documentum. The user sends a payload with the repository name, parent folder ID and name of the folder to be created. Then the connector communicates with Documentum to create a folder under the parent folder in the specified cabinet.

The example consists of an API named as Documentum API with two resources create folder and get cabinets.

Create Folder /createfolder: The user sends the request payload which includes the repository, parent folder ID and folder name. This request is sent to the integration runtime by invoking the Documentum API. It will create the new folder in Documentum under the parent folder given.

Get Cabinets /getcabinets: The user sends the request payload, containing the repository name to list cabinets present under that in Documentum. This request is sent to the integration runtime where the Documentum Connector API resides. Once the API is invoked, it returns the list of cabinets.

Create Document /createdocument: The user sends the request payload which includes the folder ID and document name. This request is sent to the integration runtime where the Documentum Connector API resides. Once the API is invoked, it will create the new Document in Documentun under the given folder ID.

The following diagram shows the overall solution.

Documentum connector example

If you do not want to configure this yourself, you can simply get the project and run it.

Configure the connector in WSO2 Integration Studio

Connectors can be added to integration flows in WSO2 Integration Studio. Once added, the operations of the connector can be dragged onto your canvas and added to your resources.

Import the connector

Follow these steps to set up the Integration Project and the Connector Exporter Project.

  1. Open WSO2 Integration Studio and select New Integration Project to create an Integration Project. Creating a new Integration Project

  2. Right-click the project that you created and click on Add or Remove Connector -> Add Connector. You will get directed to the WSO2 Connector Store.

  3. Search for the specific connector required for your integration scenario and download it to the workspace. Search Connector in the Connector Store

  4. Click Finish, and your Integration Project is ready. The downloaded connector is displayed on the side palette with its operations.

  5. You can drag and drop the operations to the design canvas and build your integration logic. Drag connector operations

  6. Right click on the created Integration Project and select New -> Rest API to create the REST API.

Now the connector is added to the palette.

Configure a Proxy Service

  1. Right click on the project and go to New -> Proxy Service.

  2. Select Create A New Proxy Service from the options that appear and click Next.

  3. Provide a name for the proxy service and click Finish.

  4. Add the following configuration to the source view of the project.

    <?xml version="1.0" encoding="UTF-8"?>
    <proxy name="documentum_createfolder" startOnLoad="true" transports="http https" xmlns="">
                <property expression="json-eval($.repo)" name="repo" scope="default" type="STRING"/>
                <property expression="json-eval($.objectcodeID)" name="objectcode" scope="default" type="STRING"/>
                <property expression="json-eval($.foldername)" name="foldername" scope="default" type="STRING"/>

You can see the newly added connector in the design palette.

Documentum proxy

Configure the connection and create folder operation

  1. Do the following configurations to initialize the connector. Documentum connection

  2. Do the following configurations to set up the create folder operation. Documentum create folder

Now we can export the imported connector and the API into a single CAR application. CAR application is the one we are going to deploy to server runtime.

Exporting Integration Logic as a CApp

CApp (Carbon Application) is the deployable artifact on the integration runtime. Let us see how we can export integration logic we developed into a CApp along with the connector.

Creating Connector Exporter Project

To bundle a Connector into a CApp, a Connector Exporter Project is required.

  1. Navigate to File -> New -> Other -> WSO2 -> Extensions -> Project Types -> Connector Exporter Project.

    Add Connector Exporter Project

  2. Enter a name for the Connector Exporter Project.

  3. In the next screen select, Specify the parent from workspace and select the specific Integration Project you created from the dropdown.
    Naming Connector Exporter Project

  4. Now you need to add the Connector to Connector Exporter Project that you just created. Right-click the Connector Exporter Project and select, New -> Add Remove Connectors -> Add Connector -> Add from Workspace -> Connector.

  5. Once you are directed to the workspace, it displays all the connectors that exist in the workspace. You can select the relevant connector and click Ok.

    Selecting Connector from Workspace

Creating a Composite Application Project

To export the Integration Project as a CApp, a Composite Application Project needs to be created. Usually, when an Integration project is created, this project can be created as part of that project by Integration Studio. If not, you can specifically create it by navigating to File -> New -> Other -> WSO2 -> Distribution -> Composite Application Project.

Exporting the Composite Application Project

  1. Right-click the Composite Application Project and click Export Composite Application Project.

    Export as a Carbon Application

  2. Select an Export Destination where you want to save the .car file.

  3. In the next Create a deployable CAR file screen, select both the created Integration Project and the Connector Exporter Project to save and click Finish. The CApp is created at the specified location provided at the previous step.

    Create a deployable CAR file

Now the exported CApp can be deployed in the integration runtime so that we can run it and test.

Get the project

You can download the ZIP file and extract the contents to get the project code.

Download ZIP


You may need to update the simulator details and make other such changes before deploying and running this project.


Follow these steps to deploy the exported CApp in the integration runtime.

Deploying on Micro Integrator

You can copy the composite application to the <PRODUCT-HOME>/repository/deployment/server/carbonapps folder and start the server. Micro Integrator will be started and the composite application will be deployed.

You can further refer the application deployed through the CLI tool. See the instructions on managing integrations from the CLI.

Click here for instructions on deploying on WSO2 Enterprise Integrator 6
  1. You can copy the composite application to the <PRODUCT-HOME>/repository/deployment/server/carbonapps folder and start the server.

  2. WSO2 EI server starts and you can login to the Management Console https://localhost:9443/carbon/ URL. Provide login credentials. The default credentials will be admin/admin.

  3. You can see that the API is deployed under the API section.


Create folder operation

  1. Open Postman and use a POST operation with the following sample request payload, then click on Send.


  2. You will see the following sample response payload.

        "properties": {
            "authors": null,
            "keywords": null,
            "a_application_type": "",
            "a_status": "",
            "r_creation_date": "2020-07-17T04:30:56.000+00:00",
            "r_modify_date": "2020-07-17T04:30:56.000+00:00",
            "r_modifier": "appowner",
            "r_access_date": null,
            "a_is_hidden": false,
            "i_is_deleted": false,
            "a_retention_date": null,
            "a_archive": false,
            "a_compound_architecture": "",
            "a_link_resolved": false,
            "i_reference_cnt": 1,
            "i_has_folder": true,
            "i_folder_id": [
            "r_composite_id": null,
            "r_composite_label": null,
            "r_component_label": null,
            "r_order_no": null,
            "r_link_cnt": 0,
            "r_link_high_cnt": 0,
            "r_assembled_from_id": "0000000000000000",
            "r_frzn_assembly_cnt": 0,
            "r_has_frzn_assembly": false,
            "resolution_label": "",
            "r_is_virtual_doc": 0,
            "i_contents_id": "0000000000000000",
            "a_content_type": "",
            "r_page_cnt": 0,
            "r_content_size": 0,
            "a_full_text": true,
            "a_storage_type": "",
            "i_cabinet_id": "0c0277b68002952c",
            "owner_name": "appowner",
            "owner_permit": 7,
            "group_name": "docu",
            "group_permit": 5,
            "world_permit": 4,
            "i_antecedent_id": "0000000000000000",
            "i_chronicle_id": "0b0277b6800584f7",
            "i_latest_flag": true,
            "r_lock_owner": "",
            "r_lock_date": null,
            "r_lock_machine": "",
            "log_entry": "",
            "r_version_label": [
            "i_branch_cnt": 0,
            "i_direct_dsc": false,
            "r_immutable_flag": false,
            "r_frozen_flag": false,
            "r_has_events": false,
            "acl_domain": "appowner",
            "acl_name": "dm_450277b680000101",
            "a_special_app": "",
            "i_is_reference": false,
            "r_creator_name": "appowner",
            "r_is_public": true,
            "r_policy_id": "0000000000000000",
            "r_resume_state": 0,
            "r_current_state": 0,
            "r_alias_set_id": "0000000000000000",
            "a_effective_date": null,
            "a_expiration_date": null,
            "a_publish_formats": null,
            "a_effective_label": null,
            "a_effective_flag": null,
            "a_category": "",
            "language_code": "",
            "a_is_template": false,
            "a_controlling_app": "",
            "r_full_content_size": 0.0,
            "a_extended_properties": null,
            "a_is_signed": false,
            "a_last_review_date": null,
            "i_retain_until": null,
            "r_aspect_name": null,
            "i_retainer_id": null,
            "i_partition": 0,
            "i_is_replica": false,
            "i_vstamp": 0,
            "r_folder_path": [
                "/WSO2 Connector/Sample/testchildfolder"
            "i_ancestor_id": [
            "r_object_id": "0b0277b6800584f7"