EMC Documentum - xCP 2.x Installation and Deployment

1 EMC CONFIDENTIAL—INTERNAL USE ONLY

XCP Installation and Deployment

Developed By: Ajay Iyer

mailto:[email protected]


Intended Audience

Support Engineers starting to learn xCP and trying to deploy environments

Engineers seeking knowledge on debugging and investigating failed xCP deployments


Agenda

1. XCP installation overview

2. XMS agent installation and configuration

3. Common deployment roadblocks

4. Deploying a basic XCP application

5. Designer performance settings

6. How to diagnose deployment failures?

7. References


XCP Installation

Laundry list of components that need to be installed for successful xCP deployment

– JDK

– CS and DFC

– Thumbnail server

– Document Image Services (DAR)

– xCP Viewer Services

– xPlore

– CIS


XCP Installation

Laundry list continues

– CTS (AVTS and MTS are optional)

– DA

– Process engine

– App Server (Tomcat or TC server etc)

– Process Integrator

– xMS agent

– XMS tools

– xCP Designer


XCP Installation – Verification URLs

You can verify the required components by using the URLs below

Thumbnail server - http://localhost:8082/thumbsrv/getThumbnail

Documentum Administrator - http://localhost:8080/da

BAM server - http://localhost:8080/bam-server/

BPS Inbound Details - http://localhost:8080//bps/inbound_details.jsp

xMS-Agent Status - http://localhost:8078/xms-agent/

xPloredsearch - http://localhost:9300/dsearch/

EMC|Documentum Index Agent - http://localhost:9200/IndexAgent/

CTS agent - http://localhost:9095/CTSAgent/CTSAgent

IMPORTANT: Please review the xCP Deployment guide in conjunction with this presentation while setting up xCP environment.

http://localhost:8082/thumbsrv/getThumbnail

http://localhost:8082/thumbsrv/getThumbnail

http://localhost:8080/da/component/main?__dmfClientId=1360957592661&__dmfTzoff=300&__dmfRequestId=__client1~~2&__dmfJumpType=jump&__dmfTzoff=300

http://localhost:8080/da/component/main?__dmfClientId=1360957592661&__dmfTzoff=300&__dmfRequestId=__client1~~2&__dmfJumpType=jump&__dmfTzoff=300

http://localhost:8080/da

http://localhost:8080/da

http://localhost:8080/bam-server/





http://localhost:8080/bps/inbound_details.jsp





http://localhost:8078/xms-server/









http://localhost:9300/dsearch/



http://localhost:9200/IndexAgent/




http://localhost:9095/CTSAgent/CTSAgent






XCP App server set up

Set up App server

Setting up App server is crucial to avoid deployment set backs

Ideal Tomcat JVM settings for xMS server

-Dcatalina.home=C:\Tomcat 7.0 -Dcatalina.base=C:\Tomcat 7.0

-Djava.endorsed.dirs=C:\Tomcat 7.0\endorsed -Djava.io.tmpdir=C:\Tomcat 7.0\temp

-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager -Djava.util.logging.config.file=C:\Tomcat 7.0\conf\logging.properties

-XX:MaxPermSize=256M -XX:+UseParallelOldGC

-Xdebug -Xnoagent

-Xrunjdwp:transport=dt_socket,server=y,suspend=n -Dbam.properties=C:\Tomcat 7.0\bam\bam.properties (Needed only if BAM is in the same host)

-Dlog4j.configuration=C:\Tomcat 7.0\bam\log4j.properties (Needed only if BAM is in the same host)

For TC Server please refer deployment guide


XMS - Provisioning

xCP Deployment Methods

Automated – xMS manages and provisions deployment environments into VMware infrastructure as vApps in vSphere or

vCloud director.

Orchestrated - XMS manages environments using the provided physical or virtual machine names. xMS installs

components on those machines.

Manual/DIY – Build and manually install xCP components into physical or virtual machines. You still use xMS to deploy

xCP applications into the manually built environment


XMS Agent Installation

xMS Agent Installation

Download latest patch version of xms-agent.war

Deployment war file to Tomcat, tc-server or any other App server applicable


XMS Tools

xMS tools – Set up admin user

Download xms tools

Set up XMS agent admin password by

– Navigating to C:\xms-tools-1.1\bin

– Open xms.bat file

– You will be prompted to change admin password

Above ‘admin’ user and password will be used to login to xMS agent


XMS Tools

xMS tools – Import template

Import environment template/blueprint to set up you environment

– Xms> import-configuration --file ../config/bootstrap-dctm-configuration.xml

– xms>import-configuration --file ../blueprints/module-templates/xCP-2.1-Developer-Environment-Template.xml


XMS Agent - Environment Setup

Login to XMS Agent

Click Create Environment (Note: only one environment is allowed per XMS agent)



Login to XMS Agent

Click Create Environment (Note: only one environment is allowed per XMS agent)



Set up Hosts, services and register

Hosts are the server that are hosting your xCP components like BAM, xPlore, CIS etc.

Configure the URL, ports, user and passwords for all services such as Repossitory, BAM, xPlore, CIS etc

Upon clicking save, if all components were configured correctly, your environment will be “Registered”



Create new manual provisioning environment



Set up default system account for service to authenticate



Create host groups which will contain one or more hosts.

A host group can have multiple hosts.

For e.g. HostGroup1 can have hostA , hostB and hostC; where hostA is xPlore host, hostB is BAM and hostC contains CTS

Above configuration is specifically helpful when your xCP components are deployed at disparate hosts.



Configure xcp service endpoints

This allows environment to connect with the dependent services services



Enter end-points for every service. xPlore service example below



Configure the service account credentials and select host



Click Maintenance to synchronize



Now synchronize environment



If synchronization is successful, the environment status should reflect as Provisioned.


Deployment Roadblocks

XCP 2.1 is installed with xPlore 1.3

XCP 2.1 deployment fails in environment containing xPlore 1.3

[[ERROR] Error accessing xPlore server on host ajxcp2.dctmlabs.com and port 9300

[ERROR] com.emc.documentum.core.fulltext.common.admin.DSearchAdminException: [ERROR] WebServiceException thrown out:

[ERROR] javax.xml.ws.WebServiceException:

{http://controller.admin.indexserver.fulltext.core.documentum.emc.com/}ESSAdminWebServiceService is not a valid service. Valid services are: {http://ws.controller.admin.indexserver.fulltext.core.documentum.emc.com/}ESSAdminWebService

Replace xplore jars in xms agent lib directory

Refer xCP Deployment Guide topic Configuring “xMS 1.1 to work with xPlore 1.3”


Deployment Roadblocks - 2

Tomcat roles need to be configured. If not done, you might encounter the error below

[INFO] Connection to:http://localhost:7070/manager/text/deploy was false

[ERROR] Error deploying to application server, app not deployed [ERROR] java.lang.Exception

[ERROR] internal.com.emc.xcp.deployment.wardeployer.tcserver.TCServerWarDeployer.deploy [ERROR] at internal.com.emc.xcp.deployment.deployer.factory.WarDeployerFactory.deploy

Create a user for the Tomcat server. xCP Designer uses this user to deploy the xCP application.

For example, edit <application_server_home> \conf\tomcat-users.xml

Add a user name and password as shown in the following code sample: <?xmlversion="1.0"?>

<tomcat-users>

<user name="USER_NAME" password="PASSWORD" roles="admin-gui,

manager-gui,manager-script" />

</tomcat-users>


Deployment Roadblocks - 3

Repository name configuration is needed

message Invalid syntax for the docbase connect string '${xcp.repository.name}'. The docbase/host separator, '@', and the docbase/server separator '.' can only appear once. description The server encountered an internal error that prevented it from fulfilling this request. exception java.lang.IllegalArgumentException: Invalid syntax for the docbase connect string '${xcp.repository.name}'.

The docbase/host separator, '@', and the docbase/server separator '.' can only appear once.

Create deployment.properties under <xcpapp>/WEB-INF/classes in deployment app server

Set xcp.repository.name=<repo name>


xCP Designer – Set up

Deployment Settings

Development environment use preferences

– Data Policy: Incremental

– Deployment method: Minimal

Production environment use preferences

– Data Policy: Incremental

– Deployment method: Maintain



While working on SR, request xCP app from customer and deploy in-house

Import customer App as shown below



Configure Deployment environment



Editing deployment preferences

– To edit Project preferences, click preferences button on Designer menu

– Click “Run Configurations ”, choose a configuration and click Edit

– As shown screenshot below, change preferences and click Finish.


xCP Designer – Performance

Increase JVM memory heap size

– Navigate to XCPDesigner directory

– Edit xcpdesigner.ini file

– Change Xms and Xmx parameters as below, the save file and restart designer.

– -Xms512m

– -Xmx1200m


xCP Deployment - Logs

In case xCP app deployment fails, check the xms agent logs in location below

– Check the xCPDesigner.log under designer logs directory

– <webapp>\xms-agent\WEB-INF\logs\xms.log

– <webapp>\xms-agent\WEB-INF\logs\xms- full.log (Debug Log information)


xCP – Q & A

Questions?

EMC Documentum - xCP 2.x Installation and Deployment

Software

Transcript of EMC Documentum - xCP 2.x Installation and Deployment