swirl
Guide to OmniMark 7   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
Functions        
 

Interfaces, Documentum interface (OMDOCUMENTUM)

 
 

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 which are backwards compatible.

The OMDOCUMENTUM library is packaged and licensed separately from OmniMark. 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:

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

OMDOCUMENTUM functions

OMDOCUMENTUM functions:

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:

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. The possible exceptions are:

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

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]

OmniMark 7.1.2 Documentation Generated: June 28, 2005 at 5:46:15 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © Stilo Corporation, 1988-2005.