OMDOCUMENTUM is the OmniMark Documentum interface library. The OMDOCUMENTUM library provides streaming reader and writer functions for accessing content stored in a Documentum repository, and full access to the Documentum Client Library (DMCL).

The Documentum Client Library implements the Documentum Content Server API. The API is described by the Documentum Content Server API Reference Manual. The OMDOCUMENTUM library is compatible with Documentum Content Server API version 5.2.5 and any later versions that are backwards compatible.

In order to use the OMDOCUMENTUM library, you must first install the Documentum Client Library and the Documentum Content Server. The Documentum Client Library, the Documentum Content Server, and their respective documentation sets can be obtained from Documentum.

The OMDOCUMENTUM library consists of the following files:

• omdocumentum.dll (Windows) or omdocumentum.so (UNIX)
• omdocumentum.xmd

In order to use the OMDOCUMENTUM library, you must first:

• have Documentum Content Server installed on the server machine where you will host your CMS
• have Documentum Foundation Classes (DFC) installed on the client machine where you wish to use OMDOCUMENTUM.

OMDOCUMENTUM functions

OMDOCUMENTUM functions:

• provide information about this interface library
  • dctm.omdocumentum-version
• provide access to Documentum Content Server API functions
  • dctm.result
  • dctm.execute
  • dctm.set
• read from and write to data objects on the content server
  • dctm.reader
  • dctm.writer

Usage notes

The OMDOCUMENTUM library is packaged as a module. To use OMDOCUMENTUM, you must import the OMDOCUMENTUM module into your program:

     import "omdocumentum.xmd" prefixed by dctm.

Configuring Documentum access

Documentum clients can be configured using a client initialization file (usually called "dmcl.ini"), or by directly setting properties of the API session object. More information can be found in the following documents:

• the Content Server Administrator's Guide for
  • information on how the configuration objects are used
  • the structure of the "dmcl.ini" file, and
  • instructions on how to find the "dmcl.ini" file for your installation
• the Content Server Object Reference Manual for a listing of the attributes of the config object, and,
• the Content Server API Reference Guide for the syntax of the API command that sets the attributes of the config object.

Example

The following code shows an example of connecting to a Documentum Docbase. If the connection fails, the error message is output.

  import 'omdocumentum.xmd' prefixed by dctm.
  
  process
    local stream session
    local stream docbase  initial {"my_docbase"}
    local stream user     initial {"my_user_name"}
    local stream password initial {"my_password"}
  
    set session to dctm.result of "connect,%g(docbase),%g(user),%g(password)"
    do when session != ""
      output "Connected to Docbase %g(docbase) with session %g(session).%n"
    else
      output "Error: Could not create a documentum session. "
          || dctm.result of "getmessage,current"
    done

Exceptions thrown by OMDOCUMENTUM

Not all OMDOCUMENTUM functions throw exceptions when errors occur. Consult the individual function topics to determine whether they may throw exceptions.

This is a complete list of the OMDOCUMENTUM library external exceptions that may be thrown back to the calling OmniMark program. These are all catchable using the #external-exception label.

• DTM000 The requested function has not been implemented
• DTM001 The command parameter must contain a command
• DTM002 The attempted set command failed
• DTM003 The attempted execute command failed
• DTM004 The buffer length received from OmniMark is out of range
• DTM005 A call to getcontent failed
• DTM006 Memory could not be allocated
• DTM007 One or more invalid options was specified

Functions    dctm.execute    dctm.omdocumentum-version    dctm.reader    dctm.result    dctm.set    dctm.writer

Platforms    HP/UX    Linux (Intel)    Linux Red Hat Enterprise 5    MS Windows 98/ME    MS Windows NT/2000/XP    MS Windows Vista    Sun Solaris 8

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]