You are on page 1of 24

______________________________________________________

Delilah for EMC Documentum, (Draft) User Manual


July 3rd, 2008

Foreword by the Author


Delilah for EMC Documentum is a Documentum client application that
connects to any Documentum 4, 5 or 6 e-Content server. It provides multiple
interfaces (Explorer, DQL Editor and Find tool) which can be used together.
Delilah is an MDI application (Multiple Document Interface), that allows you
to have many/multiple query sessions open within the application.
Any query results you can easily in a single click to Microsoft Excel in a
matter of seconds!
In almost every screen you have the ability to check the Show DQL option to
unleash the underlying query.
Delilah was originally written with the intention of developing a Samson
replacement tool. As development went on both Delilah and Delphi started to
charm me
The development went into a direction were the aim was put higher then just
a Samson replacement. Delilah is developing to a product that can replace
the Documentum Desktop client for a large number of user needs.
Often companies develop a Documentum system around the Webtop and
WDK frameworks.
In those situations, the Desktop Client can become an unwanted tool as
Desktop client provides many open doors if it is not tailored for your
environment.
Delilah is not there yet. We are exploring possibilities to incorporate a
configurable check in/check out/properties module.
While developing Delilah, a question that keeps me as a developer busy is:
Why is Documentum ignoring the client/server developers? If you compare
the performance between Documentum Desktop client and Delilah, you
really start wondering why Documentum does not optimize their Desktop
client.

Using Delilah in a production environment is your own responsibility. Of


course I strongly recommend to test it at least in a staging environment.
I hope you enjoy Delilah as much as I enjoyed the development
Send your feedback to: Delilah@canservices.nl

Table of Contents
I. OVERVIEW.....................................................................................................................3
II. LOGGING IN.................................................................................................................3
III. EXPLORER MODE......................................................................................................4
IV. QSEARCH..................................................................................................................10
IV. DELILAH FOR DOCUMENTUM ADMINISTRATORS..............................................12
IV.I User and Group administration help................................................................................................ 12
IV.II API Tester.......................................................................................................................................... 14
IV.III Batch Import files............................................................................................................................ 15
IV.IV Update from Spreadsheet............................................................................................................... 18

V. SETUP AND TROUBLESHOOTING..........................................................................19


V.I How to get Delilah running................................................................................................................ 19
V.II Error loading MIDAS.DLL.................................................................................................................. 19

I. Overview
Delilah

II. Logging in
When you launch Delilah.exe, a login screen is presented:

III. Explorer mode


When you enter Explorer mode, the following screen is shown (after opening
a cabinet on the left pane):

Sorting and Filtering:


When you click on a column title (e.g. object_name or title), the grid will sort
itself in ascending order. The Content server will not be bothered for this, this
is all client side sorting!
When a column is sorted, its column title is shown in bold.
If you click again on a column that appears in bold, a filter is shown:

After entering a text in the filter, the grid will show only the records meeting
the filter:

Explorer options:
Using the Document Type drop down, you can select any of your visible
document types. When changing to a different type, the right pane will only
show documents of that type and its subtypes.
Using Show Versions you can quickly switch between Current version,
Latest version and all versions.
Setup brings you to the column chooser:

Double clicking in the available fields will add the field to the list of selected
fields.
Using drag&drop you can re-order the selected fields. When pressing OK, the
preferences are saved to the Delilah.ini file. It will update the right pane with
the configured columns.
Clicking on the Excel button, will launch MS Excel and send the results into
the spreadsheet.

When making selections in the right pane, you can press CTRL + mouse click
to select multiple records.

In the right pane, you can right click to get a context menu:

The options in the right click / context menu explained:


1. View Rendition
Will try to send the TIF or PDF rendition to Windows for viewing. If a
rendition does not exist, the original format is sent instead. If a
viewing application is configured in Windows, it will launch that
application, e.g. MSWord will be launched for msw8 file format.
2. View Original format
Is like View Rendtion but will only send the original format for viewing
to Windows.
3. Print Document(s)
This option is configurable through Edit/Preferences. In the preferences
you can define if the rendition or the native format should be send to
Windows for printing. Having setup an application for the file extension
of your document is a pre-requisite.
4. Properties
5. Edit, checkin, checkout
6. JVue View
Only works when configured through preferences. You can send the
object id of the selected document to an Internet Explorer session to
jump into Webtop. The URL in the preferences is of format: http://putyour-webtop-server-here:8080/drl/objectId/

7. Export
You can export selected documents. It will prompt for a destination
directory first.
8. Add to Clipboard
You can add selected documents to the clipboard. In the current
version, the clipboard can be used to paste links into another folder (by
right clicking in the left pane/tree view on the target folder and
selecting Paste links).
9. Dump Attributes
10.
Delete Link
Using delete link, you can unlink selected documents. Delilah will only
unlink if the selected document(s) have at least 1 remaining link.
11.
Dump attributes
Just shows you all document attributes in a text file.
12.
Show Versions
Simply shows all versions of the document. You can right click and add
them to the clipboard of course.

13.
Show Versions and Renditions
Shows versions in combination with renditions (my sample docbase

does not have renditions):

14.
Show Locations
You can see at which locations a document exist:

Using Right click / Delete link you can immediately remove any
unwanted folder links.
15.
Select ALL records
Because Delilah does not yet have a nice graphic button or a CTRL-A
event handler, we put this option in the right click menu. You can
simply select all records in the right pane:

This is useful for Exporting or copying to clipboard etc.

IV. QSearch
You can open the Quick Search from the main menu bar. This will show the
following screen:

The Quick Search feature allows users to easily find information and modify
search criteria until the search has been refined to the required level. In the
results grid, all standard functionality such as Export and Batch print is
available. With the Setup button, the fields to display in the search results
can be adjusted. If you have a search on for example dm_document, the
setup uses the field setup from the Explorer windows for dm_document.
The Quick Search feature can be tailored by modifying the
Delilah_qsearch.ini file. When you first use QSearch, this INI file will be
created automatically in the directory where Delilah.exe resides. The default
INI file looks like:
[QuickSearch1]
Title=Search DM_Documents
Type=dm_document
Search=object_name,title,keywords
Order=object_name

To[QuickSearch2]
be continued

Title=Search Sysobjects
Type=dm_sysobject
Search=object_name,title,keywords,acl_name
Order=object_name

The searches need to be numbered, starting from [QuickSearch1].


The Title is the friendly search name shown in the dropdown. The Type is the
type to query (can also be dm_user for example). Search contains the field
for which search criteria can be entered. Currently the searchable fields are
restricted to String type fields only.
In the Order you can specify the sorting order.

IV. Delilah for Documentum Administrators


In this chapter we explain what Delilah can do for Documentum
Administrators.
This chapter is updated until our version 2007-01-11 of Delilah.exe.

IV.I User and Group administration help


In the Find menu, you find the options to search for users or for groups:

IV.I.I Find dm_User by User name


When you select this option, you can enter a search string for the user_name
field.

Leaving this field blank will return all users>

When you right click on a user, you have the ability to show the group
memberships of this user:

This will show the following screen:

In both the user and the group screens you have the option to view the
related ACLs from the right click menu:

IV.II API Tester


In the 20-April-2007 version of Delilah, we finally built in the API Tester
module. You can find it in the following menu:

When you select this option, the following screen shows:

Comparing Delilahs API tester to Workspace, you will find the following
benefits:

Shows the API syntax, as soon as you type a valid API command (like
entering get shows the get syntax);

The DATA field is only enabled when you have entered an API call that
requires it

You find a list of all API calls, known in Documentum 5.2.5, in the API Index

Coming soon:

Clicking on an API entry in the grids should copy the API call to the
command entry part of the screen

The CommandHistory tab should show only the commands you entered
and allow you to save the commands to a .api text file for repeatable use

Process batch .api file

IV.III Batch Import files


In the Import menu, you find the option Update from File, that allows you to
batch import files if documents exist that have an object_name similar to the
filename (excluding the extension). You find this option under:

Before being able to use this option, you will have to agree first that taking
any risk using this option is your own responsibility. We strongly recommend
to practice any import you want to do first in a controlled DEV or Test
environment.
You can confirm your agreement in the Edit / Preferences menu option:

After typing AGREED in the text box at the bottom of the Import tab, the text
background will turn green and the menu option Import / Update from File
will become fully functional.

When you open the menu Import / Update from File, you will find the
following screen:

In this screen you should:

Select your Import file location using the button showing with the
after the text input field.

Determine your Target document type. The deeper in the hierarchy of


types you select, the less chance of finding duplicate documents will
exist.

Determine if you want to update Major versions like 1.0, 2.0 or 3.0 or if
you want to update minor versions like 2.1, 2.2 or 2.3 etc.

Determine the VERSION LABEL that you need to set on the imported
version (default is DRAFT)

Determine your LOG_ENTRY you want to set on imported versions. This


allows to easily identify the documents that you import

E.g.:
SELECT * FROM dm_document (ALL) WHERE log_entry = updated from
file
The above query shows any documents imported with the log_entry
set to updated from file

Determine if you want to make the imported document a CURRENT


version (only use when you dont have lifecycles etc)

Determine if the imported version becomes Minor or Major (1.1 or 2.0


for example).

When you click Run Preview, you will go to the Preview tab if any of the files
in your identified directory can be used to update existing documents.
Only if an object name is unique files can be imported.

As said earlier in this document: TEST THIS IMPORT FUNCTION FIRST IN A


TEST OR DEVELOPMENT ENVIRONMENT.
Preferably test with your DMCL.INI file set to trace all commands in a trace
file, allowing you to see what is going on inside Delilah.
Let us know what you like/dislike in the Update from Files module!
Send mail to Delilah@canservices.nl

IV.IV Update from Spreadsheet


In the Administrator Menu the option Update from Spreadsheet allows you to
generate API update commands from a spreadsheet and run the API in
Delilah.
Be sure to test this first in a non production environment!
Step by step approach:

1. Generate your spreadsheet using DQL or Delilah Explorer

- Make sure the Field Prefix option is configured in Delilah


Edit/Preferences/Excel and CSV
- Make sure the first column in your select statement is R_OBJECT_ID
- Second column is the column you want to update, you can use 3rd or even
more columns
- BE SURE NOT TO INCLUDE REPEATING ATTRIBUTES!!!

Example query:
-------------SELECT r_object_id,object_name
FROM dm_sysobject
WHERE ANY i_folder_id = '0c00072c80000117'
ORDER BY object_name
ENABLE (UNCOMMITTED_READ);

2. Send results from your Query to Excel and save the Excel file

3. Fix the data in your excel file (with the exception of the r_object_id
column)
Some Excel tips:
- If you want to convert field values to uppercase, you can use the UPPER
function of Excel
- If you want to strip the file extension from Object_name fields (like .doc),
you can use the MID function, e.g.
=MID(B1, 1, LEN(B1)-4)
The above example strips of the last 4 characters from a cell

Using Copy and then Paste Values you can overwrite the original cells with
just the values

4. Remove any rows that are not needing an update!

5. Check your spreadsheet


- Should have column names on row 1
- Should have r_object_id in cell A1
- Should have column names for columns to modify in B1, C1 etc
- Should have only data under the column names (clear all other cells)

6. Save the spreadsheet

7. In Delilah, Open your spreadsheet using the Administrator / Update from


Spreadsheet function

8. Check the Grid in Delilah containing your excel data to modify

9. If data shows ok in 8, click RUN button

10. This launches the Batch API tester


Review your generated API's, if agreed, click Run Batch

11. Navigate to the modified data and verify

That's all

V. Setup and Troubleshooting


V.I How to get Delilah running
To get Delilah running, you only need 1 Documentum DLL file. Since the
Delilah release of Januari 2008, the Documentum VB DLL is no longer
needed!
In a typical configuration, you just extract the files Delilah.exe and
midas.dll from the DFD2007.zip archive to C:\Program Files\Documentum.
Next you need to get the DMCL40.DLL file from Documentum. The dmcl40.dll
is typically found on the content server under
\Documentum\product\5.3\bin\dmcl40.dll.
Put the DMCL40.DLL also under C:\Program Files\Documentum and you are
ready to run DELILAH.EXE. Ofcourse you can shortcut Delilah.exe to any
location you want (Windows Start menu etc).
In case you still have difficulties, post your question on the forum at
http://www.canservices.nl or send an e-mail to Delilah@canservices.nl

V.II Error loading MIDAS.DLL

Delilah uses the MIDAS.DLL to support the result grids and provide database
like sort and find features.
It is possible that you find the above message on your computer. Maybe you
have ever had another midas based application or you have moved the
Delilah application to a different folder. In that case you may need to reregister the midas.dll.
This can be accomplished using the following steps: (assuming that you have
a directory called c:\delilah that contains the Delilah.exe and midas.dll files,
ofcourse you can use any other directory)

Press Start / click Run / enter CMD to open the command prompt.
In the command window enter the following:
regsvr32.exe "c:\delilah\midas.dll"
This should give a message that registration succeeded.
Try to start Delilah again and navigate to a folder. The folder contents should
display properly now.