TROUBLESHOOTING DOCUMENTUM ACS READ URL GENERATION FAILURES

Transcription

1 TROUBLESHOOTING DOCUMENTUM ACS READ URL GENERATION FAILURES ABSTRACT This whitepaper provides the necessary steps needed for troubleshooting the ACS read URL generation failures. This whitepaper will be useful for custom Documentum applications and xcp applications like xcp viewer which relies on generation of ACS read URL for display of the contents and in scenarios where DA is not deployed preventing to verify certain configurations. December, 2014 EMC WHITE PAPER

2 To learn more about how EMC products, services, and solutions can help solve your business and IT challenges, contact your local representative or authorized reseller, visit or explore and compare products in the EMC Store Copyright 2014 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims 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 EMC.com. VMware and <insert other VMware marks in alphabetical order; remove sentence if no VMware marks needed. Remove highlight and brackets> are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. All other trademarks used herein are the property of their respective owners. Part Number H13774 <required, see Part numbers for more info> 2

3 TABLE OF CONTENTS EXECUTIVE SUMMARY... 4 AUDIENCE... 4 TROUBLESHOOTING GUIDE CHECK IF ACS SERVER IS RUNNING WITHOUT ANY ISSUES CHECK IF ACS IS CONFIGURED TO SERVE THE REPOSITORY STANDALONE DFC CODE TO RETRIEVE THE ACS READ URLS FOR AN OBJECT:... 8 CONCLUSION:

4 EXECUTIVE SUMMARY This whitepaper is an in depth troubleshooting guide for Documentum ACS read URL generation failures. Failure of read operation after the ACS read URL is generated is out of this whitepaper s scope. AUDIENCE This whitepaper is intended for external circulation which will include technical support teams as well as customers. TROUBLESHOOTING GUIDE 1. CHECK IF ACS SERVER IS RUNNING WITHOUT ANY ISSUES. CHECK IF DOCUMENTUM JAVA METHOD SERVER SERVICE IS RUNNING. On the Content Server host, - Navigate to services.msc - Ensure that the service "Documentum Java Method Server" is started correctly in the services console. CHECK IF ACS IS RUNNING. Dump the ACS config object - dm_acs_config and note the acs_base_url attribute. The acs_base_url must be of the from while using http protocol and while using https protocol. Provide the acs_base_url in the browser and verify if you are getting the below response as below. ACS Server Is Running - Version : <Version> If the above is failing, please check the contents of the log and logs folder in the location <JBOSS_HOME>\server\DctmServer_MethodServer for the reasons for failure. 4

5 2. CHECK IF ACS IS CONFIGURED TO SERVE THE REPOSITORY. CHECK THE OUTPUT OF DMQDOCBROKER UTILITY: On the Content Server host, perform the following : - Navigate to the command prompt - Verify the output of the utility dmqdocbroker with the following options: -a -c getservermap <docbase name> -t hostname -p port. The input docbroker host and port must be the one provided in the dfc.properties file which the application is using. For the correctly configured environment the output of the above dmqdocbroker command must show the ACS server details as shown below. Figure 1: dmqdocbroker utility output 5

6 CHECK THE ACS.PROPERTIES FILE IF THE REPOSITORY DETAILS TO WHICH ACS NEEDS TO SERVE ARE PROVIDED CORRECTLY: Open the acs.properties file present in the content server machine and verify that the below repository related configuration options are set correctly. repository.name.x corresponds to repository.login.x, repository.password.x and repository.acsconfig.x 1. ACS configuration option that specifies a name of the repository that ACS can serve content from. Multiple values are supported in the acs.properites file using the following format: repository.name=val repository.name.1=val1 repository.name.2=val2 2. ACS configuration option that specifies a login name for a given repository. Multiple values are supported in the acs.properites file using the following format: repository.login=user repository.login.1=user1 repository.login.2=user2 3. ACS configuration option that specifies a password for a given repository. Note: This key is expected to be encrypted by the configuration utility. Multiple values are supported in the acs.properites file using the following format: repository.password= repository.password.1= repository.password.2= Normally anonymous login is used so no value is provided repository.password= 4. ACS Configuration option that specifies the name of the acs configuration object in the repository. Multiple values are supported in the same format as mentioned above repository.acsconfig=config126vm0acs repository.acsconfig.1=config126vm1acs1 repository.acsconfig.2=config126vm2acs2 6

7 CHECK IF THE CONFIGURATIONS FOR ACS READ ARE SET CORRECTLY. 1. Check for the below attributes in the following object dump files : dm_acs_config object - check the value for the attribute : acs_rw_capability Specifies whether the ACS is enabled and whether it can use surrogate get. The valid values are: 0 : ACS is disabled. 1 : ACS is enabled 3 : SurrogateGet is enabled. dm_acs_config object - check the value for the attribute : config_type Specifies whether the accessible storage areas and defined projection targets are configured in the server config object or this acs config object. The valid values are: 1: Server config object (identified in srv_config_id) 2: Acs config object (defined in the near_stores and projection- related properties) If value is 1, then check the svr_config_id attribute in dm_acs_config, it must match the correct r_object_id of the dm_server_config object. Check the server.ini file and dm_server_config object whether correct projection host and port details are present. The value present in server.ini will take precedence over value present in dm_server_config object. If value is 2, then check if the attributes projection_enable, projection_targets and projection_ports in the dm_acs_config object are present correctly. dm_cont_transfer_config - check the value for the attribute : acs_read_mode Specifies whether ACS servers associated with the repository can transfer content to users for reading. The valid values are: 0: Disabled 1: Enabled The default is 1. The value in this property overrides any capability defined for individual ACS servers. 7

8 The following commands in IAPI will help in getting the dump of ACS config object:?,c,select r_object_id from dm_acs_config dump,c,<r_object_id> 2. Verify that ACS transfer is set for the method preferacstransfer(true) in IDfAcsTransferPreferences in the custom code which is used. If any WDK based application used then verify accelerated read is set to true in its wdk/app.xml file <accelerated-read> <enabled>true</enabled> </accelerated-read> STANDALONE DFC CODE TO RETRIEVE THE ACS READ URLS FOR AN OBJECT: Please change the Docbase, username, password and r_object_id as per your environment for the below standalone DFC code to retrieve ACS read URLs for an object. import com.documentum.com.*; import com.documentum.fc.client.*; import com.documentum.fc.client.acs.*; import com.documentum.fc.common.*; public class TestACSURLs public static void main(string[] args) String strdocbase = "APOLLO"; String struser = "Administrator"; String strpassword = "password"; String r_object_id = "09001dbd80052df7"; try printacsurls(strdocbase, struser, strpassword, r_object_id); catch (DfException ex) ex.printstacktrace(); 8

9 private static void printacsurls(string strdocbase, String struser, String strpassword, String objid) throws DfException try IDfSession session = null; IDfClient client = DfClient.getLocalClient(); IDfSessionManager sessionmanager = client.newsessionmanager(); sessionmanager.setidentity(strdocbase, new DfLoginInfo(strUser, strpassword)); session = sessionmanager.newsession(strdocbase); if (session.isconnected()) IDfSysObject sysobject = (IDfSysObject) session.getobject(new DfId(objId)); String formatname = sysobject.getformat().getname(); IDfEnumeration acsrequests = sysobject.getacsrequests(formatname, 0, null, constructpreferences()); if (acsrequests.hasmoreelements()) while (acsrequests.hasmoreelements()) IDfAcsRequest acsrequest=(idfacsrequest) acsrequests.nextelement(); String acsurl = acsrequest.makeurl(); System.out.println(" URL for object id " + objid + " = " + acsurl); else System.out.println(" No URL for " + objid); sessionmanager.release(session); session = null; sessionmanager = null; catch (DfException e) System.out.println(e.toString()); 9

10 private static IDfAcsTransferPreferences constructpreferences() IDfClientX clientx = new DfClientX(); IDfAcsTransferPreferences transferprefs = clientx.getacstransferpreferences(); transferprefs.preferacstransfer(true); return transferprefs; CONCLUSION: This white paper provides all the details related to troubleshooting Documentum ACS read URL generation failures. 10