EMCreg Documentumreg
Asset OperationsVersion 20
Installation Guide
EMC CorporationCorporate Headquarters
Hopkinton MA 01748-91031-508-435-1000wwwEMCcom
Legal Notice
Copyright copy 2013-2015 EMC Corporation All Rights Reserved
EMC believes the information in this publication is accurate as of its publication date The information is subject to changewithout notice
THE INFORMATION IN THIS PUBLICATION IS PROVIDED ldquoAS ISrdquo EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
Use copying and distribution of any EMC software described in this publication requires an applicable software license
For the most up-to-date listing of EMC product names see EMC Corporation Trademarks on EMCcom Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc in the US and other countries All other trademarksused herein are the property of their respective owners
Documentation Feedback
Your opinion matters We want to hear from you regarding our product documentation If you have feedbackabout how we can make our documentation better or easier to use please send us your feedback directly atECDDocumentationFeedbackemccom
Table of Contents
Preface 5
Chapter 1 Getting Started 7System Configuration 7Reviewing System Requirements 8Preparing the Installation Package 8Verifying the System Components 9Turning off the Default Audit Events for Content Server 9Packaging a Documentum D2 Configurations 10
Chapter 2 Installing Asset Operations 11Installation Scripts 11Installing Asset Operations on Microsoft Windows 12Installing Asset Operation Components on Content Server 12Installing Asset Operations on Application Server 13Installing on Tomcat 13Deploying EPFMAwar on Tomcat 14Installing on IBMWebSphere 14Deploying EPFMAwar 14Importing AO Configuration 15
Installing Asset Operations on Linux 16Installing on Content Server 16Installing on Application Server 17
Installing Components of Asset Operations Manually 18Importing the Documentum D2 Configuration Files 19Manually Updating the Custom Widget URLs D2 Dictionary andAlias Values 20Updating the D2 Configuration Dictionaries 20Updating the Connection Config File 20
Chapter 3 Completing the Installation 23Downloading the JasperReports 23Enabling the AOD2Plugins and Asset Operations JARs 23Removing the Conflicting jar Files 24Configuring the Documentum xPlore Facets 24Rebuilding the Documentum xPlore Indexes 25Configuring the System for PDF Rendering 26Enabling Document Types for Rich Media 26
Configuring the Syncplicity Cleanup Job 26Modifying the Alias for Mailing Lists and Emails 27
3
Table of Contents
Chapter 4 Upgrading Asset Operations from Version 11 to 20 29New Attributes 29Preparing for the Upgrade 31Run InstallAOProjectOnAS Installer 31Installing the D2 Config Manually 32Removing D2 Legacy Configurations 32
Chapter 5 Installing Documentum Asset Operations Mobile 35Updating the D2 Configuration dictionariestaxonomy 35Updating the AO Mobile Config 35
Chapter 6 Troubleshooting 37
4
Preface
This guide provides step-by-step procedures for installing the EMCreg Documentumreg AssetOperations solution It lists installation prerequisites and provides instructions for installing andupgrading the Asset Operations
The following documents are also available for EMC Documentum Asset Operationsbull EMC Documentum Asset Operations Release Notes Includes newly added features and detailedrequirements for this version This document also references some known problems andlimitations
bull EMC Documentum Asset Operations Configuration Guide The Configuration Guide provides usefulinformation for administrators to configure a user role dictionaries and taxonomies transmittalsand distribution lists work order and work order types and project package and return projectpackage
bull EMC Documentum Asset Operations Quick Reference Guide The Quick Reference Guide is designedto provide easy-to-use support for getting the best out of the Asset Operations solution
bull EMC Documentum Asset Operations Integration Guide The Integration Guide is designed to provideeasy-to-use support for integrating Asset Operations and AVEVA NET in a single interface
Intended AudienceThis guide is intended for administrators who have experience working with the Documentumplatform and managing Documentum applications through Documentum D2 Config
5
Preface
Revision History
Revision Date Description
September 2015 Updated the Installing Asset Operations on ApplicationServer page 13 and Installing Asset Operations on Linuxpage 16 sections to support Documentum 72
August 2015 Added an additional step in the section Installing onApplication Server page 17
Updated the section Updating the Connection ConfigFile page 20
August 2015 Initial publication
6
Chapter 1Getting Started
This chapter contains the following topicsbull System Configuration page 7
bull Reviewing System Requirements page 8
bull Preparing the Installation Package page 8
bull Verifying the System Components page 9
bull Turning off the Default Audit Events for Content Server page 9
System ConfigurationThe following figure illustrates the components that you can install with Asset Operations
7
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Legal Notice
Copyright copy 2013-2015 EMC Corporation All Rights Reserved
EMC believes the information in this publication is accurate as of its publication date The information is subject to changewithout notice
THE INFORMATION IN THIS PUBLICATION IS PROVIDED ldquoAS ISrdquo EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
Use copying and distribution of any EMC software described in this publication requires an applicable software license
For the most up-to-date listing of EMC product names see EMC Corporation Trademarks on EMCcom Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc in the US and other countries All other trademarksused herein are the property of their respective owners
Documentation Feedback
Your opinion matters We want to hear from you regarding our product documentation If you have feedbackabout how we can make our documentation better or easier to use please send us your feedback directly atECDDocumentationFeedbackemccom
Table of Contents
Preface 5
Chapter 1 Getting Started 7System Configuration 7Reviewing System Requirements 8Preparing the Installation Package 8Verifying the System Components 9Turning off the Default Audit Events for Content Server 9Packaging a Documentum D2 Configurations 10
Chapter 2 Installing Asset Operations 11Installation Scripts 11Installing Asset Operations on Microsoft Windows 12Installing Asset Operation Components on Content Server 12Installing Asset Operations on Application Server 13Installing on Tomcat 13Deploying EPFMAwar on Tomcat 14Installing on IBMWebSphere 14Deploying EPFMAwar 14Importing AO Configuration 15
Installing Asset Operations on Linux 16Installing on Content Server 16Installing on Application Server 17
Installing Components of Asset Operations Manually 18Importing the Documentum D2 Configuration Files 19Manually Updating the Custom Widget URLs D2 Dictionary andAlias Values 20Updating the D2 Configuration Dictionaries 20Updating the Connection Config File 20
Chapter 3 Completing the Installation 23Downloading the JasperReports 23Enabling the AOD2Plugins and Asset Operations JARs 23Removing the Conflicting jar Files 24Configuring the Documentum xPlore Facets 24Rebuilding the Documentum xPlore Indexes 25Configuring the System for PDF Rendering 26Enabling Document Types for Rich Media 26
Configuring the Syncplicity Cleanup Job 26Modifying the Alias for Mailing Lists and Emails 27
3
Table of Contents
Chapter 4 Upgrading Asset Operations from Version 11 to 20 29New Attributes 29Preparing for the Upgrade 31Run InstallAOProjectOnAS Installer 31Installing the D2 Config Manually 32Removing D2 Legacy Configurations 32
Chapter 5 Installing Documentum Asset Operations Mobile 35Updating the D2 Configuration dictionariestaxonomy 35Updating the AO Mobile Config 35
Chapter 6 Troubleshooting 37
4
Preface
This guide provides step-by-step procedures for installing the EMCreg Documentumreg AssetOperations solution It lists installation prerequisites and provides instructions for installing andupgrading the Asset Operations
The following documents are also available for EMC Documentum Asset Operationsbull EMC Documentum Asset Operations Release Notes Includes newly added features and detailedrequirements for this version This document also references some known problems andlimitations
bull EMC Documentum Asset Operations Configuration Guide The Configuration Guide provides usefulinformation for administrators to configure a user role dictionaries and taxonomies transmittalsand distribution lists work order and work order types and project package and return projectpackage
bull EMC Documentum Asset Operations Quick Reference Guide The Quick Reference Guide is designedto provide easy-to-use support for getting the best out of the Asset Operations solution
bull EMC Documentum Asset Operations Integration Guide The Integration Guide is designed to provideeasy-to-use support for integrating Asset Operations and AVEVA NET in a single interface
Intended AudienceThis guide is intended for administrators who have experience working with the Documentumplatform and managing Documentum applications through Documentum D2 Config
5
Preface
Revision History
Revision Date Description
September 2015 Updated the Installing Asset Operations on ApplicationServer page 13 and Installing Asset Operations on Linuxpage 16 sections to support Documentum 72
August 2015 Added an additional step in the section Installing onApplication Server page 17
Updated the section Updating the Connection ConfigFile page 20
August 2015 Initial publication
6
Chapter 1Getting Started
This chapter contains the following topicsbull System Configuration page 7
bull Reviewing System Requirements page 8
bull Preparing the Installation Package page 8
bull Verifying the System Components page 9
bull Turning off the Default Audit Events for Content Server page 9
System ConfigurationThe following figure illustrates the components that you can install with Asset Operations
7
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Table of Contents
Preface 5
Chapter 1 Getting Started 7System Configuration 7Reviewing System Requirements 8Preparing the Installation Package 8Verifying the System Components 9Turning off the Default Audit Events for Content Server 9Packaging a Documentum D2 Configurations 10
Chapter 2 Installing Asset Operations 11Installation Scripts 11Installing Asset Operations on Microsoft Windows 12Installing Asset Operation Components on Content Server 12Installing Asset Operations on Application Server 13Installing on Tomcat 13Deploying EPFMAwar on Tomcat 14Installing on IBMWebSphere 14Deploying EPFMAwar 14Importing AO Configuration 15
Installing Asset Operations on Linux 16Installing on Content Server 16Installing on Application Server 17
Installing Components of Asset Operations Manually 18Importing the Documentum D2 Configuration Files 19Manually Updating the Custom Widget URLs D2 Dictionary andAlias Values 20Updating the D2 Configuration Dictionaries 20Updating the Connection Config File 20
Chapter 3 Completing the Installation 23Downloading the JasperReports 23Enabling the AOD2Plugins and Asset Operations JARs 23Removing the Conflicting jar Files 24Configuring the Documentum xPlore Facets 24Rebuilding the Documentum xPlore Indexes 25Configuring the System for PDF Rendering 26Enabling Document Types for Rich Media 26
Configuring the Syncplicity Cleanup Job 26Modifying the Alias for Mailing Lists and Emails 27
3
Table of Contents
Chapter 4 Upgrading Asset Operations from Version 11 to 20 29New Attributes 29Preparing for the Upgrade 31Run InstallAOProjectOnAS Installer 31Installing the D2 Config Manually 32Removing D2 Legacy Configurations 32
Chapter 5 Installing Documentum Asset Operations Mobile 35Updating the D2 Configuration dictionariestaxonomy 35Updating the AO Mobile Config 35
Chapter 6 Troubleshooting 37
4
Preface
This guide provides step-by-step procedures for installing the EMCreg Documentumreg AssetOperations solution It lists installation prerequisites and provides instructions for installing andupgrading the Asset Operations
The following documents are also available for EMC Documentum Asset Operationsbull EMC Documentum Asset Operations Release Notes Includes newly added features and detailedrequirements for this version This document also references some known problems andlimitations
bull EMC Documentum Asset Operations Configuration Guide The Configuration Guide provides usefulinformation for administrators to configure a user role dictionaries and taxonomies transmittalsand distribution lists work order and work order types and project package and return projectpackage
bull EMC Documentum Asset Operations Quick Reference Guide The Quick Reference Guide is designedto provide easy-to-use support for getting the best out of the Asset Operations solution
bull EMC Documentum Asset Operations Integration Guide The Integration Guide is designed to provideeasy-to-use support for integrating Asset Operations and AVEVA NET in a single interface
Intended AudienceThis guide is intended for administrators who have experience working with the Documentumplatform and managing Documentum applications through Documentum D2 Config
5
Preface
Revision History
Revision Date Description
September 2015 Updated the Installing Asset Operations on ApplicationServer page 13 and Installing Asset Operations on Linuxpage 16 sections to support Documentum 72
August 2015 Added an additional step in the section Installing onApplication Server page 17
Updated the section Updating the Connection ConfigFile page 20
August 2015 Initial publication
6
Chapter 1Getting Started
This chapter contains the following topicsbull System Configuration page 7
bull Reviewing System Requirements page 8
bull Preparing the Installation Package page 8
bull Verifying the System Components page 9
bull Turning off the Default Audit Events for Content Server page 9
System ConfigurationThe following figure illustrates the components that you can install with Asset Operations
7
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Table of Contents
Chapter 4 Upgrading Asset Operations from Version 11 to 20 29New Attributes 29Preparing for the Upgrade 31Run InstallAOProjectOnAS Installer 31Installing the D2 Config Manually 32Removing D2 Legacy Configurations 32
Chapter 5 Installing Documentum Asset Operations Mobile 35Updating the D2 Configuration dictionariestaxonomy 35Updating the AO Mobile Config 35
Chapter 6 Troubleshooting 37
4
Preface
This guide provides step-by-step procedures for installing the EMCreg Documentumreg AssetOperations solution It lists installation prerequisites and provides instructions for installing andupgrading the Asset Operations
The following documents are also available for EMC Documentum Asset Operationsbull EMC Documentum Asset Operations Release Notes Includes newly added features and detailedrequirements for this version This document also references some known problems andlimitations
bull EMC Documentum Asset Operations Configuration Guide The Configuration Guide provides usefulinformation for administrators to configure a user role dictionaries and taxonomies transmittalsand distribution lists work order and work order types and project package and return projectpackage
bull EMC Documentum Asset Operations Quick Reference Guide The Quick Reference Guide is designedto provide easy-to-use support for getting the best out of the Asset Operations solution
bull EMC Documentum Asset Operations Integration Guide The Integration Guide is designed to provideeasy-to-use support for integrating Asset Operations and AVEVA NET in a single interface
Intended AudienceThis guide is intended for administrators who have experience working with the Documentumplatform and managing Documentum applications through Documentum D2 Config
5
Preface
Revision History
Revision Date Description
September 2015 Updated the Installing Asset Operations on ApplicationServer page 13 and Installing Asset Operations on Linuxpage 16 sections to support Documentum 72
August 2015 Added an additional step in the section Installing onApplication Server page 17
Updated the section Updating the Connection ConfigFile page 20
August 2015 Initial publication
6
Chapter 1Getting Started
This chapter contains the following topicsbull System Configuration page 7
bull Reviewing System Requirements page 8
bull Preparing the Installation Package page 8
bull Verifying the System Components page 9
bull Turning off the Default Audit Events for Content Server page 9
System ConfigurationThe following figure illustrates the components that you can install with Asset Operations
7
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Preface
This guide provides step-by-step procedures for installing the EMCreg Documentumreg AssetOperations solution It lists installation prerequisites and provides instructions for installing andupgrading the Asset Operations
The following documents are also available for EMC Documentum Asset Operationsbull EMC Documentum Asset Operations Release Notes Includes newly added features and detailedrequirements for this version This document also references some known problems andlimitations
bull EMC Documentum Asset Operations Configuration Guide The Configuration Guide provides usefulinformation for administrators to configure a user role dictionaries and taxonomies transmittalsand distribution lists work order and work order types and project package and return projectpackage
bull EMC Documentum Asset Operations Quick Reference Guide The Quick Reference Guide is designedto provide easy-to-use support for getting the best out of the Asset Operations solution
bull EMC Documentum Asset Operations Integration Guide The Integration Guide is designed to provideeasy-to-use support for integrating Asset Operations and AVEVA NET in a single interface
Intended AudienceThis guide is intended for administrators who have experience working with the Documentumplatform and managing Documentum applications through Documentum D2 Config
5
Preface
Revision History
Revision Date Description
September 2015 Updated the Installing Asset Operations on ApplicationServer page 13 and Installing Asset Operations on Linuxpage 16 sections to support Documentum 72
August 2015 Added an additional step in the section Installing onApplication Server page 17
Updated the section Updating the Connection ConfigFile page 20
August 2015 Initial publication
6
Chapter 1Getting Started
This chapter contains the following topicsbull System Configuration page 7
bull Reviewing System Requirements page 8
bull Preparing the Installation Package page 8
bull Verifying the System Components page 9
bull Turning off the Default Audit Events for Content Server page 9
System ConfigurationThe following figure illustrates the components that you can install with Asset Operations
7
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Preface
Revision History
Revision Date Description
September 2015 Updated the Installing Asset Operations on ApplicationServer page 13 and Installing Asset Operations on Linuxpage 16 sections to support Documentum 72
August 2015 Added an additional step in the section Installing onApplication Server page 17
Updated the section Updating the Connection ConfigFile page 20
August 2015 Initial publication
6
Chapter 1Getting Started
This chapter contains the following topicsbull System Configuration page 7
bull Reviewing System Requirements page 8
bull Preparing the Installation Package page 8
bull Verifying the System Components page 9
bull Turning off the Default Audit Events for Content Server page 9
System ConfigurationThe following figure illustrates the components that you can install with Asset Operations
7
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Chapter 1Getting Started
This chapter contains the following topicsbull System Configuration page 7
bull Reviewing System Requirements page 8
bull Preparing the Installation Package page 8
bull Verifying the System Components page 9
bull Turning off the Default Audit Events for Content Server page 9
System ConfigurationThe following figure illustrates the components that you can install with Asset Operations
7
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Getting Started
Reviewing System RequirementsVerify that the servers and machines meet the system requirements outlined in the EMC DocumentumAsset Operations Release Notes Log in as a member of the local administrators to the machine onwhich you are running the installation procedure
Preparing the Installation Package1 Download the installation package from the EMC Support site (httpssupportemccom)
2 Unzip the installation package to a temporary location on the Documentum Content Server(Content Server) hostFor example CTempEPFMA (Microsoft Windows) or usrdmadmintempEPFMA (Linux)The installation package for Microsoft Windows is EPFM-AO-20zipWhere ltversiongt is the version of Asset Operations you are installingDepending on your software license and your operating system you will receive one of theseinstallation packages
8
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Getting Started
Verifying the System Components1 Verify that the following components are running on the Content Server host
bull Documentum Docbroker
bull Documentum Content Server
Ensure that the Java Method Server (JMS) is stopped
2 Verify that the following components are installed on the Content Server hostbull Oracle Java Development Kit (JDK)
bull Documentum Composer
3 Verify that Documentum D2-API is installed on the Content Server host The EMC DocumentumD2 Installation Guide provides additional information for Installing D2 on the Content ServerAlso refer Configuring Lockbox Manually section for lockbox configuration
4 Ensure that the Documentum D2 Configuration (D2 Config) and Documentum D2 Client webapplications are on a web application server
5 Ensure that the version of Documentum Process Engine that is installed is compatible with yourversion of Content ServerAsset Operations and ECM Controlled Document Foundation depend on the DAR files includedwith Documentum Process Engine These files are TCMReferenceProjectdar Formsdarand BPMdar
6 Verify that EMC Syncplicity Connector for Documentum has been installed and configured onthe Content Server Also ensure that the Syncagent war has been deployed on a Web applicationserver
Note To make Asset Operations work on a repository which has EPFM-Capital Projects youmust disable the Type-based business objects in dm_user and dm_group
Start Documentum Advanced Document Transformation Services (ADTS) Documentum ThumbnailServer (Thumbnail Server) and Documentum xPlore-related services after you install AssetOperations
Turning off the Default Audit Events for ContentServerTurning off the default audit events enables a more readable and streamlined audit trail The EMCDocumentum Content Server Administration and Configuration Guide provides instructions on thedefault audit events
1 Log in to Documentum Administrator as a user with the Config Audit privilege
2 Browse to Audit Management
3 SelectManage Auditing by events selected for all objects in the repository
4 Select dm_default_set and click Remove
9
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Getting Started
5 Restart the repository
Packaging a Documentum D2 ConfigurationsIf you have existing Documentum D2 configurations export them to create backup copies
Note To confirm the backup was successful import the configuration to a temporary repository andconfirm the list of exported configurations successfully displays before cancelling or importing theconfigurations
If you have multiple D2 applications you must consider exporting each individually as furtherbackup before upgrading Asset Operations Also ensure the upgrade and restoration of priorconfigurations runs successfully in a non-production environment before installing Asset Operationsin a production environment
1 In Documentum D2 Config use File gt Export configuration to save your current configurations
2 Install Asset Operations to the left of the D2ndashmatrix to ensure it has a priority
3 Reapply the previous configurations if required after installing the Asset OperationsThe EMC Documentum D2 Administration Guide provides instructions for completing the D2configurations
10
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Chapter 2Installing Asset Operations
This chapter contains the following topicsbull Installation Scripts page 11
bull Installing Asset Operations on Microsoft Windows page 12
bull Installing Asset Operations on Linux page 16
bull Installing Components of Asset Operations Manually page 18
bull Importing the Documentum D2 Configuration Files page 19
bull Manually Updating the Custom Widget URLs D2 Dictionary and Alias Values page 20
bull Updating the D2 Configuration Dictionaries page 20
bull Updating the Connection Config File page 20
Installation ScriptsAsset Operations provides installation scripts to install the solution on a Microsoft Windows andLinux Content Server hostThe installation script automates the following tasks
bull Installs DAR files that contain object type definitions workflow templates and permission sets
bull Populates roles and creates registered tables
bull Copies the Server Method JAR files to Java Method Server
bull Installs D2-Config of the product
bull Updates the D2 widgets dictionaries and alias that references application host and port basedon the install inputs
The installation script does not perform the following componentsbull Documentum xPlore attribute settings to index the properties you want to display in facetsearch results
bull Content Transformation Services settings to render asset documents
bull Documentum Syncplicity email and Documentum D2 application server settings
bull The installation script does not manually install the EPFMAwar
11
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
In addition the installation script does not enable the followingbull Configuring the Syncplicity Repository Cleanup Job
Installing Asset Operations on MicrosoftWindowsComponents of Asset Operations are installed on the Content and Application server
Installing Asset Operation Components on ContentServer
This script installs the Composer DARs and scripts and copies the required libraries to the JavaMethod Server
1 Download the Asset Operations 20 Installer package For example EPFM-AO-2000000XXXzip
2 Copy the Installer package to the Content Server
3 Stop the Java Method Server
4 Unzip the installation package to a temporary location For exampleCtempltAO20foldergt
5 Navigate to the unzipped installation package and open InstallAOProjectsOnCSbat in atext editor
6 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath of Documentum shared foldergtFor example set DFC_SHARED_DIR=CDocumentumSharedset JBOSS_VERSION=ltjboss version installed along with CSgtFor example set JBOSS_VERSION=711set JAVA_HOME=ltpath to java jdk bin foldergtFor example set JAVA_HOME=CDocumentumjava64170_17bin Provide 64 bit JDK pathFor Documentum 67 SP2Set JAVA_HOME to point to a 32-bitJava in the installation batch script CProgram FilesDocumentumjava160_27set CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71
Note You must updateCONTENT_SERVER_VERSION=71
12
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
even if you are using Documentum Content Server 72
7 Save the file
8 The Composer DAR file uses dmadmin as an installation parameter for the installer value
If dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadmin
For example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
9 Run the InstallAOProjectOnCSbat file
10 The command prompt displays the status of the installation
11 After the installation is complete verify the log files
12 Restart the Repository and Java Method Server
Installing Asset Operations on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration widgetURL dictionaries and alias that matches with that of the host or port This script updates the systemto indicate that Aveva activity must be enabled in the workflow
Installing on Tomcat
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset LOCAL_REPOSITORY=ltlocal docbase namegtFor example set LOCAL_REPOSITORY=AOMobileset LOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=Administratorset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123set GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileset GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=Administratorset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123set DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=Capache-tomcat-7042webappsD2-ConfigWEB-INFclassesset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CProgram FilesJavajdk170_25binset D2_LOCKBOX=ltPath to location D2lockbox filegt
13
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
For example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=Capache-tomcat-7042webappsD2set SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Deploying EPFMAwar on Tomcat
The Asset Operations solution has a web application that contains the Configuration Help Guidesand Welcome pages
1 Stop the application server
2 If the application server already has an EPFMA directory (for example lttomcatservergtwebappsEPFMA) delete it
3 Browse to ltunzipped installation packagegtwebapps
4 Unzip the EPFMAwar file and browse to WEB-INFclasses
5 Update the dfcproperties file with the repository information for your environment
6 Repackage the EPFMAwar file and deploy it to the application server (for example lttomcatservergtwebappsEPFMAwar)
7 Restart the application server
Installing on IBM WebSphere
Deploying EPFMAwar
1 Extract the EPFMAwar file
2 Update the DFCproperties file
3 Recreate the WAR file
4 Deploy the WAR file in WebSphere as an enterprise application
5 In the IBM WebSphere Administration console navigate to Applications gt Install NewApplication
6 Click Browse locate and then select EPFMAwar
14
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
7 Type EPFMA as the context root
8 Follow the wizard until you notice step 1 provide options to perform the installation and thenchange the application name from EPFMA_war to EPFMA
9 Follow the wizard and click Save to Master Configuration
10 Click Save
11 Navigate to ApplicationsEnterprise ApplicationsltEPFMAgtManage ModulesltEPFMAgt andset every EPFMA module to Application class loader first modeThe default is Parent class loader first mode
Importing AO Configuration
The script overrides the D2 application in the target system and reinstalls the D2 configurationwidget URL dictionaries and alias that matches with that of the host or port This script updates thesystem to indicate that Aveva activity must be enabled in the workflow
1 Copy the downloaded AO package to the application server
2 Unzip the AO package to a temporary location For example CtempltAO20 foldergt
3 Navigate to the unzipped installation package and open the InstallAOProjectsOnASbatin a text editor
4 Update the following values according to your environmentset PACKAGE=ltpackage namegtFor example set PACKAGE=install-ao-20set LOGS_FOLDER=ltlogs folder namegtFor example set LOGS_FOLDER=logsset LOCAL_REPOSITORY=ltlocal repository namegtFor example set LOCAL_REPOSITORY=AO11set LOCAL_REPO_USERNAME=ltrepo user namegtFor example set LOCAL_REPO_USERNAME=dmadminset LOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=passwordset GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AO11set GLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=dmadminset GLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=passwordREM If DFC_SHARED_DIR contains whitespace then enclose within double quotesSample set DFC_SHARED_DIR=CProgram FilesDocumentumSharedset DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFlibset DCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=CIBMWebSphereAppServerprofilesAppSrv01installedAppsAO20WAS85Node01CellD2-ConfigearD2-ConfigwarWEB-INFclassesREM set JAVA_HOME=CIBMWebSphereAppServerjava_171_64binset JAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=CBuildsjdk170_67binset D2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=CLockboxset D2_APP_URL=ltApplication url with port numbergtFor example set D2_APP_URL=httplocalhost8080D2set D2_WEBAPP_PATH=ltPath to locate D2 webappgtFor example set D2_WEBAPP_PATH=CIBMWebSphereAppServerprofilesAppSrv01installedApps
15
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
AO20WAS85Node01CellD2earD2warset SETUP_HAS_AVEVA=falseFor example if Aveva is configured this value should be set to trueAdd rtjar that is available in Oracle JRE in ANT homeFor example call ANT_HOMEbinant -lib DFC_SHARED_DIRdfcjarCBuildsjdk170_67jrelibrtjar -buildfile configdeploy_packagexml
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
Note Use Oracle JDK as JAVA HOME instead of IBM Java
Installing Asset Operations on Linux
Installing on Content Server
This script installs the Composer DARs and scripts and copies the necessary libraries to the JavaMethod Server
1 Before starting the installation verify the followingbull Content Server is of version 67 SP2 or 71
If you experience any installation issues with other versions of Content Server 67 SP2 orhigher install the solution manually The Installing Components of Asset OperationsManually page 18 section provides the manual installation instructions
bull Java Method Server is stopped
bull The latest version of Composer is installed
bull The repository is running
bull The following files in the unzipped installation package have the execute permission
ltunzipped installation packagegtsh
2 Run the chmod command on the InstallAOProjectOnCSsh file
3 Open a terminal window and browse to the unzipped installation package
4 Open the InstallAOProjectsOnCSsh by using a an editor
5 Update the following argument according to your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgtFor example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgt
16
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
For example set GLOBAL_REPO_PASSWORD=Password123JBOSS_VERSION=ltJBoss versiongtFor example set JBOSS_VERSION=711CONTENT_SERVER_VERSION=ltContent Server versiongtFor example set CONTENT_SERVER_VERSION=71JAVA_HOME=ltpath to java jdk bin foldergt
Note You must updateCONTENT_SERVER_VERSION=71
even if you are using Documentum Content Server 72
6 Save the file
7 The Composer DAR file uses dmadmin as an installation parameter for the installer valueIf dmadmin account does not exist in the target repository navigate to the unzipped installationpackage EPFM-AO-2000000XXXinstall-ao-20RepositoryConfigdocappsglobal path and update the ([DAR_NAMEinstallparam) file for dmadminFor example ltparameter key=dmadmin value=MyNewInstallerNamedefaultValue= gt
8 Run one of the following commandsbull sh InstallAOProjectOnCSsh
OR
bull InstallAOProjectOnCSsh
9 Verify the log files and ensure that there are no errors
Installing on Application Server
The script resets the D2 application in the target system and reinstalls the D2 configuration updatethe widget URL dictionaries and alias that matches with that of host or port This script also updatesthe system to indicate that Aveva activity must be enabled in the workflow
1 Copy the AO package to the Application serverUnzip the AO package to a temporary location For example ltunzipped installationpackagegt sh
2 Navigate to the unzipped installation package and open the InstallAOProjectsOnASshin a text editor
3 Update the following values as per your environmentLOCAL_REPOSITORY=ltlocal docbase namegt
For example set LOCAL_REPOSITORY=AOMobileLOCAL_REPO_USERNAME=ltlocal docbase installation owner namegtFor example set LOCAL_REPO_USERNAME=AdministratorLOCAL_REPO_PASSWORD=ltlocal docbase installation owner passwordgt For example set LOCAL_REPO_PASSWORD=Password123GLOBAL_REPOSITORY=ltglobal docbase namegtFor example set GLOBAL_REPOSITORY=AOMobileGLOBAL_REPO_USERNAME=ltglobal docbase installation owner namegtFor example set GLOBAL_REPO_USERNAME=AdministratorGLOBAL_REPO_PASSWORD=ltglobal docbase installation owner passwordgtFor example set GLOBAL_REPO_PASSWORD=Password123
17
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
DFC_SHARED_DIR=ltPath to D2-ConfigWEB-INFlib directory on app servergtFor example set DFC_SHARED_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesDCTM_CONFIG_DIR=ltPath to D2-ConfigWEB-INFclasses directory on app servergtFor example set DCTM_CONFIG_DIR=optapache-tomcat-7042webappsD2-ConfigWEB-INFclassesJAVA_HOME=ltpath to java JDK bin foldergtFor example set JAVA_HOME=optjavaJavajdk170_25binD2_LOCKBOX=ltPath to location D2lockbox filegtFor example set D2_LOCKBOX=optLockboxHAS_AVEVA=falseFor example if Aveva is configured this value should be set to true
Note If you use Java 8 you must remove -XXPermSize=256m -XXMaxPermSize=512mfrom the ANT_OPTS parameter
4 In the InstallAOProjectsOnASsh script file change the path of the DFCjar file fromDFC_SHARED_DIRdfcjar to $DFC_SHARED_DIRdfcjar
5 Save the file
6 Run the file in a command prompt
7 Verify the log files and ensure that there are no errors
8 Stop and restart Java Method Server Docbase and Docbroker
9 Stop and restart application server
Installing Components of Asset OperationsManuallyYou can install few components manually
1 Install the solution DAR files
a Browse to the Composer directory and open the DAR Installer (For example CProgramFilesDocumentumComposerdardeployerexe)
b Install the following DAR files in the order given from the darsltinstallationdirectorygtdars directorybull AssetManagementFoundationdar
bull AO_Workflowsdar
Each DAR file in the Composer project is configured to use dmadmin as an installationparameter for the installer value If dmadmin account does not exist in the target repositoryupdate the installation parameter file ([DAR_NAMEinstallparam) based on yourenvironment and reference it during installation
2 Deploy the Method libraries to the Java Method Server
a Stop the Java Method Server
b Copy the jars found under installation packagemethod_server_lib to$DOCUMENTUMjboss$jbossversionserverDctmServer_MethodServerdeploymentsServerAppsearlib
c Restart the Java Method Server
18
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
3 Update the Asset Operations external widget URLs The Manually Updating the CustomWidgetURLs D2 Dictionary and Alias Values page 20 section provides more information
4 Deploy the EPFMAwar on the Application server
Importing the Documentum D2 ConfigurationFiles1 Before importing Documentum D2 Config
bull Verify that the Java Method Server is running
bull If you have custom configurations ensure that you export them and reset the configurationsThe reset is required only when you perform the upgrade process The Packaging aDocumentum D2 Configurations page 10 section provides instructions on exporting andresetting the Documentum D2 Configurations
2 Open a browser and type httpltD2 hostgtltportgtD2-Config
3 Log in to the repository with Documentum Administrator credentials For example dmadmin
4 Select File gt Import Configuration and browse to ltinstallation directorygtconfig_exports
5 Import the EMC EPFM Asset Operations - Export-Configzip file
6 In the Select elements to import dialog box do the followingbull Select Full import without actual config reset and then clear the selection
bull Select Include imported modules relative matrix switches
bull If you have previously imported Asset Operations D2 configurationsmdash Select Overwrite existing element
mdash Select Do not overwrite auto-naming values
mdash Select Do not overwrite email server config
7 Click OKYou must wait for D2 matrix to refresh with the imported Asset Operations configurations
8 Stop the application server clear the D2 cache and restart the application server
9 Verify that the Documentum D2 Config and Documentum D2 Client addresses for yourenvironment are included in the Clients URL listbull httpltD2 hostgtltportgtD2ndashConfig
bull httpltD2 hostgtltportgtD2
10 Close the browser
19
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
Manually Updating the Custom Widget URLsD2 Dictionary and Alias ValuesIn Windows and Linux after you install EMC Documentum Asset OperationsExport-Configzip you can run the following command manually to update the custom widgetURLs D2 dictionaries and alias set values to match your environment
Run the following batch file in a command prompt
1 Set SKIP_D2CONFIG_INSTALL = true
2 Download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtEPFM-AO-20webappsD2WEB-INFlib This jar isrequired for Reporting functionality
3 Run the InstallAOProjectsOnASbat file
The Installing on Application Server page 17 provides more information on Installation steps
Updating the D2 Configuration Dictionaries1 In Documentum D2 Config select Data gt Dictionary from the menu bar
2 Update the dictionaries as described in the following table
Dictionary Description
System aveva Config Specify these values for the key
Key Aveva (default)
Export XML Directory Directory where AVEVA import process picks the Field QueryXML file
Trigger File Name Name of the trigger file system that AVEVA uses to determinethat a new insert will run
Trigger File Location Location of the trigger file
Context ID Name of the context assigned by AVEVA
Updating the Connection Config FileFrom Asset Operations 20 release onwards the Email account for Transmittal and Syncplicity aremanaged by using the EPFM configuration file For users of the previous versions of Asset Operationsthe configurations defined in D2 dictionaries overrides the values defined in the EPFM config file
Perform the following steps in Documentum Administrator
1 Log in with Administrator
20
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
2 Navigate to the System cabinet For example SystemEPFMAAO path and update the SystemTransmittal Connection Config file The file contains the system connection details forSyncplicity and the Email account
3 System Syncplicity Connector Config - Specify the following values for Syncplicity key
Note You must update these values only if you use Syncplicity for sending transmittals
Parameter Description
Share Owner The repository account that Syncplicity uses to accesscontent and update or create new repository objectswhen end users make changes through Syncplicity
Transfer Protocol The transfer protocol that Asset Operations uses toaccess the Syncplicity Connector application Thevalid values are http or https
SyncAgent webapp The name of the Syncplicity Connector user interfaceThe default value is syncagent
Host Name The host name or the Internet Protocol address of theSyncplicity Connector application
Port Number The port number of the Syncplicity Connectorapplication
Share Object Type The repository object types and subtypes that theDocumentum system uploads to Syncplicity Thedefault object type is ao_document
import_attrs_override The attribute values that override the originalattribute values when the values are updatedin Syncplicity In the following example thecondition and values that pass from Syncplicity areenclosed in single quotation marks For examplea_statusrsquo=rsquorsquoDraftrsquotitlersquoContainsrsquorsquoXYZrsquo
Use a semicolon to separate the attributes and use acomma to separate the repeating attribute values
4 System Email Config - Specify the following values for the Email key
Parameters Description
Host Name The email server host name
Port Number The email server port number
Encrypted Password The encrypted password for the email accountRun the following command to retrieve the encryptedpassword
java -cp dfcjar comdocumentumfctoolsRegistryPasswordUtilsltuser_passwordgt
21
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Asset Operations
Parameters Description
Is SSL The true or false secure socket layer (SSL) value thatdepends on the email server configuration
Is Start TLS The true or false transport layer security (TLS) valuethat depends on the email server configuration
SSL Protocol The SSL protocol value that depends on the emailserver configuration
SSL Socket Factory Class The fully qualified class name for the SSL socketfactory
Is Socket Factory Fallback The true or false value that depends on the emailserver configuration
Username The username for the mail server account that sendsemails
RequiresAuthentication The true or false value that depends on the emailserver configuration
22
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Chapter 3Completing the Installation
This chapter contains the following topicsbull Downloading the JasperReports page 23
bull Enabling the AOD2Plugins and Asset Operations JARs page 23
bull Removing the Conflicting jar Files page 24
bull Configuring the Documentum xPlore Facets page 24
bull Rebuilding the Documentum xPlore Indexes page 25
bull Configuring the System for PDF Rendering page 26
bull Deploying EPFMAwar on Tomcat page 14
bull Configuring the Syncplicity Cleanup Job page 26
bull Modifying the Alias for Mailing Lists and Emails page 27
Downloading the JasperReportsYou must download the jasperreports-604jar from httpsourceforgenetprojectsjasperreportsfilesjasperreportsJasperReports20604 and copy the same toltapplication_server_homegtwebappsD2WEB-INFlib This jar is required for Reportingfunctionality
Enabling the AOD2Plugins and AssetOperations JARsTo enable users to select multiple documents when working with change requests changenotices transmittals work orders and report manually install the AOD2PluginsjarAOD2ReportingPluginsjar and ReportingFrameworkjar files in the Documentum D2environment
Note You must repeat these steps whenever D2 is re-deployed
1 Stop the application server that hosts Documentum D2 Client
23
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Completing the Installation
2 Browse to ltunzipped installation packagegtwebappsD2WEB-INFlib
3 Copy all the jars from EPFM-AO-2000000XXXwebappsD2WEB-INFlib path to thetarget location
4 Start the application serverEnsure that you complete Step 1 through Step 4 every time you upgrade Documentum D2 Client
5 Copy the AOD2Pluginsjar to the Java Method Server lib folder atltDocumentum installation foldergtjbossltversiongtserverDctmServer_MethodServerdeployServerAppsearlib
6 Restart the Java Method Server
Removing the Conflicting jar FilesYou can follow these steps to remove the conflict jar files when both the Capital Projects and AssetOperations are installed on the same repository
1 Stop the Java Method Server
2 If you notice mailjar and ctsTranformjar in the following location delete the jarfilesltJMS_PATHgtServerAppsearDmMethodswarWEB-INFlib
3 If you notice dom4j-161jar in the following location delete the jar fileltJMS_PATHgtdeploymentsServerAppsearDmMethodswarWEB-INFlib
4 Restart the Java Method Server
Configuring the Documentum xPlore Facets1 On the xPlore and IndexAgent hosts stop xPlore IndexAgent and Search Server by stopping
the following servicesbull On Microsoft Windows
mdash Documentum IndexAgent
mdash Documentum xPlore PrimaryDsearch (Primary)
mdash Documentum xPlore Watchdog ndashC ndashxPlore
bull On Linuxmdash Use the shutdown scripts located in dsearch_homejboss510server Runshutdown scripts with the same administrator account that started the instance
2 Backup the xPlore configuration XML file located atltxPlore installation directorygtconfigindexserverconfigxml =dsearch_homeconfigindexserverconfigxml
3 Open the file in a text editor and copy the content from ltunzipped installationpackagegtconfigfacetstxt to the ltpath-value-indexgt element in the dftxml
24
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Completing the Installation
category The section where you have to copy the content is highlighted in the following codesample
ltcategory-definitionsgtltcategory name = dftxmlgt
ltindexesgtltpath-value-indexgt
copy content of facetstxt file hereltpath-value-indexgt
4 If the version of Documentum xPlore in your environment is 12 or earlier increment the revisionnumber in the ltindex-server-configurationgt element The following code sample showsthe revision number changed from 18 to 19ltindex-server-configuration revision=18 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
ltindex-server-configuration revision=19 config-check-interval=60purge-statusdb-on-startup=false enable-lemmatization=truegt
5 Save and close the file
6 Restart the IndexAgent and Search Server services
7 Verify that the IndexAgent service has started
a Open a browser and browse tohttpltIndexAgent hostgt9200IndexAgent
b Log in using the IndexAgent credentials created when xPlore was installed
c If the following warning appears select Start Index Agent in NormalMode and click SubmitIndex Agent is stopped
d Close the browser
Rebuilding the Documentum xPlore IndexesPerform this procedure if there are documents in the repository and new facets have been addedin the previous step This procedure is not necessary for a new installation or when there are nochanges to the facet configuration
1 Open a browser and browse to the Documentum xPlore Administration toolhttpltxPlore hostgt9300dsearchadmin
2 Browse toData Managementltsolution repository namegtdefault
3 Click Rebuild IndexesThe number of documents in the repository determines the duration to rebuild the indices Toavoid a lengthy index rebuild decide on and configure facets before deployment xPlore supportsonline indexing In the event of a rebuild users can continue to search during the rebuild TheEMC Documentum xPlore Administration and Development Guide provides more information onconfiguring facet indexes
25
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Completing the Installation
Configuring the System for PDF RenderingTo create PDF renditions use Documentum Advanced Document Transformation Services (ADTS)ADTS is part of the Documentum Content Transformation Services (CTS) suite of Documentum serverproducts that perform transformations and analysis on repository content and thumbnail renditionsThe EMC Documentum Content Transformation Services Transformation Suite Administration Guideprovides instructions on configuring Documentum Advanced Document Transformation Services
Configure ADTS and Documentum Thumbnail Server to generate thumbnail renditions for documentpreviews in Documentum D2
Enabling Document Types for Rich Media
Run the following query to enable rich media for repository document typesupdate dm_format objects set richmedia_enabled=true where name like(msw)
Configuring the Syncplicity Cleanup JobAsset Operations has a Documentum repository job that removes completed transmittal objects froma Syncplicity share You can customize the job for your environment By default this job is set toinactive when active system removes the shared transmittal from Syncplicity that has completed 30days
1 Log in to Documentum Administrator
2 Browse to Administration gt Job Management gt Jobs
3 Right-click AOCleanSyncplicityShare and select Properties
4 To update the method arguments for your implementation of Asset Operations
a Click theMethod tab
b Click Edit next to Arguments
c Define argument values as described in the following table
Argument Description
-target_object_type Specifies the target object type to be removed If you do notspecify a value the job uses the base ao_tranmittal type
-target_objects_query Specifies the optional query to retrieve a list of objects
-target_object_state Specifies the target state of the object to be removed If youdo not specify a value the job uses the Completed state
26
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Completing the Installation
Argument Description
-from_date Specifies the number of days that the job uses to calculatethe start date for retrieving the completed transmittals Thedefault value is 30 days
-sys_dictionary_name Specifies the name of the dictionary that the job uses toretrieve the Syncplicity connection settings If you do notspecify a value the job uses the base System SyncplicityConnector Config dictionary
5 Click OK
Modifying the Alias for Mailing Lists and EmailsThe Asset Operations solution defines an alias ao_appserver to maintain app-server nameport and webapp name that are used in dynamically constructing document link (DRL) in an emailor mailing list These aliases must be updated with proper values based on the environment
Follow these steps to update the alias1 Log in to Documentum Administrator You must log in with a user name that contains the
administrative privileges
2 Browse to the AdministrationAlias Sets node
3 Select the ao_appserver alias right-click and select Alias Set Properties
4 Navigate to Aliases tab
bull Select the name alias and modify it to enter a correct application server hostname or IP value
bull Select the port alias and modify it to enter a correct application server port value
bull Select the webapp alias and modify it to enter a correct D2 Web application name
5 Click OK
27
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Completing the Installation
28
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Chapter 4Upgrading Asset Operations fromVersion 11 to 20
The Asset Operations 20 release contains a new object model new configuration settings and newfunctionality
Note You cannot migrate from one operating system or database to another For example Solaris toLinux You can contact the Professional Services team for operation system or database migration
This chapter contains the following topicsbull New Attributes page 29
bull Preparing for the Upgrade page 31
bull Run InstallAOProjectOnAS Installer page 31
bull Installing the D2 Config Manually page 32
bull Removing D2 Legacy Configurations page 32
The EMC Documentum Asset Operations Release Notes provides more details on the systemrequirements
New AttributesThe following are the new types and attributes that are added during the upgrade process
Type ao_document
Description Asset document
Attribute Name Length IsRepeating
Comments
ao_equip_manufacturer Char (10) Yes Supports equipmentcategorization
ao_po_number Char (255)
ao_supex_name Char (50) Supports supplier connectorintegration
consolidators Char (48) Yes Supports consolidation review
29
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Upgrading Asset Operations from Version 11 to 20
The following are the new types that are added in Asset Operations 11 and later
Type ao_report
Description AO Report
Attribute Name Length IsRepeating
Comments
ao_report_orderby_value
Char 32 Yes Supports ordering of report
ao_report_orderby_label
Char (32) Yes Supports ordering of report
ao_report_template_id ID
Type ao_sds
Description AO Supplier Document Schedule
Attribute Name Length IsRepeating
Comments
ao_supplier_name Char (100)
ao_supplier_number Char (10)
ao_rp_name Char (128) Yes Recipient Name
ao_rp_email Char (200) Yes Email
ao_rp_company Char (128) Yes Company
ao_rp_group Char (128) Yes Group
Type ao_field_query
Description AO Field Query
There are no custom attributes
Type ao_attachment
Description AO Attachement
Attribute Name Length IsRepeating
Comments
ao_field_query_id Char (10)
30
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Upgrading Asset Operations from Version 11 to 20
Preparing for the UpgradeAsset Operations version 20 contains changes in the data model that requires you to backup D2configurations
1 Perform the following steps to back up your configurations
a In Documentum D2 Config click File gt Export configuration
b In the Applications list select All elements and click OK
c Select Full config export
d Click OK
2 Export any extended or custom configurations you have along with all the workflow andautonaming configurations
a In Documentum D2 Config select File gt Export configuration
b Select All elements
c Click OK
d Select all the workflow and autonaming configurations
You must select all extended or custom configurations
Note Any configuration that you do not export will not be available after the upgradeprocess
3 Run the following DQL query and save the query result to verify the installation
select r_object_id object_name order_no parent_names parents_configparent_order_no dql_where group_name title lock_config fromd2_documentset order by order_no
Run InstallAOProjectOnAS InstallerAfter you perform D2 config backup you can run the InstallAOProjectOnAS installer on theapplication server to install Asset Operations specific D2 config and post configuration updates
Use Full Import with Overwrite (without a reset) option to install D2 Config on an existingconfiguration
The EMC Documentum Asset Operations Installation Guide provides more details on instructions toinstall application specific artifacts
After you complete the installation refer to the saved query and verify the context order Perform therequired changes for your customized configurations
31
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Upgrading Asset Operations from Version 11 to 20
Installing the D2 Config ManuallyWhen the installer fails or if certain configurations are not deployed due to environment issues youcan use the manual installation process Install D2 config by using the following steps1 In Documentum D2 Config select File gt Import Configurations
2 Select the following options
a Full import without actual config reset
b Include imported modules relative matrix switches
c Overwrite existing elements
d Do not overwrite auto-naming values
e Do not overwrite email server config
3 After you complete the D2-config installation you must run the InstallAOProjectOnAS withSKIP_D2CONFIG_INSTALL=true to complete the post D2-config updates
Removing D2 Legacy ConfigurationsIn Asset Operations 20 the Handover related artifacts have been removed After you upgrade D2Config you can manually remove the following
Note The Asset Operations 20 features will work as required even if you do not remove theHandover related contexts and other referenced details
Remove the following Handover related D2 Contexts
bull Handover documents
bull HO Process Return Package
bull HO Cat 1
bull HO Cat 2
bull HO Cat 3
bull HO Working Copy
bull HO Project Package
bull HO Process Return
bull HO Return Project Package
bull HO Effective Cat 3 Change
Remove the following Handover related lifecycle (d2_lifecycle_config) statesbull HO Cat 1 Document Lifecycle
bull HO Cat 2 Document Lifecycle
bull HO Cat 3 Document Lifecycle
32
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Upgrading Asset Operations from Version 11 to 20
bull HO Project Package Lifecycle
bull HO Working Copy Lifecycle
Remove the following Handover creation profiles (d2_create_config)bull HO Artifacts
bull HO Project Package
bull HO Return Project Package
bull HO Working Copy
Remove the following Handover default profiles (d2_default_value_config)bull HO Cat 1 Document Default Values
bull HO Cat 2 Document Default Values
bull HO Cat 3 Document Default Values
bull HO Project Package Defaults
bull HO Search Asset Document Defaults
bull HO Search Return Package Working Copy
bull HO Search Working Copy Defaults
bull HO Working Copy Defaults
Remove the following Handover lifecyle batch (d2_lifecycle_batch_config) configbull HO Cat 3 Change Linked Working Copy
bull HO Notify Return Working Copy
bull HO Process Return Package
Remove the following Handover property page (d2_property_config) configbull HO - AO Property Page
bull HO Project Package Property
bull HO Working Copy Properties Page
Remove the following Handover application (d2_application)bull Handover
33
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Upgrading Asset Operations from Version 11 to 20
34
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Chapter 5Installing Documentum AssetOperations Mobile
You must perform the following tasks to complete the Documentum Asset Operations Mobileinstallationbull Updating the D2 Configuration dictionariestaxonomy page 35
bull Updating the AO Mobile Config page 35
Updating the D2 Configuration dictionariestaxonomyYoumust update the following dictionaries and taxonomies to reflect the asset facility and settings forthe field query In D2 Config update the dictionaries or taxonomy as described in the following table
Name DictionaryTaxonomy
Description
Field Query Asset Dictionary List of Asset Name used in the field query setup
Field Query Discipline Dictionary List of Asset Discipline used in the field querysetup
Field Query Facility Dictionary List of Asset Facility used in the field querysetup
Field Query ProjectNumbers
Dictionary List of Project Numbers used in the field querysetup
Field Query AssetFacility
Taxonomy Specify the Asset and corresponding Facilitytaxonomy used in the field query
Updating the AO Mobile ConfigThe Insert to ao_mobile_configdql script defines create search attributes searchtypes and creation profile for the field query mobile setup You can update the Insert to
35
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Installing Documentum Asset Operations Mobile
ao_mobile_configdql script file as per your requirement You can locate the script in theltinstallation directorygtscript directory
Save the changes and use idql to run the updated file on Content Server by using the followingcommandidql 1 -U2 -P3 -RInsert to ao_mobile_configdql1 = name of docbase2= login user name3= password
36
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Chapter 6Troubleshooting
Problem Cause Resolution
The Business ProcessManager is not startingdue to javalangNoSuchMethodErrorcomrsajsafeCryptoJisNativeAvailableerror in Java MethodServer
The dfckeystore fileis corrupt
Add dfcsecuritykeystorefile=homedmadmindctmconfigdfckeystore entry in dfcpropertiesfileThe file is available here$Documentum_Homeconfig ofContent Server
Installation or upgradefails on Content Serverdue to a DQL error thatare related to dm_dboao_action_menudm_dboao_aveva_attr_mapping anddm_dboao_mobile_attr_mapping tables
A dm_registry entryis created whenever yourun the install script
Before installation run the followingqueriesbull unregister table dm_dboao_action_menu
bull unregister table dm_dboao_aveva_attr_mapping
bull unregister table dm_dboao_mobile_attr_mapping
Run the installation script again
AO Workflows stopsworking after ProcessEngine Upgrade
The bpmear isredeployed as part ofupgrade and as a resultthe AO jars gets deleted
The EPFMA-AN-IntegrationjarCDF-Methodsjar jars are deployedby the Asset Operations-Content ServerInstaller When the Process Engineis upgraded after Asset Operations isinstalled you must copy the jars manuallyto the bpmear path
For Documentum 67 the bpmear path is
CDocumentumjboss510server
DctmServer_MethodServerdeploy
bpmearlib
For Documentum 71 the bpmear path is
37
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Troubleshooting
Problem Cause Resolution
CDocumentumjboss711
serverDctmServer_MethodServer
deploymentsbpmearlib
When you run theInstallAOProjectOnCSbat the installer throwsthe following messagehellipconfigdeploy_packagexml725The system cannotaccess theconfiguration fileChellipEPFMA-AO-2000000xxxconfiginstall_package_configxml
Unicode characters getsadded accidentallywhen editing theInstallAOProjectOnXXbat file
1 Use an open source editor suchas Notepad++ to open theInstallAOProjectOnXXbatfile
2 In Notepad++ enable Show AllCharacters
3 Search for r and replace with rn
A Java returncode 13 error occurswhile installing AssetOperations
Headless Composer getscorrupted
You must remove the existing HeadlessComposer and install the Composer again
Perform the following for Documentum67 SP2bull Set JAVA_HOME to point to a 32-bitJava in the installation batch scriptCProgram FilesDocumentumjava160_27
Perform the following if you are unable toresolve the Java return code 13 error
1 Download the AO package
2 Add comments to thefollowing dar section in theinstall_package_configxml fileas shown
lt--
ltdar_ref ref=AOAMFGlobal
run_on_global_repository
=false
run_on_local_repositories
=truegt
ltpathgt$packagebasedirabsolute
$pkgcsdocapplocalpathlt
pathgt
ltdar_filegt
AssetManagementFoundation
darltdar_filegt
38
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Troubleshooting
Problem Cause Resolutionltinstallparam_filegt
AssetManagementFoundation
installparam
ltinstallparam_filegt
ltdar_refgt
ltdar ref=AOWKGlobal run_on
_global_repository=true
run_on_local_repositories
=false
depends_on
=AOCDFGlobalAOAMFGlobalgt
ltpathgt$packagebasedirabsolute
$pkgcsdocappglobal
pathltpathgt
ltdar_filegtAO_Workflowsdarlt
dar_filegt
ltinstallparam_filegtAO
_Workflowsinstallparam
ltinstallparam_filegtltdargt
--gt
39
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Troubleshooting
40
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41
Index
AAO Mobile Config 35audit events
turning off 9
Cconfiguring
PDF rendering 26syncplicity 26xPlore facets 24
DD2 Configuration Dictionaries 35deploying
EPFMA war 14Documentum D2 configuration
exporting and resetting 10
Eexporting and resetting
Documentum D2 configuration 10
IInstall D2 Config Manually 32installation script
overview 11installing 11
completing 23importing 19Linux 16manually 18windows 12
Installing Asset Operations Mobile 35
MModifying
Mailing Lists and Emails 27
NNew Attributes 29
Ooverview
installation script 11
Rrebuilding
xPlore indexes 25Remove D2 Legacy Configurations 32removing
conflicting jar 24Run InstallAOProjectOnAS Installer 31
Ssystem configuration 7
preparing 8system requirements 8verifying 9
TTroubleshooting 37turning off audit events 9
Uupdating
configuration dictionaries 20connection config file 20
updating external widget 20upgrading 29
preparing 31
41