Installation Wiki

Documentum

From InstallationWiki

Jump to: navigation, search
Documentum
Official Page
Project Documentation
Download
Source Book
Web Content Management with Documentum
Web Content Management with Documentum
ISBN 978-1-904811-09-1
Publisher Packt Publishing
Author(s) Gaurav Kathuria


Contents

[edit] Setting Up the Documentum Suite

Download the correct versions of the various Documentum products from Documentum's download site:

https://documentum.subscribenet.com

Remember that you will need to enter a valid login and password before you get access to the software installables.

Once you have downloaded the executables from the Documentum site, the most important question you face is where to start from. The other critical aspects that come to mind are: what is the correct installation sequence, any pre-requisites, things to be aware of, and so on and so forth.

Sit back and relax Figure 5.1 is a chart you can follow for installation sequence. This should not be treated as the best possible Documentum installation sequence, but in most projects it will work out well.

[edit] Installing Content Server

We will be installing Content Server 5.2.5 SQL Server for Windows (base install) and then updating it with the SP2 (service pack 2) patch.

It is strongly recommended that you go through the complete Release Notes and Installation manuals for the Documentum software in question. What has been mentioned here is just the checklist that one should follow and what one needs to be specifically cognizant of.

To begin, download the following Content Server software installers from the Documentum site:

  • Content_Server_5.2.5_windows_sql.exe
  • Content_Server_5.2.5_SP2_windows_sql.exe

Please note that throughout the tutorial we will be referring to the Documentum product versions 5.2.5 SP2 on a Windows environment with SQL Server DB, IIS Web server, and Tomcat application server. The installation steps and configurations will pertain to the specific product version 5.2.5 SP2 only.

There can be only one Content Server installation on a Windows host. Do not attempt to install two content servers on the same Windows machine. However, this is possible in the case of a UNIX or Linux environment. Moreover, on UNIX and Linux systems, multiple installations can be created on a single host, including installations of different versions of the Server. For example, both 5.2 and 5.3 installations can exist on a single UNIX host!

Once Content Server has been installed, multiple Docbases can be created for the Content Server in question.

[edit] Prerequisites

Following are some of the prerequisites for starting the installation of Content Server:

Note:Do not use spaces in the name of the installation directory for Documentum. For example, do not install under C:\Documentum Installation\.

No further delays! Let us kick-off the installation of Content Server 5.2.5 and then subsequently install the SP2 patch over it.

[edit] Getting started

Follow these instructions to get Content Server installed:

  1. Log in as the installation owner and extract Content_Server_5.2.5_windows_sql.exe on the Content Server machine and run ContentServer.exe.
  2. Click the Next button.
    Initial screen for installation of Content Server
    Initial screen for installation of Content Server
  3. Choose the installation directory or continue with the default shown.
    Destination directory screen for installation of Content Server
    Destination directory screen for installation of Content Server
  4. Choose the DFC destination directory or continue with the default shown.
    DFC destination directory screen for installation of Content Server
    DFC destination directory screen for installation of Content Server
  5. Choose the user directory or continue with the default shown.
    User directory screen for installation of Content Server
    User directory screen for installation of Content Server
  6. Provide the name of the DocBroker host and port number or choose the default. Documentum defaults the current Content Server machine as DocBroker host.
    DocBroker host and port screen
    DocBroker host and port screen
  7. If required, optionally choose to install the DFC developer documentation and click the Next button.
  8. If required, optionally enable Trusted Content Services (TCS) and provide the license key. Then click the Next button.
  9. If required, optionally enable Content Services for EMC Centera and provide the license key. Then click the Next button.
  10. Optionally provide alternativee port numbers for starting and shutting Apache Tomcat server (available with Content Server installation) or choose the defaults. Then click the Next button.
    Documentum Java Method Server screen
    Documentum Java Method Server screen
  11. Choose the Configure server now option if you need to continue creating the Docbase. We will first complete the Content Server installation and then upgrade to 5.2.5 SP2. Later we will create the Docbase.
Server configuration screen
Server configuration screen
  • The system needs to be restarted after the installation is done. We will first install the Content Server 5.2.5 SP2 patch and then restart the machine.

    [edit] Installing Content Server 5.2.5 SP2

    1. Log in as the installation owner and extract Content_Server_5.2.5_SP2_windows_sql.exe on the Content Server machine and run ContentServerSP.exe.
    2. Click the Next button.
      Initial screen for installation of Content Server 5.2.5 SP2
      Initial screen for installation of Content Server 5.2.5 SP2
    3. If required, optionally choose to install the DFC developer documentation and click the Next button.
    4. Stop the following services on the Content Server machine:
      • Any existing Docbases
      • Any existing DocBrokers
      • Documentum Java Method Server
    5. We will finish off the installation and later configure the server (i.e. create Docbases)
      Server configuration screen
      Server configuration screen
    6. Restart the Content Server host machine.

    That's it! We are done with installing Content Server 5.2.5 SP2. Now we will create and configure a Docbase so that we can start developing our custom objects in the newly created Docbase.


    [edit] Creating Our First Docbase

    We have set up Content Server and are all set to create our first Docbase. Once the Docbase is ready, we can create our custom DocApps in the Docbase and play around with our custom‑defined objects.

    Let's come up with a good (and of course rational) name for your Docbase before we jump ahead. In this tutorial, dev_doc is the name we have chosen.

    [edit] Prerequisites for setting up a Docbase

    [edit] Creating a Docbase

    1. Set up a DSN (Data Source Name) on the Content Server machine, so that the Docbase can connect and talk to the underlying SQL Server RDBMS. On your Windows machine, go to Programs | Administrative Tools | Data Sources (ODBC). Choose System DSN and click the Add button.
      Selecting SQL Server as the Data Source
      Selecting SQL Server as the Data Source

      After choosing SQL Server, click the Finish button.

    2. Specify the DSN name and a short description. Also provide the host name of the SQL Server DB. In this example, SQL Server was installed locally on the same machine as the Content Server.
      Specifying SQL Server server name
      Specifying SQL Server server name
    3. In the case of SQL Server authentication, provide a valid login ID and password.
      SQL Server authentication credentials
      SQL Server authentication credentials
    4. Do not change the default database or the language of SQL Server system messages unless required. Click the Next button till you reach the Finish button.
      Testing the data source
      Testing the data source
    5. Click on Test Data Source to check whether the database connection can be established correctly. If this works fine, click OK. The created DSN now shows up along with other DSNs in the System DSN tab. Finally click on OK. We have successfully created a DSN for connecting to a SQL Server database.
    6. Log in as the installation owner on the Content Server machine and go to Programs | Documentum | Documentum Server Manager. From the Documentum Server Manager panel, select the Utilities tab and click on Server Configuration.
      Documentum Server Manager
      Documentum Server Manager

      The following error message might be seen if the domain is unavailable due to connectivity issues or if some changes have been made to the domain the user is a member of:"Unable to initialize admin dll (OSEnv)"

    7. Enter the installation owner's password and click Next.
    8. If required, optionally enable the Trusted Content Services (TCS) and provide the license key. Then click the Next button.
    9. If required, optionally enable Content Services for EMC Centera and provide the license key. Then click the Next button.
    10. Select the configuration type:
      • Express Configuration
        • Quick. Less information needs to be provided during the installation procedure. Default parameters provided by Documentum during setup.
        • Limits the amount of customization we can do to the Docbase and Content Server.
      • Custom Configuration
        • Lengthier mechanism requiring more inputs from user during installation.
        • Allows customization of Docbase configuration scripts, data files, etc.

      This example uses the Express 'Configuration' type to create the Docbase.

      Choosing configuration type
      Choosing configuration type
    11. If required, optionally choose Content Storage Services. Then click the Next button.
    12. Provide a valid Docbase Name and Docbase ID (as per the limitations specified in the beginning of the chapter). Choose Docbase Size, Windows Authentication Domain, and specify whether the Windows Service Startup Type for managing the Docbase should be automatic or manual.
      Specifying Docbase parameters for setup
      Specifying Docbase parameters for setup
    13. Either allow Documentum to create/configure a Docbase owner (database user) for you or choose an existing SQL server database account if you have already made one.
      Setting up database account
      Setting up database account


    14. Select the DSN for database connectivity (created in the initial few steps). In this example, the defaults provided by Documentum for Docbase owner name (the name of the specified Docbase) have been chosen. The default database name is in the following format: DM_<Specified Docbase name>_docbase
    15. Provide the Docbase owner password and SQL Server DB administrator user name and password.
      Providing Database connection parameters
      Providing Database connection parameters

      After the Docbase has been created and if someone has unknowingly changed the password for the Docbase owner (DB owner), then the following error message is seen during Docbase startup:
      [DM_SESSION_I_RETRYING_DATABASE_CONNECTION] info: "The following error was encountered trying to get a database connection: STATE=28000, CODE=18456, MSG=[Microsoft][ODBC SQL Server Driver][SQL Server]Login failed for user 'dev_doc'.

    16. Provide an SMTP server name or IP address and a valid email address for the Documentum installation owner. Click the Next button.
      Specifying SMTP server and installation owner's email address
      Specifying SMTP server and installation owner's email address
    17. Choose the WebPublisher DocApp to be installed on the Docbase in case we need to use Web Publisher with the Docbase in question.
    18. This completes Docbase creation and the newly created Docbase shows up in the Documentum Server Manager panel under the Docbase tab.
    : Newly created Docbase as seen in Documentum Server Manager
    : Newly created Docbase as seen in Documentum Server Manager


    The following error message is seen during Docbase startup if Docbase was configured on a Content Server with case-insensitive SQL Server:
    [DM_SESSION_I_INIT_BEGIN]info: "Initialize Crypto Objects."
    [DM_SESSION_E_INIT_FAILURE1]error: "Failure to complete Crypto Objects initialization."
    [DM_SERVER_I_START_ID]info: "Docbase dev_doc was not successfully opened.

    You can create multiple Docbases on the same Content Server with different names to serve the purpose of a development Docbase and a test Docbase (for example). Also, you can create multiple servers for a single Docbase so that request processing is spread across multiple servers to achieve performance gains. However, a detailed discussion regarding such configuration is beyond the scope of this book.

    [edit] Installing Web Publisher Server Files and DocApp

    Once the Docbase is ready, we can install Web Publisher Server Files on the new Docbase so that Documentum WebPublisher DocApp is installed and available for our use.

    Web Publisher installation is typically done on a separate machine hosting the application server. On the other hand, Web Publisher Server Files are installed on the Content Server machine.

    Please note that Web Publisher Server Files installation is required since we are going to use Web Publisher web client for entering content and need default Web Publisher objects to work with. The default Web Publisher objects are available from WebPublisher DocApp, which is configured when we install Web Publisher Server Files on the Content Server host.

    Documentum recommends installing Web Publisher Server Files and DocApp as the Content Server installation owner. On Windows, the Web Publisher Server Files are installed at the following location on the Content Server:

     %DM_HOME%, for example: C:\Documentum\product\<product version>
    

    [edit] What does Web Publisher Server Files Contain?

    'Web Publisher Server Files' contains wcm and WcmMethods JAR files containing some Java methods that are run on the Content Server by Documentum Java method server. These methods call classes that are required to be executed from Web Publisher workflow activities.

    [edit] What does WebPublisher DocApp Contain?

    'WebPublisher DocApp' contains some base Web Publisher objects required by Web Publisher to work with the Docbase in question.

    For example:

    • Web Publisher jobs and methods
    • Web Publisher workflow templates
    • Web Publisher lifecycles
    • Web Publisher object types
    • WebPublisher User Default ACL
    • Web Publisher groups: content author, content manager, web developer, and administrator
    • Web Publisher roles: wcm_content_author_role, wcm_content_manager_role, wcm_web_developer_role, and wcm_administrator_role

    [edit] Beginning Installation

    First download Web_Publisher_Server_Files_5.2.5_SP2_windows.exe from the Documentum site.

    1. Log in as the installation owner and extract Web_Publisher_Server_Files_5.2.5_SP2_windows.exe on the Content Server machine and run wPServerWinSetup.exe.
    2. Click the Next button.
      Initial screen for installing Web Publisher server files
      Initial screen for installing Web Publisher server files
    3. Accept the license agreements and click the Next button.
    4. The path where Web Publisher Server Files will be installed is shown. Click Next. In our case, the default location shown was C:\Documentum\product\5.2\bin.
    5. Choose the Docbase where the Web Publisher Server Files/DocApp need to be installed. The example shows that the new Docbase we had just created has been selected. Provide the installation owner name and password and click Next.
      Selecting the Docbase
      Selecting the Docbase
    6. Select the checkbox for WebPublisher DocApp and click Next. You may additionally choose Accelera DocApp in case you need to work with sample Docbase objects provided by Documentum for its sample website: http://www.Accelera.com. Note that if you choose to install Accelera DocApp, you must install the WebPublisher DocApp as well in order for the Accelera application to work properly.
      Selecting the DocApp(s) to be installed
      Selecting the DocApp(s) to be installed
    7. WebPublisher DocApp installation commences on the chosen Docbase (dev_doc in our case). A DocApp log file is created by the installer, containing information about the installed objects and mentioning warning and errors, if any.
      DocApp installation console window
      DocApp installation console window
    8. WebPublisher DocApp installation might take a couple of minutes. Once done, the DocApp installation log is displayed. If there are no errors shown, click Next.
      Web Publisher Server Files installation log
      Web Publisher Server Files installation log
    9. After the installation completes, stop and restart Documentum Java Method Server on the Content Server host.

    [edit] Stopping and Starting Docbase and DocBroker

    Documentum Server Manager is installed when Content Server has been installed and set up. It is a simple interface that can be used to start and stop DocBrokers and Docbases. In fact, Documentum Server Manager can be used to perform a host of other operations as well, such as:

    • Executing DQL and Server API commands
    • Viewing Docbase server logs and DocBroker log files
    • Modifying server.ini and dmcl.ini files
    • Analyzing server performance through performance monitor
    Documentum Server Manager displaying existing Docbase(s)
    Documentum Server Manager displaying existing Docbase(s)

    You can stop a running Docbase service by selecting the Docbase in question as shown in figure 6.19 and clicking the Stop button. Alternatively, you can start a stopped Docbase by clicking the Start button.

    Similarly, by switching over to the DocBroker tab in Documentum Server Manager, you can start and stop the DocBroker(s) as shown below.

    Documentum Server Manager displaying existing DocBroker(s)
    Documentum Server Manager displaying existing DocBroker(s)

    [edit] dmcl.ini

    The dmcl.ini file defines configuration information for client applications and each client needs to have a copy of this file. The location of this file depends on the Documentum client as well as the host machine of the client.

    Following are some of the keys defined in the dmcl.ini file along with their interpretations:

    [edit] server.ini

    As opposed to the dmcl.ini file, which contains configuration information required by clients, the information in the server.ini file is used by the server. The location of server.ini on a Windows Content Server host is:

    $DOCUMENTUM\dba\config\<Docbase name>

    In our case, the location of server.ini is: C:\Documentum\dba\config\dev_doc.

    Following are some of the keys defined in server.ini along with their interpretations.

    That's it! We have created our first Docbase and installed WebPublisher DocApp over it, making it ready to be used by Web Publisher. We can now go ahead and install Site Caching Services (SCS) Source and Target, so that the Docbase contents can be published out of the Documentum system.

    [edit] Setting Up Publishing

    Having set up the Docbases, we can now configure Documentum Site Caching Services (or SCS in short) in order to publish content and attributes from Documentum to our websites. This requires the installation of Documentum SCS software in the form of two components:

    • SCS Source component (installed on the Content Server machine that host the Docbase(s)
    • SCS Target component (installed on the web servers)

    We will first install SCS Source 5.2.5 on the Content Server machine and then upgrade it with the SP2 patch.

    Once the SCS Source software has been installed properly, we will install SCS Target 5.2.5 on the web server and then upgrade it with the SP2 patch.

    [edit] SCS Source 5.2.5

    You can run SCS Source and Target on machines with different operating systems and databases. For example, you could have the SCS Source configured on a Windows machine with SQL Server database and have the SCS Target on a UNIX machine with Oracle database. However, you should ensure that this is a combination certified by Documentum as per the published Release Notes.

    [edit] Prerequisites

    Following are some of the prerequisites we must take care of before installing SCS Source on Content Server:

    To begin, download the following SCS software installers from the Documentum site:

    • Site_Caching_Services_5.2.5_windows_source.exe
    • Site_Caching_Services_5.2.5_SP2_all.zip

    [edit] Installing SCS Source 5.2.5

    We will first install SCS Source 5.2.5 on the Content Server host and then upgrade it with the service pack 2 (SP2) patch.

    1. Log in to Content Server host as the Documentum installation owner, extract Site_ Caching_Services_5.2.5_windows_source.exe, and run the following executable: SCSSourceWinSuiteSetup.exe.
    2. Click the Next button.
      Initial screen for installation of SCS Source
      Initial screen for installation of SCS Source
    3. Accept the license agreements and click the Next button.
    4. Optionally choose to install developer documentation and click the Next button.
    5. Provide the password for the Content Server installation owner and click the Next button.
    6. Provide the primary port numbers for the SCS Source Tomcat instance and administrator instance. We can specify ports that are currently not in use by any other application, or use the defaults provided by the installer. Click the Next button.
      Specifying ports for SCS Source service
      Specifying ports for SCS Source service
    7. The components to be installed are shown. Click the Next button.
      List of components to be installed
      List of components to be installed
    8. The SCS Source installation program requires configuration of existing Docbases on the Content Server machine. Note that we can always skip this option and later configure the Docbase in question by running the executable config.exe from %DM_HOME%\ webcache\install.DM_HOME% on a Windows machine would typically be: C:\Documentum\product\<product version>
      Running the configuration program
      Running the configuration program
    9. Choose the Docbase on which the SCS configuration program needs to be run and click the Next button.
      Selecting the Docbase for SCS Source configuration
      Selecting the Docbase for SCS Source configuration
    10. The configuration program installs SCSDocApp on the selected Docbase, configuring the Docbase to be used with SCS services. The following objects are installed as part of SCSDocApp:
      • dm_webc_config object type
      • dm_webc_target object type
      • webc_lock object type
      • dm_SCSLogPurgeJob job
      • dm_SCSLogPurge method
      PostInstall procedure Click Finish once the DocApp has been installed.
    11. Restart the service Documentum SCS_source_<port number> (for example: Documentum SCS_source_6677 if SCS Source is configured on default port 6677).

    This completes the installation of SCS Source 5.2.5. We can now safely go ahead and install service pack 2 over this installation.

    Every time a new Docbase has been created, we need to run the SCS Source configuration program (config.exe) from %DM_HOME%\webcache\install on the Content Server host. Failing to do so will result in errors during publishing from the Docbase in question.

    [edit] Installing SCS Source 5.2.5 SP2

    1. Extract Site_Caching_Services_5.2.5_SP2_all.zip on the Content Server host and copy the webcache.jar file to the following location on the Content Server host: %DM_HOME%\webcache\tomcat\webapps\webcache\WEB-INF\lib Example: A typical location on Windows could be: C:\Documentum\product\5.2\webcache\tomcat\webapps\webcache\WEB-INF\lib
    2. Restart the SCS Source service.

    That's it! We are done with upgrading SCS Source to SP2 and can now install SCS Target 5.2.5 and then upgrade it with service pack 2.

    If the SCS Source service is not running, the following error message is seen when trying to publish using Site Caching Services from a Docbase:
    Error occurred while publishing the Site Publishing Configuration
    [DM_METHOD_E_HTTP_COMMUNICATION]error: "Failed to obtain socket for host:localhost, at port:6677"

    [edit] SCS Target 5.2.5

    We will first install SCS Target software on the web server machine and then apply the SP2 pack over it.

    [edit] Prerequisites

    Following are some of the prerequisites for installing SCS Target on the web server host:

    To begin, download the following SCS Target software installation files from the Documentum site:

    • Site_Caching_Services_5.2.5_windows_target.exe
    • Site_Caching_Services_5.2.5_SP2_all.zip

    [edit] Installing SCS Target 5.2.5

    We will first install SCS Target 5.2.5 on the web server host and then upgrade it with service pack 2 (SP2).

    1. Log in to the web server host as the SCS installation owner, extract Site_Caching_Services_5.2.5_windows_target.exe and run the following executable: SCSTargetWinSetup.exe
    2. If SCS Target needs to be installed and configured with a database, a DSN needs to be setup before hand so that connectivity can be established to the specified Database. Set up a DSN (Data Source Name) on the SCS Target machine, in the way we did when we created our first Docbase. Recall that the DSN can be created on a Windows machine by going to Programs | Administrative Tools | Data Sources (ODBC).
    3. On running the SCS Target Installer, the following screen is shown. Click the Next button.
      Initial screen for installing SCS Target
      Initial screen for installing SCS Target
    4. Accept the license agreement and click the Next button.
    5. Either choose the default installation directory shown or provide a new path. Click the Next button.
      Destination directory for SCS Target
      Destination directory for SCS Target
    6. The Documentum SCS installation directory is shown to user for a preview. Click the Next button.
    7. After installation has been completed, run the configuration program to configure the SCS Target software. Click the Next button.
      Running configuration program for SCS target
      Running configuration program for SCS target
    8. A confirmation screen is shown for configuring SCS Target. Click the Next button.
    9. Select whether you need a secure (HTTPS) or a non-secure (HTTP) connection between the Content Server host machine and the target machine.
      Specifying connection type
      Specifying connection type
    10. If non-secure communication (HTTP) has been chosen, the default port 2788 can be selected. If secure communication (HTTPS) has been chosen, the default port shown is 2787. We can provide any other port number as well, provided the port is not being used by any other application. Click the Next button.
      Specifying port number
      Specifying port number
    11. Specify the target data transfer directory. We can choose the default shown or provide any other convenient location. Click the Next button.
      Data transfer directory
      Data transfer directory
    12. Specify the domain or server against which the transfer user's password is authenticated by SCS software. Click the Next button.
    13. We can choose to configure SCS Target software without a database (for storing object attributes/metadata), or choose the database type and click the Next button.
      Specifying database
      Specifying database
    14. We can either have an already existing database and account, or create a new one using the installation wizard. Click the Next button.
      Setting up a database account
      Setting up a database account
    15. Choose the existing ODBC data source from the dropdown and provide the database system user name and password. Click the Next button.
      Choosing existing data source
      Choosing existing data source
    16. Either choose the default database name and related information or provide the database parameters (data device file path and log device file path) yourself. Click the Next button.
      Specifying database information
      Specifying database information
    17. Provide the database user's name and password and click the Next button.
      Specifying database user credentials
      Specifying database user credentials
    18. The JDBC driver and database connection URL information is shown to the user. We can customize the JDBC driver and/or database connection URL by selecting the Customize checkbox. Click the Next button.
      Database connection URL and JDBC driver information
      Database connection URL and JDBC driver information
    19. Choose the option to start the SCS Target service and click the Next button.
      Starting SCS Target instance
      Starting SCS Target instance
    20. Click on Finish to complete the SCS Target installation and configuration process.

    We are done with installation of SCS Target 5.2.5 on the web server host. The next task is to apply service pack 2 to it. As part of SCS Target configuration, Documentum modifies the agent.ini file on SCS Target host at the following location:

    <SCS Target Installation Directory>\admin\config\<SCS Target port>

    On Windows, a typical location would be: C:\Documentum\SCS\admin\config\2788

    The following snippet is from the agent.ini file that stores the database information for SCS Target that we just installed above:

    target_database_connection=jdbc:odbc:SCS_TARGET_PUBLISHING_DSN
    database_user=sa
    database_user_pass=systempass
    JDBC_DRIVER=sun.jdbc.odbc.JdbcOdbcDriver
    database_name=WebCache_2788
    

    [edit] Installing SCS Target 5.2.5 SP2

    We will now install SCS Target 5.2.5 SP2 on the web server host.

    1. Stop the SCS target service and extract Site_Caching_Services_5.2.5_SP2_all.zip on the web server host. This ZIP contains the webcache.jar file.
    2. Copy the extracted webcache.jar file at the following location on the web server host: <SCS Target Installation Directory>\product\jre\win\lib\ext Example: A typical location on Windows could be: C:\Documentum\SCS\product\jre\win\lib\ext
    3. Restart the SCS Target service.

    If the SP2 upgrade is not done correctly, the following error message is seen during publishing, if there is a mismatch in the versions of webcache.jar on the Content Server host and the web server host (for SCS Source and Target):

    ERROR: Failed to login to the target server. Network error retrieving target result com.documentum.webcache.utils.d; Local class not compatible: stream classdescserialVersionUID=1602290069170353386 local class serialVersionUID=4590497449032455007

    That's it! We have finished upgrading SCS Target to SP2. We are now ready to publish content and metadata from Documentum.

    [edit] Setting Up Documentum Application Builder

    Documentum Application Builder (earlier known as Documentum Developer Studio) is a tool used to create Documentum application packaging units (called DocApps) which consist of object types, lifecycles, workflow templates, and other Documentum objects.

    A DocApp can be created using Documentum Application Builder and can be archived and deployed over to other Docbases using Documentum Application Installer.

    A DocApp can comprise numerous kinds of Documentum objects, such as:

    • Object types
    • Lifecycles
    • Workflow templates
    • Permission Set templates
    • Alias Sets
    • Jobs
    • Methods
    • Procedures
    • Relation Types
    • Data Objects

    Using Documentum Application Builder (DAB) we can create these objects via simple graphical wizards. Note that Workflow Manager is specifically required for creating Workflow templates. Installing DAB automatically installs Workflow Manager as well. Workflow Manager is seamlessly integrated with DAB and hence it can be opened either from within DAB or as a standalone application.

    [edit] Documentum Application Builder

    'Documentum 'Application Installer (DAI), used for deploying Documentum DocApps, is also installed along with DAB installer if the user chooses the option correctly. Using a simple user interface, we can create different kinds of Documentum objects in our own custom DocApps, without worrying about details like Docbase connections and sessions.

    Note that DAB need not be installed on the Content Server host. It can be installed on a separate desktop as long as the DocBroker connectivity for the Docbase in question is available.

    Figure shows Web Publisher objects in the WebPublisher DocApp we installed in our custom Docbase.

    WebPublisher DocApp as seen in Documentum Application Builder
    WebPublisher DocApp as seen in Documentum Application Builder

    [edit] Prerequisites

    Following are some of the prerequisites for installing Documentum Application Builder 5.2.5 SP2 and its associated components:

    [edit] Installing DAB 5.2.5 SP2

    Ensure that you have downloaded the installer software Application_Builder_5.2.5_SP2_windows.exe from the Documentum download site.

    1. Extract the executable Application_Builder_5.2.5_SP2_windows.exe on the desktop machine and run setup.exe.
    2. Click the Next button.
      Initial screen for installing DAB
      Initial screen for installing DAB
    3. Select the checkboxes for both Application Builder and Application Installer and click the Next button.
      Choosing the tools to be installed
      Choosing the tools to be installed
    4. Optionally choose to install DFC documentation and click the Next button.
      Selecting optional features to be installed
      Selecting optional features to be installed
    5. Specify the primary DocBroker host machine and port number (default shown) so that the Servers projecting to the specified DocBroker can be connected to by DAB.
    6. Click the Next button.
      Specifying DocBroker host and port
      Specifying DocBroker host and port

      Behind the scenes, Documentum creates the dmcl.ini file under C:\WINNT or C:\WINDOWS (depending on the OS) on the desktop machine and adds the following entries:

       [DOCBROKER_PRIMARY]
       host =content-server_host
       port =1489
      

      Once DAB has been installed, if someone mistakenly changes the name of the specified DocBroker host to an invalid value (say content-server_host222) in dmcl.ini, then the following error message is seen on opening DAB:

      '[DM_DOCBROKER_E_HOST_NAME]error: Unable to find host with name: content-server_' host222. Network specific error: Host not found. Network error: invalid host name.

    7. The list of components that will be installed is shown. Click the Next button.
      List of components to be installed
      List of components to be installed
    8. Restart the system once installation finishes.

    After the machine has rebooted, you will see Application Installer, Workflow Manager, and Application Builder icons under Start | Programs | Documentum.

    DAB and associated tools
    DAB and associated tools

    DAB sometimes crashes after entering login/password information, if the classpath information for the system and the user environmental variables are different. Make these identical to resolve this issue.

    The following error message is seen in such circumstances:
    ERROR: Dab.exe - Application Error
    The instruction at 0x6d393c07 referenced memory at 0x00000000 .
    Click OK to terminate the program.
    Click CANCEL to debug the program

    Now that Documentum Application Builder has been installed, you can start playing around with it and create custom objects required for your specific business needs.

    [edit] Setting Up Documentum Administrator and Web Publisher

    Documentum Administrator (DA) is a web-based tool that allows administrators to perform system administration and monitoring activities on Documentum Docbases, servers, federations, etc.

    To access Documentum Administrator and connect to the respective Docbase and configure/monitor the various Docbase objects, all that a system administrator requires is a web browser. DA is an extremely powerful tool that assists an administrator in performing routine administrative tasks and scores of other activities.

    It is worth mentioning that Documentum Administrator has been developed using the WDK framework.

    [edit] Documentum Administrator

    Documentum Administrator software is installed as a web application on supported application server platforms such as Tomcat, BEA WebLogic, WebSphere, and Oracle AS. Here, we will install Documentum Administrator and Web Publisher on Apache Tomcat.

    Please keep the following prerequisites in mind before we proceed with the installation and configuration of Documentum Administrator.

    [edit] Prerequisites

    The table below lists some of the prerequisites for installing Documentum Administrator:

    Figure 9.1: Prerequisites for installing DA

    To begin, download the following:

    • Documentum Administrator 5.2.5 SP2 software installer (Administrator_5.2.5_SP2_windows.exe) from the Documentum site.
    • jakarta-tomcat-4.1.30.exe from the Apache Jakarta Tomcat homepage (http://jakarta.apache.org/tomcat/)

    [edit] Installing Documentum Administrator 5.2.5 SP2

    We will now mention the steps involved in installing Documentum Administrator 5.2.5 SP2:

    1. Log in to the application server host as the application server installation owner and install Apache Tomcat 4.1.30 Servlet container before installing DA. For details on the installation of Tomcat, please refer to Tomcat documentation available from the Apache Jakarta site.
    2. After Tomcat 4.1.30 has been installed on the application server host, the following system environment variables need to be set: o JAVA_HOME: This is the Java installation directory, for example, C:\j2sdk1.4.2 o CATALINA_HOME: This is the Tomcat installation directory, for example, C:\Tomcat 4.1
    3. Startup Tomcat 4.1.30 to ensure that it has been installed correctly before proceeding with DA installation. Run the batch file startup.bat located under %CATALINA_HOME%\bin. Once Tomcat has started up, open the default Tomcat page by invoking the following URL from your web browser: <app serverhost>:<port>/index.jsp. http://<app serverhost>:<port>/index.jsp.
      Tomcat home page
      Tomcat home page
    4. Stop Tomcat server before beginning the installation of Documentum Administrator 5.2.5 SP2. Extract Administrator_5.2.5_SP2_windows.exe on the application server host as the application server installation owner. Run the daWinSetup.exe executable.
    5. Click the Next button.
      DA Installer components to be installed
      DA Installer components to be installed
    6. Accept the License agreement terms and conditions and click the Next button.
    7. Optionally choose to install Developer Documentation and click the Next button.
    8. If Documentum already exists on the machine, the Documentum Destination directory screen will not be shown. If Documentum is being installed for the first time on the application server host, the default destination directory (C:\Program Files\Documentum) is shown. Either choose a different destination directory or continue with the default and click the Next button.
    9. If Documentum already exists on the machine, the Documentum user directory screen will not be shown. If Documentum is being installed for the first time on the app server host, the default user directory (C:\Documentum) is shown. Either choose a different user directory or continue with the default and click the Next button.
    10. If Documentum already exists on the machine, the primary DocBroker info screen will not be shown. If Documentum is being installed for the first time on the app server host, provide the name of the primary DocBroker host, and the port number (the default port number is 1489), and click the Next button.
    11. Select the application server on which DA will be installed. Click the Next button.
      Selecting application server for installing DA
      Selecting application server for installing DA
    12. Ensure that you have stopped Apache Tomcat application server before continuing with the installation setup. Click the Next button.
    13. Provide the Tomcat app server home directory and the name of the DA web application (virtual directory). Choose the defaults shown on the screen and click the Next button.
      Specifying Tomcat server information
      Specifying Tomcat server information
    14. Choose the default content transfer folder or provide a new one. Click the Next button. The default folder shown on the screen is C:\Documentum\contentXfer\da.
    15. Do not select the option for installing virtual link support and click the Next button. DA does not require virtual link support to function.
    16. The list of products/supported components to be installed with the DA installation will be shown. Click the Next button and finish the installation by pressing the Finish button.
    17. Start Tomcat and invoke the following URL from your web browser to ensure that DA has been installed correctly: http://<app servername>:<port>/da.

    If you have specified a virtual directory other than da, then substitute da in the above URL with the name you have specified.

    We have reached the last rung of the ladder as far as Documentum WCM software installation is concerned for our purposes. Having installed Documentum Administrator, we can now go ahead and install Web Publisher 5.2.5 SP2 on the same application server host that is hosting DA.

    [edit] Web Publisher

    The prerequisites for installing Documentum Administrator hold good for Web Publisher as well. You may want to refer to the prerequisites mentioned for DA in figure 9.1. Additionally, Web Publisher Server files and WebPublisher DocApp must be installed on the Content Server host so that Web Publisher can work properly.

    [edit] Prerequisites

    Before you begin the installation procedure, download:

    • Web Publisher 5.2.5 SP2 software installer (Web_Publisher_5.2.5_SP2_windows.exe) from the Documentum site.
    • Jakarta-tomcat-4.1.30.exe from the Apache Jakarta Tomcat homepage: http://jakarta.apache.org/tomcat/ (Download this only if Tomcat 4.1.30 has not been installed on the application server machine.)

    [edit] Installing Web Publisher 5.2.5 SP2

    We will now mention the steps involved in installing Web Publisher 5.2.5 SP2:

    1. Log in to application server host as the application server installation owner and install Apache Tomcat 4.1.30 Servlet container before installing Web Publisher. Note that this step has to be executed only if Tomcat does not exist on the application server machine. If you have installed DA, you would have already installed/configured Tomcat and hence this step can be avoided. For details surrounding installation of Tomcat, please refer to the Tomcat documentation available from the Apache Jakarta site.
    2. Assuming that Tomcat 4.1.30 has been installed correctly, stop Tomcat server and extract Web_Publisher_5.2.5_SP2_windows.exe on the application server host as the application server installation owner. Run wpWinSetup.exe.
    3. Click the Next button.
      Web Publisher list of installer components
      Web Publisher list of installer components
    4. Accept the license terms and agreements and click the Next button.
    5. Optionally choose to install Developer Documentation and click the Next button.
    6. If Documentum already exists on the machine, the Documentum Destination directory screen will not be shown. If Documentum is being installed for the first time on the application server host, the default destination directory (C:\Program Files\ Documentum) is shown. Either choose a different destination directory or continue with the default and click the Next button.
    7. If Documentum already exists on the machine, the Documentum user directory screen will not be shown. If Documentum is being installed for the first time on the application server host, the default user directory (C:\Documentum) is shown. Either choose a different user directory or continue with the default and click the Next button.
    8. If Documentum already exists on the machine, the primary DocBroker info screen will not be shown. If Documentum is being installed for the first time on the application server host, provide the name of the primary DocBroker host, and the port number (the default port number is 1489), and click the Next button.
    9. Select the application server on which Web Publisher will be installed. Click the Next button.
      Selecting an application server for installing Web Publisher
      Selecting an application server for installing Web Publisher
    10. Ensure that you have stopped Apache Tomcat application server before continuing with the installation setup. Click the Next button.
    11. Provide the Tomcat application server home directory and the name of Web Publisher web application (virtual directory). Choose the defaults shown on the screen and click the Next button.
      Specifying Tomcat server information
      Specifying Tomcat server information
    12. Choose the default content transfer folder or provide a new one. Click the Next button. The default folder shown on the screen is: C:\Documentum\contentXfer\wp.
    13. Select the option for installing virtual link support only if you wish to integrate Ektron eWebEditPro rich-text editor with Web Publisher. Click the Next button.
      Specifying virtual link enablement
      Specifying virtual link enablement
    14. The list of products and supported components to be installed with the Web Publisher installation will be shown. Click the Next button and finally finish the installation by pressing the Finish button.
    15. Start Tomcat and invoke the following URL from your web browser to ensure that Web Publisher has been installed correctly: <app servername>:<port>/wp http://<app servername>:<port>/wp.

    As in the case of DA, if you have provided a different virtual directory for Web Publisher than wp, substitute wp in the above URL with the name you have specified.

    That's it! All the necessary Documentum products have been installed and configured for our use. Once the WCM architecture is in place and the necessary product suite has been set up, we can start designing and implementing our applications.

    [edit] Source

    The source of this content is Web Content Management with Documentum by Gaurav Kathuria (Packt Publishing , 2006).

  • Personal tools