Documentum Server linking with eRoom Enterprise

This topic is organized into the following sections:

About eRoom Enterprise

eRoom Enterprise is a separately licensed extension of the eRoom interface that adds content management using the Documentum Server. It enables teams to collaborate on projects and manage content, all within an integrated environment. Project teams can use eRoom Enterprise to manage content throughout its lifecycle, from document concept, creation, and approval (within eRoom), to document storage, archive, index, and publication (using the Documentum Server).

For example, at the start of a new project, team members can populate their eRoom with documents that are archived in a Documentum repository. During the project, documents are modified and periodically published to the repository. At the end of the project, the team archives all content for ongoing access and reuse.

Note: Workflow Extensions are separately available features that may be added to eRoom Enterprise.

See also:

Basic content management terms

For a review of eRoom basics, see "Working in your eRoom". If you are just getting started with Documentum content management, here are some introductory terms related to eRoom Enterprise:

Note: eRoom Documentum Server-linked files cannot be protected with eRoom rights management. Similarly, you cannot enable rights management for folders with default storage locations in a Documentum repository, or for eRoom linked folder items. However, even if rights management is not enabled for a site or eRoom, protected files linked to a repository location are shown in those types of folders.

Logging in to a repository

To use eRoom Enterprise features, you require a Documentum Server user name and password. The first time you access a repository through eRoom, you must provide these login credentials. If your eRoom member information includes these settings, eRoom uses them to log you in. Otherwise, a login dialog prompts you for that information. Once you are logged in to the repository, eRoom logs you in to all other repositories connected to your community for which you have the same credentials. In future eRoom sessions, you do not need to provide those login credentials again for those repositories. When you access a repository for which you have different login credentials (or if your login information changes), a login dialog prompts you to provide them. In that case, eRoom logs you in to all repositories connected to your community for which you have the same credentials.

Note: If your eRoom site is customized (via SAAPI) to support the Documentum Server's single sign-on integration (with eTrust™ SiteMinder®), you are automatically logged in to a repository without any prompting at all. This customization is available through OpenText Global Technical Services.

Linking files to a Documentum repository

You can create a Documentum Server-linked file in any of the following ways:

Storage location in a repository

Whether you add a file from your computer and link it to a Documentum Server, or you create Documentum Server-linked files from existing eRoom files, you choose a storage location. In eRoom, the Documentum Server target/template picker guides you through the repository(s), cabinets, folders and templates available to you for storing and locating files on the Documentum Server. Some eRooms, folders, or database-attachment fields have initial (default) target locations already specified (via their settings) where any file created, dropped, pasted, or routed there is automatically stored. In this case, you can either use the default location, or pick another one.

Listing Documentum Server-linked files

In list view or detail view in an eRoom item or attachment box, Documentum Server-linked files have a cabinet icon () next to their names. Also, for a Documentum Server-linked file, a check mark appears next to the "Documentum Server Link" command on the right-click file item menu.

Thumbnail list

If your site allows it, any Documentum Server-linked file that has a thumbnail displays the thumbnail at full native resolution (typically 100x100) instead of its regular file icon. Thumbnails are displayed only in large icon view in an eRoom item or attachment box, and you can only see thumbnails for files you have open rights to.

Names of Documentum Server-linked files

Files stored in the repository have the same names as their Documentum Server-linked eRoom counterparts, unless eRoom renames the link to avoid a naming conflict. When they are renamed in either the eRoom or in the Documentum application, names are synched in both applications.

To create Documentum Server-linked files from existing files in eRoom:

Use this procedure for storing a previously unlinked file, or for changing where an existing Documentum Server-linked file is stored in the same repository. (To store the file in a different repository, you must unlink and re-link the file.)

  1. Right-click a file icon and pick "Documentum Server Link..." from the pop-up menu.

Note: The "Documentum Server Link..." command is unavailable for files in a folder or eRoom with a rights-management policy that automatically protects eligible content.

For a single file, the "Documentum Server Link" page opens, with the check box labeled "Store this file on the Documentum Server" selected.

With multiple files selected (in details view), the "Documentum Server Link" page asks if you want to Store all the files in the repository, or Remove them. The default is to Store them all on the Documentum Server.

  1. If more than one repository is available, the "Documentum Server Link: Pick a repository" page opens. Pick a repository and click "OK".

(You skip this step if there is a default location specified for the current eRoom, folder, or database attachment field.)

  1. Log in if you are asked to do so -- continue otherwise.

  2. From the "Documentum Server Link: Pick Location" page, browse the cabinets and folders within the repository to where you want to store your file(s). Or, you can click "Change repository" to select a different one, if available.

  3. Pick the target cabinet or folder, and (if available) pick a template from the drop-down list. Click "OK" when you've make your choice.

  4. Back on the "Documentum Server Link" page, either pick an alternative location (by clicking ), or click "OK" to confirm that you want to store the file(s) in the specified repository location.

If file properties are required when files are linked to the Documentum Server (a site or community setting) then the WDK Properties component opens in a new window. If you picked a template (in step 5) that has mandatory properties, you must specify those properties before you can store the file on the Documentum Server. If your file has no mandatory properties, you can specify properties or not, as appropriate. Click "OK" to set the properties and close the window.

eRoom uploads the selected file(s) to the specified location in the repository and, at the same time, creates one or more Documentum Server-linked file icons in your eRoom.

Note: eRoom does not store copies of Documentum Server linked files, neither in its file cache nor in the recycle bin. If you cancel or close the WDK Properties component for a file with no mandatory properties, eRoom creates the link in eRoom and puts the file on the Documentum Server. If there are mandatory properties, however, the file is deleted from the Documentum Server and a broken link remains in eRoom. However, in this case only, the eRoom server keeps a copy of this file so that no work is permanently lost. The next time you click such a broken link, eRoom asks if you want to replace the link with the actual file. If you click "OK", eRoom retrieves the file from the file server and replaces the link with it. The file exists in eRoom, then, as an unlinked file.

To search a repository to find a file to link to eRoom:

  1. On the "Documentum Server Link: Pick Files" page of the target/template picker, specify text search criteria and click "search".

    eRoom performs a full-text search in the repository and replaces the list of cabinets with up to 250 read-only search results. The results are initially sorted by rank and are not linked.

  1. Select a file or click "reset" to replace the search results with the tree view of the repository.

  2. Click "OK" to return to the "Add File" page, with the selected file, if any, shown in the "Add a file from the Documentum Server" box.

Working with Documentum Server-linked files

Once a file is stored in a repository and linked from your eRoom, you can

Accessing Documentum Server-linked files

In eRoom, the access you have to a Documentum Server-linked file depends on

In order to view or edit a Documentum Server-linked file in eRoom, you need the appropriate permissions to that file in both environments. In other words, your access rights in one environment do not override your rights in the other.

Note: eRoom community administrators have an option to specify who can create and edit Documentum Server links: either all eRoom members in the role of participant and above, just coordinators and above, or just facility administrators. Even if all participants have this permission at the server level, eRoom coordinators have an option to restrict this permission to coordinators only. Documentum Server-link restrictions do not affect eRoom access rights, which determine who can see, open, and edit eRoom items.

Viewing renditions of Documentum Server-linked files

If a Documentum Server-linked file has any associated renditions (for example, PDF or JPG), the file's right-click menu includes a "Preview" command. Clicking this command, or the file's icon, causes eRoom to get the default rendition for the current version of the file from the Documentum Server, and display it using the appropriate application on the client. Clicking "View" or "Edit" opens the file itself (not the rendition) in its native application (if available), either read-only (View), or for editing (Edit).

If a custom viewer is installed, and there's a rendition available for the file, the Preview command always displays the rendition. If there's a custom viewer associated with the rendition's extension, the rendered file opens in the custom viewer. Otherwise, it opens in the application that opens that file type.

Note: Display of renditions of Documentum Server-linked files requires Documentum Media Services.

Modifying Documentum Server-linked files

Renaming or editing a Documentum Server-linked file either via eRoom or another Documentum application that accesses the Documentum Server makes the change(s) visible in both environments.

Editing a Documentum Server-linked file in eRoom, or reserving it for editing, checks out the file on the Documentum Server. When you release the eRoom edit reservation on the file, it is checked back in. If you edit such a file without releasing the reservation, the Documentum application creates a new version of the file, but keeps it checked out. Similarly, if you check out a file from the Documentum Server, the linked file in eRoom is reserved for the same person, so you can edit it in either environment.

Note: When you Copy a Documentum Server-linked file and paste it elsewhere, you create a new reference to where the file is stored in the repository. Copy Link, on the other hand, creates a URL-based link to the Documentum Server-linked file in eRoom. Moving a Documentum Server-linked file also preserves its link information.

See also: Documentum Server-linked files and version tracking in Files for information about specifying a major or minor revision when you edit a Documentum Server-linked file in eRoom.

Modifying properties of Documentum Server-linked files

If your site or community specifies a Documentum Webtop/DAM or Web Publisher URL, you can access the WDK Properties component from eRoom using the "Content Properties" command on the right-click file menu. Doing so opens a new browser window with the Properties component for that file.

If your site or community specifies that file properties are required when files are linked to the Documentum Server, then the WDK Properties component opens during the initial linking process. If you are linking a file with mandatory properties to the Documentum Server, you cannot store the file on the Documentum Server unless you provide values for the required properties.

Note: To modify access control (ACL lists) for Documentum Server-linked files directly within a repository, use the Documentum Webtop or Web Publisher client from eRoom (via the "Go to Documentum Server" command) or use another Documentum Server client such as Documentum Desktop Client.

To unlink Documentum Server-linked files:

  1. Right-click the file icon and pick "Documentum Server Link" from the pop-up menu.

    For a single file, the "Documentum Server Link" page opens with the check box labeled "Store this file on the Documentum Server" selected. Clear the check box.

    With multiple files selected (in details view), the "Documentum Server Link" page asks if you want to Store all the files in the repository, or Remove them. Pick Remove them all from the Documentum Server.

  1. Click "OK" to unlink the file(s) and copy the current version(s) from the Documentum Server into eRoom. While the file and all its versions remain stored on the Documentum Server, no further synchronizing occurs between the copies, nor can unlinked files be re-linked in the future.

Deleting Documentum Server-linked files

If you delete a Documentum Server-linked file from your eRoom, only the file icon is removed from the eRoom -- the actual file on the Documentum Server is always preserved. The deleted link does not move to the eRoom Recycle Bin, however, so if you want to restore the linked file, you must recreate it from the repository (as described above). If the file is deleted from the Documentum Server, the file icon remains in eRoom, but is a nonfunctional link.

Specifying a default storage location in a repository

You can specify a default location in a Documentum repository for automatically storing all unlinked files created, dropped, pasted, or routed to a particular folder (example) or database-attachment box (example). These default storage settings override the eRoom-wide location/template defaults.

For files linked to a Documentum Server in this manner, the default storage location can be changed, and the file can be unlinked, the same as for any Documentum Server-linked file. These automatic storage settings only affect files (no other eRoom items), and no subfolders inherit these defaults from a parent folder or database attachment field.

When a Documentum Server-linked file moves to a folder or an approval-process step, eRoom preserves existing link settings whether automatic/default linking is on or off.

Note: You cannot enable rights management for folders that have a default storage location in a repository.

Approval-process databases and Documentum Server-linked files

With eRoom Enterprise only, database-attachment fields have an option to automatically link to a default repository location, all unlinked files created, dropped, or pasted there. For an approval-process database, you can override this setting for entries in individual steps. Here's why:

To specify a default location in a repository for automatically storing files:

  1. On the folder's Create or Edit page, or on the Database Field Options page for the attachment field, select the check box labeled "Contained files are linked to the Documentum Server by default", and click "settings" to pick the location.

  2. If more than one repository is available, the "Documentum Server Link: Pick a repository" page opens. Pick a repository and click "OK".

    You skip this step if there is a default location specified for the current eRoom. In this case, you can click "Change repository" to select a different repository.)

  1. Log in if you are asked to do so -- continue otherwise.

  2. From the "Documentum Server Link: Pick Location" page, navigate to the default location in the repository you want to store files in the folder or attachment field.

  3. Click "OK" to return to the settings page from which you started, where you can click "OK" to put the default link setting into effect for the folder or database attachment field.

Opening the Documentum Webtop or Web Publisher client through eRoom (Internet Explorer only)

If access to the Documentum Webtop or Web Publisher client is enabled for your site or community, the right-click file item menu in eRoom includes the "Go to Documentum Server" command. Once in Webtop or Web Publisher, you can access all functionality (based on your Documentum Server role and ACL permissions) including properties, version/rendition listings, object permissions, relationships, starting workflows, and lifecycle actions.

To start a Documentum Server client session from eRoom:

  1. Right-click the icon for a Documentum Server-linked file.

  2. Pick "Go to Documentum Server" from the pop-up menu.

A Webtop or Web Publisher client opens in a separate browser window and displays the selected file.