Chapter 15. Content Management System (CMS) Integration

 Documentum (CMS) Support

<oXygen/> provides support for browsing and managing Documentum repositories in the Data Source Explorer. You can easily create new resources on the repository, copy or move them using the actions or the drag and drop support, edit and transform the documents in the editor. The operations that can be performed on repository resources are described in the Documentum (CMS) actions section.

<oXygen/> supports Documentum (CMS) version 6.5 and above with Documentum Foundation Services 6.5 or later installed.

[Note]Note

The Documentum (CMS) support is available only in the Enterprise version.

[Warning]Warning

It is recommended to use the latest 1.5.x or 1.6.x java version. It si possible that the Documentum (CMS) support will not work properly if you use other java versions.

[Warning]Warning

Please note that at the time of this implementation there is a problem in the UCF Client implementation for MAC OS X which prevents you from viewing or editing XML documents from the repository. The UCF Client is the component responsible for file transfer between the repository and the local machine. This component is deployed automatically from the server.

 How to configure Documentum (CMS) support

This section presents the procedure used to configure a Documentum (CMS) data source and connection in the Data Source Explorer.

To connect to a Documentum Content Server repository you need to configure a data source and a connection.

 How to configure a Documentum (CMS) data source

To configure a Documentum (CMS) data source you need the Documentum Foundation Services Software Development Kit (DFS SDK). The DFS SDK can be found in the Documentum (CMS) server installation kit or it can be downloaded from EMC Community Network. The DFS SDK comes as an archive named emc-dfs-sdk-6.5.zip.

 
  1. Go to Preferences -> Data Sources. In the Data Sources panel click the New button.

  2. Enter a unique name for this data source and select Documentum CMS from the driver type combo box.

  3. Press the Choose DFS SDK Folder button and select the folder where you have unpacked the DFS SDK archive file, emc-dfs-sdk-6.5.zip. If you have indicated the correct folder the following jar files will be added o the list:

    • lib/java/emc-bpm-services-remote.jar

    • lib/java/emc-ci-services-remote.jar

    • lib/java/emc-collaboration-services-remote.jar

    • lib/java/emc-dfs-rt-remote.jar

    • lib/java/emc-dfs-services-remote.jar

    • lib/java/emc-dfs-tools.jar

    • lib/java/emc-search-services-remote.jar

    • lib/java/ucf/client/ucf-installer.jar

    • lib/java/commons/*.jar (multiple jar files)

    • lib/java/jaxws/*.jar (multiple jar files)

    • lib/java/utils/*.jar (multiple jar files)

    [Note]Note

    If for some reason the jar files are not found you can add them manually by using the Add Files and Add Recursively buttons and navigating to the 'lib/java' folder from the DFS SDK.

  4. Click OK to finish the data source configuration.

 How to configure a Documentum (CMS) connection

 
  1. Go to Preferences -> Data Sources. In the Connections panel click the New button.

  2. Enter a unique name for this connection and select one of the previously configured Documentum (CMS) data sources from the Data Source combo box.

  3. Fill-in the Connection Details

    URL

    URL to the Documentum (CMS): http://<hostname>:<port>

    User

    User name to access the Documentum (CMS) repository.

    Password

    Password to access the Documentum (CMS) repository.

    Repository

    The name of the repository to log into.

  4. Click OK.

 Documentum (CMS) actions

<oXygen/> allows the user to browse the structure of a Documentum repository in the Data Source Explorer view and perform various operations on the repository resources.

You can drag and drop folders/resources to other folders to perform Move/Copy operations with ease. If the drag and drop is between resources you can create a relationship between the respective resources (Drag the child item to the parent item).

 

Figure 15.1. Browsing a Documentum repository

Browsing a Documentum repository

 Actions available on connection

  • Configure Database Sources - Opens the Data Sources preferences page where you can configure both data sources and connections.

  • New Cabinet - Creates a new cabinet in the repository.

    Type

    The type of the new cabinet (default is dm_cabinet).

    Name

    The name of the new cabinet.

    Title

    The title property of the cabinet.

    Subject

    The subject property of the cabinet.

  • Refresh - Performs a refresh of the connection.

 Actions available on cabinets/folders

  • New Folder - Creates a new folder in the current cabinet/folder.

    Path

    Shows the path where the new folder will be created.

    Type

    The type of the new folder (default is dm_folder).

    Name

    The name of the new folder.

    Title

    The title property of the folder.

    Subject

    The subject property of the folder.

  • New Document - Creates a new document in the current cabinet/folder.

    Path

    Shows the path where the new document will be created.

    Name

    The name of the new document.

    Type

    The type of the new document (default is dm_document).

    Format

    The document content type format.

  • Import - Imports local files/folders in the selected cabinet/folder from the repository.

    Add Files

    Shows a file browse dialog and allows you to select files to add to the list.

    Add Folders

    Shows a folder browse dialog that allows you to select folders to add to the list. The subfolders will be added recursively.

    Edit

    Shows a dialog where you can change the properties of the selected file/folder from the list.

    Remove

    Removes the selected files/folders from the list.

  • Rename - Changes the name of the selected cabinet/folder.

  • Copy - Copies the selected folder to a different location in the tree (available only upon folders). This action can also be performed with drag and drop while holding the Ctrl key pressed.

  • Move - Moves the selected folder to a different location in the tree (available only upon folders). This action can also be performed with drag and drop.

  • Delete - Deletes the selected cabinet/folder from the repository.

    The following options are available:

    Folder(s)

    Allows you to delete only the selected folder or to delete recursively the folder and all subfolders and objects.

    Version(s)

    Allows you to specify what versions of the resources will be deleted.

    Virtual document(s)

    Here you can specify what happens when virtual documents are encountered. They can be either deleted either by themselves or together with their descendants.

  • Refresh - Performs a refresh of the selected node's subtree.

  • Properties - Displays the list of properties of the selected cabinet/folder.

 Actions available on resources

  • Edit - Checks out (if not already checked out) and opens the selected object in the editor.

  • Edit with - Checks out (if not already checked out) and opens the selected object in the specified editor/tool.

  • Open (Read-only) - Opens the selected object in the editor for viewing. The files are marked as read-only in the editor using a lock icon on the file tab. If you want to edit those files you must enable the Can edit read only files option.

  • Open with - Opens the selected object in the specified editor/tool for viewing.

  • Check Out - Checks out the selected object from the repository. The action is not available if the object is already checked out.

  • Check In - Checks in the selected object(commits changes) into the repository. The action is only available if the object is checked out.

     

    Figure 15.2. Check In Dialog

    Check In Dialog

    Name

    The name the file will have on the repository.

    Version

    Allows you to choose what version the object will have after being checked in.

    Version label

    The label of the updated version.

    Description

    An optional description of the file.

    Keep Locks

    If checked the updated file is checked into the repository but it is also kept checked out in your name.

    Make this the current version

    Makes the updated file the current version(will have the CURRENT version label).

  • Cancel Checkout - Cancels the check out and loses all modifications since the check out. Action is only available if the object is checked out.

  • Export - Allows you to export the object and save it locally.

  • Rename - Changes the name of the selected object.

  • Copy - Copies the selected object to a different location in the tree. Action is not available on virtual document descendants. This action can also be performed with drag and drop while holding the Ctrl key pressed.

  • Move - Moves the selected object to a different location in the tree. Action is not available on virtual document descendants and on checked out objects. This action can also be performed with drag and drop.

  • Delete - Deletes the selected object from the repository. Action is not available on virtual document descendants and on checked out objects.

  • Add Relationship - Adds a new relationship for the selected object. This action can also be performed with drag and drop between objects.

  • Convert to Virtual Document - Allows you to convert a simple document to a virtual document. Action is available only if the object is a simple document.

  • Convert to Simple Document - Allows you to convert a virtual document to a simple document. Action is available only if the object is a virtual document with no descendants.

  • Copy location - Allows you to copy to clipboard an application specific URL for the object which can then be used for various actions like opening or transforming the resources.

  • Refresh - Performs a refresh of the selected object.

  • Properties - Displays the list of properties of the selected object.

 DITA transformations on DITA content from Documentum

<oXygen/> comes with the DITA Open Toolkit which is able to transform a DITA map to various output formats. However DITA Open Toolkit requires local DITA files so first you need to check out a local version of your DITA content. Once you have a local version of a DITA map just load it in the DITA Maps Manager view and run one of the DITA transformations that are predefined in <oXygen/> or a customization of such a predefined DITA transformation.

[Note]Note

The DITA files checked out from the Documentum CMS add the dctm namespace which is not supported by the DITA DTDs. You need to set the validate parameter to false in your DITA transformation in order to avoid the validation error that would be reported at the beginning of the DITA transformation if the validate parameter keeps the default value true.