xMS – xMS Server installation

The xMS – Tools are a collection of folders and files. The “installs” folder for example contains all the description and binary files of Documentum and xCP 2.0.
The “bin” folder contains the installation-description files (bat files for windows and SH files on Unix) to execute the xms-server and monitoring-server installation.

The xMS Server is the engine that executes xMS commands. The xMS Management Center is a web interface to interact with the server. This chapter describes the installation of xMS Management Center.

Operating System

  • Microsoft Windows Server 2008 R2 Service Pack 1 (64-bit)
  • Microsoft Windows Server 2012 (64-bit)

Application Server

  • Apache Tomcat 7.0.42
  • VMware vFabric tc Server 2.9.3

Third-party Software

  • Java JDK 1.7.25
    Don’t use the default directory. Install Java near the root directory without whitespaces and not in the “C:\Program Files (x86)” folder.
  • VMware Tools
java_home_settings
Java was not installed in the default directory. Blanks can cause problems.

Web Browsers

  • Internet Explorer 9 or 10
  • Firefox
  • Google Chrome (current version 32 works fine)

Windows Server Preparation

  • Update Windows (don’t install IE 11)
  • Disable UAC (User Account Control) in the user settings
  • Disable IE ESC (Enhanced Security Configuration) in the server manager
  • Set JAVA_HOME to the JDK root directory
  • Enable RDP (Remote Desktop Protocol) and add/select additional users
  • Copy the “installs” folder (its named “Media Location”) to a network storage location or to your NAS. Make sure to share this folder to the selected known users.

Server config file

media-location is the network path to the installation folder
media-location-username is one of the usere who has access to the media-location
the following properties may be commented out or in

bootstrap-configuration=../bootstrap-dctm-configuration.xml
# The Media Location in UNC Format.Value should not end with a (backslash) character. Double Quote value if backslash necessary.
media-location=\\\
# Username to access Media Location. Value should not end with a (backslash) character. Double Quote value if backslash necessary
media-location-username=
#Application server absolute installation Path(Directory name should not contain space)
install-dir=C:\tcServer
#install-dir=C:\tomcat
#Application Server product name(tcServer or tomcat)
appserver-name=tcServer
#appserver-name=tomcat
# Specify AppServer version which you want to use to deploy xMS server war
appserver-version=2.9.3.SE
#appserver-version=7.0.42
xms_install_success_server_status_1
xMS 1.1 server status
xms_install_success
xMS Server installation successful

xCP environment registration Part III

The xMS Agent reffered to the xms-env-registration-ui.bat file. In this user-interface you can add all your available Documentum components (eg.: Repository, CTS, CIS, BAM, etc).

xms_app_registration_detail_000064
The manual registration is only necessary if you don’t use the xMS Server and the blueprint installation.

This Agent make your xCP application in your do-it-yourself-environment available.

If the utility is accessing the xMS Agent for the first time, it prompts you to set a password for the
default admin user. Use this password for subsequent access to the utility.

You do not have to create additional system accounts, because there can be only one SERVICE account per environment.

You can use the SERVICE_ENDPOINT system account type, if you want to create a generic account for use across several vDCs. SERVICE_ENDPOINT is specific to each environment, and you need to specify it in the environment profile XML file for each environment.xms_app_registration_detail_000065

This screenshot was taken from the xMS Agent environment registration utility.

Register your environment manually. Create a new environment blueprinte file and register all the recommended Documentum components:
Repository: Content Server Ver.7.0
BAM: BAM-Server 2.0
App Host: Tomcat Server 7.0.29
Documentum Administrator: DA 7.0
Search: xPlore 1.3
BPS: Process Integrator 2.0
Content Intelligence Server: CIS 7.0
Content Transformation Server: CTS 7.0
(optional) Thumbnail Server 7.0

xms_app_registration_detail_000066
This screenshot displays the registration of the primary repository. You can add as many repositories you like.

Save your settings and restart the xMS Agent. Remember: the agent is part of the app server (Tomcat) webapps. Please restart the Tomcat services on your host windows server.
Wait until all webapps was successfully (re)deployed.

xCP environment registration Part II

The heart of the xCelerated Management System version 1.0 are the xms-tools.

xms_bin_folder
All files located in the bin folder of the xms-tools-1.0 package.

The tool include the Command Line Interface (CLI) , the xMS Agent, the xMS Server and some batch files.
The xms.bat is called CLI in the documentation and located in the main bin folder. Ensure you have set the xms-server.properties file correctly (located in the folder config). The CLI is not only a small administrative command tool, you can display all environments (show-environments) or one in detail (show-environment-details –name test_xcp) , import and export the configuration, show/create/disable users and execute the deployment into the registed environment.

xms_tools_000070
xMS Tools version 1.0
2013 © Mr.Crazyapple

The xMS Server is only available, if you have installed the vFabric tc Server in your VMWare environment.

The xMS Agent reffered to the xms-env-registration-ui.bat. In this user-interface you can add all your available Documentum components (eg.: Repository, CTS, CIS, BAM, etc). This Agent make your xCP Applications in your environment available.

xms_app_registration000071
This screenshot shows all the commands that are executed in the CLI.

xCP environment registration Part I

Deploy xMS Agent on Apache Tomcat

This is part one of an additional guide to deploy the xms-server.war on a DIY Windows Environment. The next part describe the registration of an xCP environment manually.
If you are install xCP 2.0 on Windows you can download the compiled exe-package. The *.exe download package does not include the catalina.bat file, because the *.exe package installs tomcat as a Windows Service. The tomcat memory settings are set in the Apache Tomcat 7.0 Properties Application. The zipped package includes the catalina.bat file. The full requirements are listet on the D7 xMS preparation page.

  1. Stop Apache Tomcat 7.0 Services
  2. Copy the xms-server.war file in the Tomcat 7.0 webapps folder
  3. Rename the *.war extension to *.zip and extract the file and delete the original *.zip file afterwards
  4. Open cmd – the windows command center
    navigate to \webapps\xms-server\WEB-INF

     xcopy xms-agent-context.xml xms-server-context.xml

    ensure that the xms-agent-context and the xms-server-context files are equal

    <bean id="xmsServerConfigurator" class="com.documentum.xms.server.XmsServerConfiguration">
     <!-- Whenever an xMS agent is being deployed, set applicationType to "AGENT_TYPE" -->
     <property name="applicationType" ref="AGENT_TYPE"/>
     </bean>
  5. Open the Apache Tomcat 7.0 Properties Application and set:
    -XX:MaxPermSize=2048m

    Apache Tomcat 7.0 Properties
    Apache Tomcat 7.0 Properties
  6. Start Apache Tomcat Services
    wait >1 minutes until the xms-server is completely deployed
  7. check the deployment: http://<localhost>:<8080>/xms-server
    port 8080 for non SSL / port 8443 for SSL connection

    xms_app_registration_detail_000063
    Testwebpage to check the xMS Agent and xMS registered environment

Download Apache Tomcat 7.0.29 from the Apache archive.