Documentum Connection Utilities

There are a couple of very helpful connection utilities that Documentum includes in the %DM_HOME%\bin directory.  I will highlight a few of them over the next few posts. The first is dmqdocbroker. dmqdocbroker queries the Docbroker for information that can be helpful in troubleshooting connection issues. The list of options are discussed below.

The tool can be run interactively or in silent, command line mode. To run the tool interactively, open a command window on the Content Server and navigate to %DM_HOME\bin. Enter dmqdocbroker to view the help and usage page.

To begin interactive mode, enter: dmqdocbroker -t docbroker_host_name -i where docbroker_host_name is  the name of the server hosting the Docbroker.

dmqdocbroker: A DocBroker Query Tool
dmqdocbroker: Documentum Client Library Version: 6.5.0.118SP1
Targeting port 1489
---- dmqdocbroker: (TARGET HOST: DCTM65DEV) ----
p) Ping (test connectivity to) the docbroker
d) Get a docbase map
s) Get a server map
n) Get next largest docbase id
l) lookup a docbase id
o) find all open servers for a docbase
h) Set the host name for the docbroker
e) exit
Enter an option (i.e. letter)>

p) Ping
As the name implies, ping will ping the Docbroker to ensure it is ‘alive’ and return the host name, port number and version of the software.

Successful reply from docbroker at host (DCTM65DEV) on port(1490) running
software version (6.5.0.117 SP1 Win32).

d) Docbase Map
This option returns information about each Docbase registered with this Docbroker.

**************************************************
**     D O C B R O K E R    I N F O             **
**************************************************
Docbroker host            : DCTM65DEV
Docbroker port            : 1490
Docbroker network address : INET_ADDR: 02 5d2 c0a8dc80 DCTM65DEV 192.168.220.128

Docbroker version         : 6.5.0.117 SP1 Win32
**************************************************
**     D O C B A S E   I N F O                  **
**************************************************
--------------------------------------------
Docbase name        : repo1
Docbase id          : 1
Docbase description :
Govern docbase      :
Federation name     :
Server version      : 6.5.0.117 SP1 Win32.SQLServer
--------------------------------------------

s) Server Map
This option returns information regarding each of the Docbase servers registered with this Docbroker.

**************************************************
**     D O C B R O K E R    I N F O             **
**************************************************
Docbroker host            : DCTM65DEV
Docbroker port            : 1490
Docbroker network address : INET_ADDR: 02 5d2 c0a8dc80 DCTM65DEV 192.168.220.128

Docbroker version         : 6.5.0.117 SP1 Win32
**************************************************
**           S E R V E R     M A P              **
**************************************************
Docbase repo1 has 1 servers:
--------------------------------------------
server name         :  repo1
server host         :  DCTM65DEV
server status       :  Open
client proximity    :  1
server version      :  6.5.0.117 SP1 Win32.SQLServer
server process id   :  1560
last ckpt time      :  6/4/2010 10:07:13 AM
next ckpt time      :  6/4/2010 10:12:13 AM
connect protocol    :  TCP_RPC
connection addr     :  INET_ADDR: 02 ba09 c0a8dc80 DCTM65DEV 192.168.220.128
keep entry interval :  1440
docbase id          :  1
--------------------------------------------

n) Next Docbase ID
This option returns the next largest Docbase ID number.

Next (largest) docbase id: 2

l) Lookup Docbase ID
Given a Docbase ID, this option will return the repository name.

Enter the docbase id: 1
Docbase id: 1 is assigned to docbase named: repo1

o) Open Server
Given a Docbase name, find the open server servicing that Docbase.

Enter the docbase name: repo1
Open servers for docbase: repo1:
-----------
1) host name: (DCTM65DEV)

h) Host Name
This option allows you to change the host name for the Docbroker you are querying.  This is the same as re-running dmqdocbroker with a different -t parameter.

Enter the host name for the Docbroker: DCTM65DEV

Bug
I you leave out the -t parameter the tool is supposed to default to the local host, and it does, but it prints out an error also.

Targeting current host
'uname' is not recognized as an internal or external command, operable
program or batch file.

Local Usage
If you would like to use this tool from your workstation instead of from the Content Server, copy the following files to a directory on your hard drive:

  • dmqdocbroker.awk
  • dmawk32.exe
  • dmcl.dll

The dmqdocbroker.bat file won’t run the utility since it has some hard-coded path names. To invoke the utility from your local workstation, use the following syntax:

dmawk32 -f dmqdocbroker.awk -- -t [docbroker host name] -i

Silent
You can also run the utility in ‘silent’ mode, which just means that the interactive menu is not printed and the user is not prompted for a command to run. The command is passed in on the command line and the only output is the result of the command. For example:

dmawk32 -f dmqdocbroker.awk -- -t DCTM65DEV -s -c ping

Successful reply from docbroker at host (DCTM65DEV) on port(1490) running
software version (6.5.0.117 SP1 Win32).

In ‘silent’ mode, the utility is suitable for use in a start-up or monitoring script. See here for some ideas: https://community.emc.com/message/320234

This utility is undocumented as far as I can tell with only one support note about it:  https://solutions.emc.com/emcsolutionview.asp?id=esg2497.  One bit of good news is that it is written in AWK and therefore the code is completely readable, so have a look, maybe you can learn something or think of a cool addition to the script.  If you do, let me know and I will post it.

Advertisements

About Scott
I have been implementing Documentum solutions since 1997. In 2005, I published a book about developing Documentum solutions for the Documentum Desktop Client (ISBN 0595339689). In 2010, I began this blog as a record of interesting and (hopefully) helpful bits of information related to Documentum, and as a creative outlet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: