CMIS c1932200

March 28, 2018 | Author: Luis Alberto Medinelli Sanino | Category: Installation (Computer Programs), Hypertext Transfer Protocol, Computer Architecture, Areas Of Computer Science, Computer Engineering
Share
Report this link


Comments



Description

IBM Content Management Interoperability Services for FileNet Content ManagerVersion 1.0.0 Planning, Installing, and Configuring IBM Content Management Interoperability Services for FileNet Content Manager SC19-3220-00 IBM Content Management Interoperability Services for FileNet Content Manager Version 1.0.0 Planning, Installing, and Configuring IBM Content Management Interoperability Services for FileNet Content Manager SC19-3220-00 Note Before using this information and the product it supports. . US Government Users Restricted Rights – Use. read the information in “Notices” on page 83. Edition notices This edition applies to version 5. release 0. © Copyright IBM Corporation 2010. modification 0 of IBM FileNet Content Manager (product number 5724-R81) and to all subsequent releases and modifications until otherwise indicated in new editions. . duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. . . . Configuring single sign-on . . . . Links in private working copy support . . . . CMIS . Configuring advanced IBM CMIS for FileNet Content Manager properties . . . . . . . . . . . . . . Object store ID extension . . . . . . . Text search engine extension. . 35 . 50 . . . . . . . . . . . . . . . . . . . . 2010. . . . . . . . . . Useful resources . . 38 39 40 41 42 Troubleshooting IBM CMIS for FileNet Content Manager . . . . . 65 iii . . . . . . . Paging feed support . . 14 . . . . . . Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration . . . . Query support . . . . . . . 30 . . . . 6 User authentication and security. . . . . . . . 6 Support for IBM FileNet Content Manager CVL security . . Choice list display name extension . . . . 25 Configuring the IBM CMIS for FileNet Content Manager web application . . . . Configuring Lightweight Third Party Authentication (LTPA) . . . . . . . . . . . . . Extensions for IBM CMIS for FileNet Content Manager . Manually deploying IBM CMIS for FileNet Content Manager . . . . . Change token support . . . . . . . . . . . . . 19 Installing the IBM CMIS for FileNet Content Manager software . . . . . installing. . . . . Importing the WS-Security policy set to WebSphere Application Server . . Configuring logging . . . . . . 47 Planning. . 8 Installation and configuration worksheet . . . . . . . Object store database type extension . . . Class display name extension . . . . . . . . . .com and related resources. . . . . 5 Prerequisites . . . . . Installing Content Engine Client files for IBM for FileNet Content Manager . . OASIS CMIS specification . . . . . . . . . . . . Modifying the generic JVM arguments in WebSphere Application Server . . . . Running the installation program . . . . . . . . . . . . Configuring IBM CMIS by running the configuration tool . . . . . . . . and configuring IBM CMIS for FileNet Content Manager . . . . . 65 IBM CMIS for FileNet Content Manager log files . . . . . . 9 Silent installation and configuration worksheet . . . 27 . . . . . . . . . . . . . . . . . . 25 . . . . . . . v Contacting IBM . 36 .Contents ibm. . Hidden properties extension . . . . . . . . . . . . . . . . . 50 . . . . . . . . . . . . . . Deploying the IBM CMIS for FileNet Content Manager application manually . . Specifying log level entries . . . . . . . . . . . . . . 19 20 21 22 Configuring IBM CMIS for FileNet Content Manager . . . . 47 Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool . . . . . . . 7 Installation and configuration worksheets. 53 54 54 55 55 56 56 57 57 57 57 58 58 58 58 59 59 60 60 61 61 63 63 Installing IBM CMIS for FileNet Content Manager . . . v How to send your comments . . . . . . . . . . . . . . . . . . Choice list symbolic name extension . . . . . . . . . . . . . Logged errors . . . . . . . Configuring Lightweight Directory Access Protocol (LDAP) . . vi Configuring Content Engine API client logging 42 Deploying IBM CMIS for FileNet Content Manager . . . . 5 Recommended server topology . . . . Versioning properties on document objects support. . . . . . . . . . . 5 Planning for WebSphere Application Server . . . . . . . . . . . . . . . . . . IBM CMIS for FileNet Content Manager URI templates . . . . . . . . . . . . GZIP compression extension. . . . . . . . . . . . . 3 Planning for IBM CMIS for FileNet Content Manager . . . . . Domain name extension . . . . . . . . . . . . . . . . . . . . . . . . . . . © Copyright IBM Corp. . . . Running a silent installation . . 25 . . . . . . . . . 1 IBM CMIS for FileNet Content Manager architecture overview . . . . . . . . . . Best practices for developing client applications . . IBM CMIS for FileNet Content Manager implementation of the OASIS CMIS specification . . . . . . . . . Configuring IBM CMIS by running a silent configuration . . . . . . . Configuring log location and size . . . . . . . . . . . 53 IBM CMIS for FileNet Content Manager index page IBM CMIS for FileNet Content Manager service collection URLs . . . . . . . 51 . . . . Records management extension. . . . 6 Language support for IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . . . 51 IBM CMIS for FileNet Content Manager Development . . . 48 . . . . . . . . . . . . . 11 Advanced configuration worksheet . . . . . . . . . . . Installing. . . . 86 Removing IBM CMIS for FileNet Content Manager . . . 87 iv Planning. . . . . . . . . . . . . . 79 Removing IBM CMIS for FileNet Content Manager from WebSphere Application Server . . . . 69 Accessibility features of IBM CMIS for FileNet Content Manager . . . . . . .Collecting data for IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . . . . . . . . . . . 80 Index . . . 83 Trademarks . . . . . . . . . . . . . . . . . . . . . and Configuring IBM CMIS for FileNet Content Manager . . . . . . 67 Error messages for IBM CMIS for FileNet Content Manager . . . . . 81 Notices . . . . . . . Include the name of the product.adobe. take the Consumability Survey at http://www. you can download it from the Adobe website at http://www. If you want to help IBM make this product easier to use.ibm. 2010. a table number. Support and assistance Product support is available from the IBM® Support Portal at http:// www. and the name and publication number of the information (if applicable.com®.ibm.com/software/data/info/ consumability-survey/. v Send your comments by email to [email protected]. the version number of the product.ibm. Consumability survey You are invited to tell IBM how to improve the consumability of software products. or a page number).com/infocenter/p8docs/v5r0m0/.boulder. Information center You can view the product documentation in an Eclipse-based information center on ibm.ibm. a title. You can use the following methods to provide comments: v Click the Feedback link at the bottom of any topic in the information center. © Copyright IBM Corp.com and related resources Product support and documentation are available from ibm. See the IBM CMIS for FileNet® Content Manager product publication library page for links to the PDF publications at http://www.com.com/support/ docview.ibm. Send any comments that you have about this information or other documentation that IBM Software Development ships with its products.com.wss?uid=swg27020097 “How to send your comments” “Contacting IBM” on page vi How to send your comments Your feedback helps IBM provide quality information. If you do not have the Acrobat Reader installed. PDF publications You can view the PDF files online by using the Adobe Acrobat Reader for your operating system. v .ibm.com/software/data/content-management/filenet-content-manager/ support. include the location of the text (for example.) If you are commenting on specific text.com at http://publib. vi Planning. call one of the following numbers: v In the United States: 1-888-426-4343 v In Canada: 1-800-465-9600 For more information about how to contact IBM. call 1-800-IBM-SERV (1-800-426-7378).ibm. see the Contact IBM Web site at http://www. Installing.com/contact/us/. To learn about available service options.Contacting IBM To contact IBM customer service in the United States or Canada. and Configuring IBM CMIS for FileNet Content Manager . installation. Perform once to install the product. FileNet Content Manager” on you through the IBM CMIS page 25 for FileNet Content Manager configuration. Use this information to plan for. 1 . “Configuring IBM CMIS for The configuration tool guides Perform as needed to configure the product. © Copyright IBM Corp. to install and configure IBM CMIS for FileNet Content Manager. To use this information. configuration. Analyze your business needs and decide how to structure your content management system. you should be familiar with: v WebSphere® Application Server or WebSphere Application Server Network Deployment v IBM FileNet Content Engine v IBM FileNet Content Manager v System operation and network administration The following table summarizes and links to the high-level tasks for planning. installing. and administration tasks Task What you can do When to perform Perform before you begin the product installation. “Planning for IBM CMIS for Verify that you have all the FileNet Content Manager” on prerequisite products page 5 installed and configured. installing. Planning. Table 1.Planning. and configuring IBM CMIS for FileNet Content Manager. install. or configure IBM CMIS for FileNet Content Manager. you should be familiar with one or more of the following operating systems: v AIX® v Linux v Microsoft Windows In addition. and configuring IBM CMIS for FileNet Content Manager IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) enables clients applications that use the OASIS CMIS standard to work with content that is stored on IBM FileNet Content Engine. 2010. The installation program “Installing IBM CMIS for FileNet Content Manager” on guides you through the IBM page 19 CMIS for FileNet Content Manager installation. Perform as needed. “Deploying IBM CMIS for The configuration tool guides FileNet Content Manager” on you through deploying IBM page 47 CMIS for FileNet Content Manager on WebSphere Application Server.Table 1. “IBM CMIS for FileNet Content Manager Development” on page 53 Use the OASIS CMIS specification and the IBM FileNet P8 extensions to interact with the OASIS CMIS bindings or to develop against a CMIS client API. page 79 IBM CMIS for FileNet Content Manager from the server. on page 65 Perform as needed. installation. or you can manually deploy IBM CMIS for FileNet Content Manager. “Troubleshooting IBM CMIS Troubleshoot IBM CMIS for for FileNet Content Manager” FileNet Content Manager. Planning. Perform once to remove the The uninstallation wizard “Removing IBM CMIS for FileNet Content Manager” on guides you through removing product. configuration. and Configuring IBM CMIS for FileNet Content Manager . 2 Planning. Installing. and administration tasks (continued) Task What you can do When to perform Perform as needed to deploy changes to the configuration to WebSphere Application Server. Then you can remove IBM CMIS for FileNet Content Manager from WebSphere Application Server. it is recommended that you dedicate a server in your IBM FileNet P8 system to IBM CMIS for FileNet Content Manager. IBM CMIS for FileNet Content Manager is the implementation of the OASIS CMIS standard for IBM FileNet Content Manager. After you install IBM CMIS for FileNet Content Manager. 2010. you must install the Content Engine Client on the machine where IBM CMIS for FileNet Content Manager will be deployed and install the Content Engine Client Java API files in the IBM CMIS for FileNet Content Manager installation directory. © Copyright IBM Corp. In addition. IBM CMIS for FileNet Content Manager communicates with Content Engine by using the Content Engine Client Java API.IBM CMIS for FileNet Content Manager architecture overview IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) is a web application that enables client applications that use the OASIS CMIS standard to work with content that is stored on IBM FileNet Content Engine. The OASIS CMIS standard enables client applications to work with multiple content management systems by defining a standard domain model and standard set of services and protocol bindings for Web Services and RESTful Atom Publishing Protocol (AtomPub). IBM FileNet P8 System Content Engine server WebSphere Application Server IBM CMIS for FileNet Content Manager server WebSphere Application Server IBM CMIS for FileNet Content Manager IBM FileNet Content Engine Client Java API REST and Web Services Bindings CMIS client application IBM FileNet Content Engine CMIS-enabled enterprise content management system It is recommended that you deploy IBM CMIS for FileNet Content Manager to a dedicated application server. 3 . The following diagram shows how IBM CMIS for FileNet Content Manager connects to your IBM FileNet P8 system and your client application. Installing. and Configuring IBM CMIS for FileNet Content Manager . 4 Planning.IBM CMIS for FileNet Content Manager and other CMIS-enabled enterprise content management systems communicate with client applications by using REST and Web Services bindings. © Copyright IBM Corp. You can deploy IBM CMIS to a dedicated application server node. 2010.ibm. the JVM arguments on the server are modified. The node is not federated to the deployment manager. you can deploy IBM CMIS to the following topologies: Unmanaged nodes An unmanaged node is an application server node with its own administration facilities. WebSphere Application Server Network Deployment topologies If you use WebSphere Application Server Network Deployment. you can deploy IBM CMIS to a dedicated application server. 5 . A complete and up-to-date list of the hardware and software requirements for IBM CMIS for FileNet Content Manager is available on the IBM support site at http://www. v When more than one application is installed in an application server.wss?uid=swg27019859. Important: Regardless of the WebSphere Application Server topology that you deploy to. Planning for WebSphere Application Server IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) can be deployed to several different WebSphere Application Server topologies. which can affect other applications on that server. it is strongly recommended that you install IBM CMIS to a dedicated application server or application server cluster for the following reasons: v When IBM CMIS is installed to an application server. “Prerequisites” “Planning for WebSphere Application Server” “Recommended server topology” on page 6 “User authentication and security” on page 6 “Language support for IBM CMIS for FileNet Content Manager” on page 7 “Installation and configuration worksheets” on page 8 Prerequisites The IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) hardware and software requirements document provides detailed information about the supported versions of each prerequisite application.com/support/docview.Planning for IBM CMIS for FileNet Content Manager The following topics can help you plan your IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) system installation and configuration. the scalability of each application decreases. WebSphere Application Server topologies If you use WebSphere Application Server. The deployment manager deploys the application to the cluster members. For better performance and scalability. when IBM CMIS for FileNet Content Manager caches the CVLs. on separate servers. v Server 2: WebSphere Application Server. However. which is required for full-text search. The server configuration that you use can affect the performance and scalability of your system.Managed nodes A managed node is an application server node that is federated to the deployment manager. 6 Planning. you must decide how to implement support for IBM FileNet Content Manager CVL security in your IBM CMIS for FileNet Content Manager application. Content Engine v Server 3: WebSphere Application Server. the security settings that are configured for the CVLs in your IBM FileNet Content Manager system are ignored. IBM CMIS for FileNet Content Manager v Server 4: Database v Server 5: Directory service servers User authentication and security IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) uses the same LDAP server and the same LTPA keys that are configured for the IBM FileNet Content Engine server. In addition. and Configuring IBM CMIS for FileNet Content Manager . The following list describes the recommended server configuration for a scenario that does not include a high-availability system: v Server 1: Content Search Engine. Installing. The components of an IBM FileNet P8 system are often spread across several servers. You can deploy IBM CMIS to a dedicated application server node. it is recommended that you install IBM FileNet Content Engine and any client applications. “Support for IBM FileNet Content Manager CVL security” Support for IBM FileNet Content Manager CVL security By default. Recommended server topology IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) is an optional component of an IBM FileNet Content Manager system. IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) caches controlled vocabulary lists (CVLs) for all users to improve performance. such as IBM CMIS for FileNet Content Manager. You must enable single sign-on (SSO) between the application servers that host IBM FileNet Content Engine and IBM CMIS for FileNet Content Manager. A IBM FileNet P8 system generally requires a set of dedicated servers. Clusters A cluster is a group of application servers that share the load for an application. Important: If you use headers to specify the language in which to display content. IBM CMIS uses the following rules of precedence to determine the locale: 1. and error messages for IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) are provided in several languages. IBM CMIS uses the language of the JVM on the IBM CMIS application server. about page. Tip: By default. IBM CMIS displays content in English.If your IBM FileNet Content Manager CVLs are configured to prevent some users from seeing certain CVLs. IBM CMIS uses the following rules of precedence to determine the locale: 1. You can specify the language that is displayed in the installation program and the configuration tool. IBM CMIS uses the language of the JVM on the IBM CMIS application server. However. you must understand the following restrictions and behaviors: Planning for IBM CMIS for FileNet Content Manager 7 . If you use Web Services. 3. If the language of the JVM is not available. 2. IBM CMIS uses the language that is specified in the locale element of the i18n:international element of the WS-I18N header. 2. Tip: By default. Related reference “CVL caching (CVL_Cache)” on page 32 Language support for IBM CMIS for FileNet Content Manager The installation program. you can configure IBM CMIS for FileNet Content Manager to honor the CVL security settings. IBM CMIS displays content in English. such as type definition and property definition display names and descriptions If you use REST services. and configuration page v IBM FileNet P8 metadata. IBM CMIS uses the language that is specified in the Accept-Language header of an HTTP request. If the Accept-Language header is not available or does not specify a supported language. If the WS-I18N header is not available or does not specify a supported language. configuration tool. 4. 3. If the Accept-Language header is not available or does not specify a supported language. WebSphere Application Server sets the JVM to English. IBM CMIS uses the language that is specified in the Accept-Language header of the HTTP request. If the language of the JVM is not available. WebSphere Application Server sets the JVM to English. IBM CMIS uses locale settings to determine the language in which to display the following information: v Error messages in HTTP responses v IBM CMIS index page. q=1. For example. such as q=1). Brazilian Spanish Language code zh_CN zh_TW en fr de it ja ko pt_BR es In addition. even if the language is supported by the underlying repository. variations of the following languages are partially supported: v Variations of Chinese are displayed in Simplified Chinese v Variations of Portuguese are displayed in Brazilian Portuguese Important: IBM CMIS returns the response (such as messages and display names) in supported languages only.q=. Installing. the header includes the following code. de. If multiple languages are designated as the preferred language. Supported IBM CMIS for FileNet Content Manager languages and language codes Language Chinese.q=1. v If you provide an Accept-Language header with multiple languages.v If you provide a WS-I18N header and an Accept-Language header and both headers specify a supported language. the language that is specified in the WS-I18N header takes precedence.9 IBM CMIS for FileNet Content Manager is available in the following languages: Table 2. Traditional English French German Italian Japanese Korean Portuguese. and Configuring IBM CMIS for FileNet Content Manager . IBM CMIS would display content in French because French is the first entry from the left with the highest quality value: fr. IBM CMIS does not return responses in languages that are not supported. Installation and configuration worksheets Before you install and configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). Simplified Chinese. IBM CMIS uses the first language from the left with the highest value quality. en-US. IBM CMIS displays only the preferred language (the language with the highest quality value. Use the following worksheets to plan your IBM CMIS installation and configuration: “Installation and configuration worksheet” on page 9 “Silent installation and configuration worksheet” on page 11 “Advanced configuration worksheet” on page 14 8 Planning. you should work with your Content Engine system administrator and your WebSphere Application Server system administrator to collect the information that you must provide when installing and configuring IBM CMIS. v On Windows. the default installation directory is C:\Program Files\IBM\FN_CMIS. Content Engine user name If you want to verify the connection to the Content Engine system. If you do not provide a domain name. The URL is case-sensitive and has the format: iiop://host_name:2809/FileNet/ Engine. After you install the IBM CMIS software. Installation information When you install IBM CMIS for FileNet Content Manager.Installation and configuration worksheet Work with your Content Engine system administrator and your WebSphere Application Server system administrator to collect the information that you must provide when installing and configuring IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). FileNet P8 domain name Optional. Table 4. Value Content Engine password Planning for IBM CMIS for FileNet Content Manager 9 . you must provide a user name. v On AIX and Linux. If you want to verify the connection to the Content Engine system. Content Engine parameters Parameter Content Engine URL Description The URL that applications use to connect to Content Engine. you must install the Content Engine Client API files in the IBM CMIS installation directory. you specify the directory in which to install the IBM CMIS software. Table 3. You also specify basic information about your IBM CMIS system that client applications use when sending requests to IBM CMIS for FileNet Content Manager. Value Basic configuration parameters When you run the configuration tool you specify information about your Content Engine system and your WebSphere Application Server system. you must provide a password. Installation parameters Parameter Installation directory Description IBM CMIS installation directory. IBM CMIS connects to the default domain. the default installation directory is /opt/IBM/FN_CMIS. Collect the following information about the Content Engine server to which you are connecting. the default installation directory is C:\Program Files\IBM\WebSphere\AppServer. The WebSphere Application Server administrator password. WS-Security authentication This method uses a WS-Security SOAP header to authenticate. Installing. Application security parameters Parameter Authentication method for web services Description The authentication method that client applications use when sending requests to the IBM CMIS web services. Table 6. Table 5. The WebSphere Application Server administrator user name. Value Collect the following information about your WebSphere Application Server system. the default installation directory is /opt/IBM/WebSphere/ AppServer v On Windows. the default installation directory is /usr/IBM/WebSphere/ AppServer.Collect the following information about how you plan to authenticate to IBM CMIS after it is deployed. Administrator user name Password 10 Planning. and Configuring IBM CMIS for FileNet Content Manager . WebSphere Application Server parameters Parameter Description Value WebSphere Application The instance of WebSphere Application Server installation directory Server to which you are deploying IBM CMIS. v On Linux. Application server profile The WebSphere Application Server profile on which you are deploying IBM CMIS. v On AIX. Important: You must deploy IBM CMIS to an existing profile that has WebSphere Application Server security enabled. Valid values include: HTTP basic authentication This method uses an encoded user name and password in an HTTP header to authenticate. Installation information When you install IBM CMIS for FileNet Content Manager. Application server node and The node and server on which you are server name deploying IBM CMIS. you specify the directory in which to install the IBM CMIS software. Application server cluster Use this option if you plan to deploy IBM CMIS to an application server cluster on WebSphere Application Server Network Deployment.Table 6. Value Silent installation and configuration worksheet Work with your Content Engine system administrator and your WebSphere Application Server system administrator to collect the information that you must provide when silently installing and configuring IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). Important: You must deploy IBM CMIS to an existing cluster. The default name is fncmis. Important: You must deploy IBM CMIS to an existing server. This parameter applies to an Application server cluster deployment environment only. Valid values include: Single application server Use this option if you plan to deploy IBM CMIS to an application server on WebSphere Application Server or an unmanaged node or managed node on WebSphere Application Server Network Deployment. This parameter applies to a Single application server deployment environment only. Optional. WebSphere Application Server parameters (continued) Parameter Deployment environment Description The type of WebSphere Application Server environment into which you are deploying IBM CMIS. Application server cluster name The cluster on which you are deploying IBM CMIS. Application name The name of the IBM CMIS application to display in the WebSphere Application Server administrative console. Planning for IBM CMIS for FileNet Content Manager 11 . Installation parameters Parameter USER_INSTALL_DIR Description IBM CMIS installation directory. Collect the following information about the Content Engine server to which you are connecting. IBM CMIS connects to the default domain. you must specify information about your Content Engine system and your WebSphere Application Server system in the silent configuration response file. the default installation directory is C:\Program Files\IBM\FN_CMIS. Optional. Value Collect the following information about how you plan to authenticate to IBM CMIS after it is deployed. you must install the Content Engine Client API files in the IBM CMIS installation directory. USER_P8_DOMAIN FileNet P8 domain name. v On Windows. 12 Planning. Value Basic configuration parameters To run the silent configuration program. the default installation directory is /opt/IBM/FN_CMIS. Table 8. Installing.After you install the IBM CMIS software. and Configuring IBM CMIS for FileNet Content Manager . The URL that applications use to connect to Content Engine. If you do not provide a domain name. Content Engine parameters Parameter USER_CE_URI Description Content Engine URL. v On AIX and Linux. Table 7. You must also specify basic information about your IBM CMIS system that client applications use when sending requests to IBM CMIS for FileNet Content Manager. The URL is case-sensitive and has the format: iiop://host_name:2809/FileNet/ Engine. the default installation directory is /opt/IBM/WebSphere/ AppServer v On Windows. The WebSphere Application Server administrator password. the default installation directory is /usr/IBM/WebSphere/ AppServer. USER_WASADMIN_ID USER_WASADMIN_PW Planning for IBM CMIS for FileNet Content Manager 13 . The authentication method that client applications use when sending requests to the IBM CMIS web services. The instance of WebSphere Application Server to which you are deploying IBM CMIS. This method uses an encoded user name and password in an HTTP header to authenticate.Table 9. The WebSphere Application Server administrator user name. This method uses a WS-Security SOAP header to authenticate. WebSphere Application Server parameters Parameter Description Value USER_APPSERVER_HOME WebSphere Application Server installation directory. Table 10. v On Linux. Application security parameters Parameter USER_WS_AUTH Description Authentication method for web services. Valid values include: 0 HTTP basic authentication. Value 1 Collect the following information about your WebSphere Application Server system. USER_APPSERVER _PROFILE_NAME The WebSphere Application Server profile on which you are deploying IBM CMIS. the default installation directory is C:\Program Files\IBM\WebSphere\AppServer. Important: You must deploy IBM CMIS to an existing profile that has WebSphere Application Server security enabled. WS-Security authentication. v On AIX. you can run IBM CMIS by using the default values that are specified in the advanced configuration properties file. This parameter applies to an appserver deployment environment only. Installing. This parameter applies to an appserver deployment environment only. However. WebSphere Application Server parameters (continued) Parameter USER_DEPLOY_TYPE Description The type of WebSphere Application Server environment into which you are deploying IBM CMIS. and Configuring IBM CMIS for FileNet Content Manager . cluster Use this option if you plan to deploy IBM CMIS to an application server cluster on WebSphere Application Server Network Deployment. Important: You must deploy IBM CMIS to an existing cluster. Value Advanced configuration worksheet IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) includes advanced configuration parameters that enable you to tune your system for optimal performance and scaling. USER_APPSERVER_NODE The name of the application server node that contains the application server on which you are deploying IBM CMIS. USER_APP_NAME The name of the IBM CMIS application to display in the WebSphere Application Server administrative console. Optional. USER_APPSERVER_NAME The name of the server on which you are deploying IBM CMIS. This parameter applies to a cluster deployment environment only. The default name is fncmis.Table 10. Valid values include: appserver Use this option if you plan to deploy IBM CMIS to an application server on WebSphere Application Server or an unmanaged node or managed node on WebSphere Application Server Network Deployment. USER_APPSERVER_ CLUSTER_NAME The cluster on which you are deploying IBM CMIS. Important: You must deploy IBM CMIS to an existing server. 14 Planning. The default value is 25. The default value is true. Tip: It is recommended that you review the topics for each advanced configuration parameter for additional information about the parameters and to determine whether it makes sense to modify the parameters for your environment. The URL must have the form http://host_name:port. Advanced configuration parameters Parameter cmisURI Description The URL to which client applications send requests. you do not need to specify a value for this parameter. The default value is 3600000 milliseconds. CRC_TIME_TO_LIVE The length of time (in milliseconds) that object stores are kept in the client-side server cache. For most IBM CMIS configurations. The default value is 3600000 milliseconds. CMC_TIME_TO_LIVE The length of time (in milliseconds) that the Content Engine metadata is kept in the Content Engine Client Metadata Cache. checkout_copycontent Whether to copy the content stream of a checked out document to the content stream of the private working copy. Valid values include: false true defaultMaxItems Do not copy the content stream to the Private Working Copy. Table 11. However. Planning for IBM CMIS for FileNet Content Manager 15 . you can specify the URL by which IBM CMIS and client applications communicate if you want to force client applications to access IBM CMIS through a specific URL or if your proxy server settings cause IBM CMIS to produce invalid URLs.Collect information about the advanced parameters that you want to configure for your IBM CMIS environment. Copy the content stream to the Private Working Copy. Value The maximum number of items to return when an HTTP request does not specify a value for the maxItems parameter. The default value is false. IBM CMIS caches the CVLs to improve performance. IBM CMIS ignores any CVL security settings. IBM CMIS ignores the security settings that are configured for IBM FileNet Content Manager CLVs. Valid values include: false Do not cache the CVLs for all users. IBM CMIS ignores the ACL settings for the Creator and DateCreated properties. Value true SecureMetadataCache Whether to cache class definition metadata for all users. If the class definition metadata is cached. and Configuring IBM CMIS for FileNet Content Manager . When this value is specified. true 16 Planning. By default. IBM CMIS honors the ACL settings for the Creator and DateCreated properties.Table 11. The default value is true. When this value is specified. IBM CMIS caches the class definition metadata to improve performance. If the CVLs are cached. IBM CMIS displays the following properties to all users regardless of their access control list (ACL) permissions: v Creator v DateCreated By default. Advanced configuration parameters (continued) Parameter CVL_Cache Description Whether to cache IBM FileNet Content Manager controlled vocabulary lists (CVLs) for all users. When this value is specified. When this value is specified. Valid values include: false Cache the class definition metadata. IBM CMIS honors the security settings that are configured for IBM FileNet Content Manager CLVs. Installing. Do not cache the class definition metadata. Cache the CVLs for all users. xml. WebSphere Application Server uses a 65536 byte buffer. IBM CMIS can override this setting. IBM CMIS does not override the default value that is set in WebSphere Application Server. IBM CMIS returns hidden properties.ibm. Filter hidden properties. queryTimeLimit The maximum length of time (in seconds) to run a query on the repository. util.api. When this value is specified. Advanced configuration parameters (continued) Parameter filterHiddenProperties Description Whether to return hidden properties to client applications. Related tasks “Configuring advanced IBM CMIS for FileNet Content Manager properties” on page 30 Planning for IBM CMIS for FileNet Content Manager 17 .xlxp2. The default value is 180 seconds.DataSource Factory. If you specify 0 for this parameter. IBM CMIS does not return hidden properties. By default IBM CMIS uses a 2048 byte buffer.bufferLength The size of the internal buffers that are used to create documents with content on the repository when using IBM CMIS Web Services. When this value is specified. However. The default value is true.encoding. Value true com. It is recommended that you do not change the default value because increasing the size of the buffer can cause memory consumption issues when uploading documents larger than 50 MB through IBM CMIS Web Services.Table 11. Valid values include: false Do not filter hidden properties. Installing.18 Planning. and Configuring IBM CMIS for FileNet Content Manager . it is recommended that you complete the “Installation and configuration worksheets” on page 8. complete the following tasks. you must install the prerequisite software on the server where you plan to host IBM CMIS. you must install the prerequisite software on the server where you plan to host IBM CMIS. “Installing the IBM CMIS for FileNet Content Manager software” 2. “Installing Content Engine Client files for IBM CMIS for FileNet Content Manager” on page 22 Related concepts “Prerequisites” on page 5 Related reference “Installation and configuration worksheets” on page 8 Installing the IBM CMIS for FileNet Content Manager software You can install the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) software on the workstation by running the installation program or by running a silent installation. The installation instructions assume that you have a working IBM FileNet Content Manager system and that you are installing IBM CMIS for FileNet Content Manager to the default installation directory. The high-level installation and configuration sequence for IBM CMIS for FileNet Content Manager is: 1.Installing IBM CMIS for FileNet Content Manager You can install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) on AIX. Configure IBM CMIS for FileNet Content Manager. Before you install IBM CMIS. © Copyright IBM Corp. Table 12. For more information. Linux. see the “Prerequisites” on page 5 topic. or Windows operating systems. Install the IBM CMIS for FileNet Content Manager software. Default installation directory on each supported operating system Operating system AIX Linux Windows Default directory /opt/IBM/FN_CMIS /opt/IBM/FN_CMIS C:\Program Files\IBM\FN_CMIS To install IBM CMIS for FileNet Content Manager. 2010. Deploy IBM CMIS for FileNet Content Manager. Before you install IBM CMIS. 3. Install the Content Engine Client files for IBM CMIS for FileNet Content Manager. 19 . In addition. For more information. 1. see the “Prerequisites” on page 5 topic. 2. 4. To install the IBM CMIS software. After you install IBM CMIS for FileNet Content Manager. 3. Configure IBM CMIS for FileNet Content Manager. 2. change to the IBM CMIS for FileNet Content Manager CD or to the directory where you downloaded the product and enter: . To install IBM CMIS for FileNet Content Manager: 1. you must: 1. Installing. At a command prompt./install.bat. see the “Prerequisites” on page 5 topic./install. change to the IBM CMIS for FileNet Content Manager CD or to the directory where you downloaded the product and enter: . Before you install IBM CMIS. Read and accept the software license terms. and Configuring IBM CMIS for FileNet Content Manager . “Running the installation program” “Running a silent installation” on page 21 Running the installation program You can install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) on the server by running the installation program. 4. In addition. Specify the installation directory. complete one of the following tasks. Install the Content Engine Client API files in the IBM CMIS for FileNet Content Manager installation directory.In addition. For more information. Linux Windows 2. change to the IBM CMIS for FileNet Content Manager CD or to the directory where you downloaded the product and enter: install. it is recommended that you complete the “Installation and configuration worksheets” on page 8.sh. it is recommended that you complete the “Installation and configuration worksheets” on page 8. 3. Start the installation program: Operating system AIX Installation command At a command prompt. Deploy IBM CMIS for FileNet Content Manager to WebSphere Application Server. you must install the prerequisite software on the server where you plan to host IBM CMIS. At a command prompt. 20 Planning.sh. Verify the installation location and click Install. Related tasks “Installing Content Engine Client files for IBM CMIS for FileNet Content Manager” on page 22 “Configuring the IBM CMIS for FileNet Content Manager web application” on page 25 “Deploying IBM CMIS for FileNet Content Manager” on page 47 Related reference “Installation and configuration worksheets” on page 8 Running a silent installation You can install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) on the server by running a silent installation. Edit the following values in the response file: a. A silent installation uses a response file that contains the installation parameters that you specify. For example. When you run a silent installation. Open the response file: Operating system AIX Linux Windows Response file fncmis-UNIX_SilentInstall. C:\Program Files\IBM\FN_CMIS would have the following format: C\:\\Program Files\\IBM\\FN_CMIS The response file must contain the following text: LICENSE_ACCEPTED=true USER_INSTALL_DIR=installation directory Installing IBM CMIS for FileNet Content Manager 21 . it is recommended that you complete the “Installation and configuration worksheets” on page 8. you must escape colons (:) and backslashes (\) by adding a backslash before each colon or backslash in the installation directory file path. Set the USER_INSTALL_DIR to the directory where you want to install IBM CMIS for FileNet Content Manager. Important: You must save the installation image to the workstation before you run a silent installation so that you can edit the response file.properties fncmis-WIN_SilentInstall.log To install IBM CMIS for FileNet Content Manager: 1.properties fncmis-UNIX_SilentInstall. Set the LICENSE_ACCEPTED parameter to true. In addition. Instead. see the “Prerequisites” on page 5 topic. Important: On Windows. any messages and errors are written to the following log files in the log directory: v fncmis-install. the installation program does not display any installation windows or messages. you must install the prerequisite software on the server where you plan to host IBM CMIS.log v fncmis-install-ia. For more information.properties 2. Before you install IBM CMIS. b. sh -s . you must install the Content Engine Client and add the Content Engine Client API files to the IBM CMIS installation directory. change to the directory that contains the installation program and run the following command: Operating system AIX Linux Windows Command . Install the Content Engine Client API files in the IBM CMIS for FileNet Content Manager installation directory. In the Select FileNet P8 Applications window. The Content Engine Client API files enable IBM CMIS for FileNet Content Manager to communicate with the IBM FileNet Content Manager server. Important: Do not specify the IBM CMIS installation directory as the Content Engine Client installation directory. 4.sh -s install. If the Content Engine Client is already installed on the server where IBM CMIS is installed. 3. Related tasks “Installing Content Engine Client files for IBM CMIS for FileNet Content Manager” “Configuring the IBM CMIS for FileNet Content Manager web application” on page 25 “Deploying IBM CMIS for FileNet Content Manager” on page 47 Related reference “Installation and configuration worksheets” on page 8 Installing Content Engine Client files for IBM CMIS for FileNet Content Manager After you install the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) software./install. Deploy IBM CMIS for FileNet Content Manager to WebSphere Application Server.3. select IBM CMIS for FileNet Content Manager. 2. you must: 1. you must run the Content Engine Client installation program to add the Content Engine Client API files to the IBM CMIS installation directory. Installing. If the Content Engine Client is not installed. specify the directory in which to install the Content Engine Client.bat -s After you install IBM CMIS for FileNet Content Manager. Save your changes to the response file. 22 Planning. Configure IBM CMIS for FileNet Content Manager. you must install the Content Engine Client API files in the IBM CMIS installation directory. Run the Content Engine Client installation program./install. 3. If the Content Engine Client is not installed on the server. Important: You must complete this task before you can configure IBM CMIS. 2. and Configuring IBM CMIS for FileNet Content Manager . At a command prompt. To add the Content Engine Client API files to the IBM CMIS installation directory: 1. verify that the installation program detected the IBM CMIS installation directory.jar After you install the Content Engine Client files for IBM CMIS for FileNet Content Manager. Default installation directory on each supported operating system Operating system AIX Linux Windows Default directory /opt/IBM/FN_CMIS /opt/IBM/FN_CMIS C:\Program Files\IBM\FN_CMIS To verify that the Content Engine Client files were installed to the IBM CMIS installation directory. take one of the following actions: v If IBM CMIS is already installed on the server. In the IBM CMIS for FileNet Content Manager Installation Path window.jar v log4j. Related tasks “Configuring the IBM CMIS for FileNet Content Manager web application” on page 25 Related reference “Installation and configuration worksheets” on page 8 Installing IBM CMIS for FileNet Content Manager 23 . specify the directory where you will install IBM CMIS. By default.4. IBM CMIS is installed in the following directory: Table 13. you can configure IBM CMIS. open the CE_API\lib subdirectory of the installation directory and verify that the directory contains the following files: v Jace. v If IBM CMIS is not installed on the server. and Configuring IBM CMIS for FileNet Content Manager . Installing.24 Planning. Configuring IBM CMIS for FileNet Content Manager After you install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). Tip: The configuration tool retains your configuration and deployment information. you must install the Content Engine Client API files in the IBM CMIS installation directory. Before you can configure the web application. To configure the IBM CMIS web application. 25 . © Copyright IBM Corp. it is recommended that you complete the “Installation and configuration worksheets” on page 8. you must install the Content Engine Client API files in the IBM CMIS installation directory. you can rerun the configuration tool without having to enter each configuration option again. 2010. you must configure the IBM CMIS application and your web application server. In addition. If you need to modify your configuration. it is recommended that you complete the “Installation and configuration worksheets” on page 8. Before you can configure the web application. The configuration tool validates the information that you specify about your IBM FileNet Content Manager system and your WebSphere Application Server environment before you deploy the IBM CMIS web application. To configure IBM CMIS. across sessions. you must configure and build the IBM CMIS web application. “Configuring the IBM CMIS for FileNet Content Manager web application” “Configuring single sign-on” on page 35 “Configuring logging” on page 39 Configuring the IBM CMIS for FileNet Content Manager web application Before you can deploy IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). In addition. complete the following tasks. except for user IDs and passwords. complete the tasks that are appropriate for your environment: “Configuring IBM CMIS by running the configuration tool” “Configuring IBM CMIS by running a silent configuration” on page 27 “Configuring advanced IBM CMIS for FileNet Content Manager properties” on page 30 Related tasks “Installing Content Engine Client files for IBM CMIS for FileNet Content Manager” on page 22 Configuring IBM CMIS by running the configuration tool You can use the configuration tool to build and deploy the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) web application EAR file. IBM CMIS uses the default domain./config. change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: . b. Specify the Content Engine URL.If you select this option. To back up a previous configuration. the configuration tool automatically deploys IBM CMIS to the selected instance of WebSphere Application Server. Optional: Test the connection to the Content Engine server to ensure that you entered the Content Engine URL and FileNet P8 domain name correctly.sh. At a command prompt. Specify the information to connect to the Content Engine server: a./config.Only the most recent configuration information is retained. If you do not specify a domain. and Configuring IBM CMIS for FileNet Content Manager . Installing. Start the configuration tool: Operating system AIX Installation command At a command prompt. 4. To test the connection. you must provide the following information: v Content Engine user name v Password v WebSphere Application Server installation directory 3. This option is recommended for most users. To configure IBM CMIS: 1. Specify the FileNet P8 domain name.bat.sh. v WS-Security Authentication .properties After you Configure and Deploy. Specify the authentication method that client applications use when sending requests to the IBM CMIS web services: v HTTP Basic Authentication . The URL is case-sensitive and has the format iiop:host_name:2809/FileNet/Engine. if any change has to be done to the configuration. At a command prompt. you must save a copy of the following files.Select this option if you want client applications to use a WS-Security SOAP header to authenticate. 5. All values (except IDs and passwords) will be retained in the configuration wizard. Linux Windows 2. change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: . c.properties v fncmis. the configuration wizard can be re-run. Verify your IBM CMIS configuration information. Specify how you are deploying IBM CMIS: v Automatically deploy IBM CMIS .Select this option if you want client applications to use an HTTP header that contains an encoded user name and password to authenticate. which are located in profiles/profile1 subdirectory of the IBM CMIS installation directory: v configure-fncmis. 26 Planning. change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: config. 6. If prompted. A silent configuration uses a response file that contains the configuration and deployment parameters that you specify. start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page. the Configuring IBM CMIS for FileNet Content Manager 27 . the configuration tool does not deploy IBM CMIS. If you tested the connection to the Content Engine server. f. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server or application server cluster. This option is recommended only for expert WebSphere Application Server users. Before you can configure the web application. Verify your WebSphere Application Server deployment information and click Next.v Manually deploy IBM CMIS . Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. e. You must manually deploy IBM CMIS to a supported instance of WebSphere Application Server. c. In addition.If you select this option. Specify the administrator user name and password for the selected application server profile. Specify the instance of WebSphere Application Server to which to deploy IBM CMIS. you must install the Content Engine Client API files in the IBM CMIS installation directory. When you run a silent configuration. Optional: Specify the name to display for the IBM CMIS application in WebSphere Application Server. Related concepts “IBM CMIS for FileNet Content Manager index page” on page 53 Related tasks “Configuring advanced IBM CMIS for FileNet Content Manager properties” on page 30 Configuring IBM CMIS by running a silent configuration You can use the silent configuration program to build and deploy the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) web application EAR file. Specify the application server profile to which to deploy IBM CMIS. index. If the application server profile contains application servers and application server clusters.jsp. 7. it is recommended that you complete the “Installation and configuration worksheets” on page 8. specify the type of server to which you plan to deploy IBM CMIS. The default display name for the application is FN_CMIS. b. a. d. the configuration tool uses the installation directory that you specified in the Content Engine Connection Information window. specify the WebSphere Application Server installation directory. To validate that IBM CMIS was successfully deployed. Specify the cluster or application server to which to deploy IBM CMIS. properties 2. C:\Program Files\IBM\WebSphere\ AppServer would have the following format: 28 Planning. 4.Specify 0 to use HTTP Basic Authentication. 5. you do not need to specify values for the parameters in the Web Application Deployment section of the response file.configuration program does not display any configuration windows or messages. an encoded user name and password in an HTTP header. You must manually deploy IBM CMIS to a supported instance of WebSphere Application Server. Important: On Windows. Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. Specify the information about the WebSphere Application Server environment to which you want to deploy IBM CMIS. any messages and errors are written to the fncmis-config. v 1 .log file in the log directory. Installing. you must specify values for the parameters in the Web Application Deployment section of the response file.properties config/fncmisUNIX_SilentConfig. to authenticate. b. Set the USER_WS_AUTH parameter to one of the following values to specify the authentication method that client applications use when sending requests to the IBM CMIS web services: v 0 . If you specify 1. and Configuring IBM CMIS for FileNet Content Manager .Specify 0 to deploy IBM CMIS to the instance of WebSphere Application Server that you specify in the response file. For example.properties config\fncmisWIN_SilentConfig. Set the USER_CE_URI parameter to the URL of the Content Engine server. a WS-Security SOAP header. a. 3. the configuration program generates the application EAR file but does not deploy IBM CMIS. Specify the information to connect to the Content Engine server: a. Open the response file: Operating system AIX Linux Windows Response file config/fncmisUNIX_SilentConfig.Specify 1 to use WS-Security Authentication. If you specify 1. v 1 . Instead. Set the USER_APPSERVER_HOME parameter to the instance of WebSphere Application Server to which you want to deploy IBM CMIS. to authenticate.Specify 1 to manually deploy IBM CMIS. The URL is case-sensitive and has the format iiop://host_name:2809/ FileNet/Engine. Set the USER_MANUAL_DEPLOY parameter to one of the following values to specify how you want to deploy IBM CMIS: v 0 . you must escape colons (:) and backslashes (\) by adding a backslash before each colon or backslash in the installation directory file path. Set the USER_P8_DOMAIN parameter to the IBM FileNet P8 domain name. If you do not specify a domain. To configure the IBM CMIS for FileNet Content Manager application: 1. If you specify 0. IBM CMIS uses the default domain. jsp. At a command prompt. Configuring IBM CMIS for FileNet Content Manager 29 . 6.sh -s config. If you specified USER_DEPLOY_TYPE=cluster. Set the USER_APPSERVER_PROFILE_NAME parameter to the WebSphere Application Server profile to which you want to deploy IBM CMIS. index. Set the USER_WASADMIN_PW parameter to the administrator password for the specified application server profile. 7. f. cluster Specify cluster to deploy IBM CMIS to a cluster on WebSphere Application Server Network Deployment./config. Set the USER_DEPLOY_TYPE parameter to one of the following values: appserver Specify appserver to deploy IBM CMIS to an application server on WebSphere Application Server or to a managed node or an unmanaged node on WebSphere Application Server Network Deployment. Save your changes to the response file. start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server cluster.bat -s To validate that IBM CMIS was successfully deployed. 2) Set the USER_APPSERVER_NODE parameter to the name of the application server node that contains the application server on which to deploy IBM CMIS. h. c. If you specified USER_DEPLOY_TYPE=appserver./config. g. 1) Set the USER_APPSERVER_NAME parameter to the name of the application server on which to deploy IBM CMIS. change to the config subdirectory of the IBM CMIS installation directory and run the following command: Operating system AIX Linux Windows Command . The default profile is AppSrv01. The default display name for the application is FN_CMIS. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server. set the USER_APPSERVER_CLUSTER parameter to the name of the application server cluster on which to deploy IBM CMIS. specify values for the following properties. d. Optional: Set the USER_APP_NAME parameter to specify the name to display for the IBM CMIS application in WebSphere Application Server.C\:\\Program Files\\IBM\\WebSphere\\AppServer b.sh -s . Set the USER_WASADMIN_ID parameter to the administrator user name for the specified application server profile. e. properties file in a text editor. start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page. It is recommended that you complete the “Advanced configuration worksheet” on page 14 before you configure the advanced IBM CMIS for FileNet Content Manager properties.properties \profiles\profile1\ fncmis_advanced. you can run IBM CMIS for FileNet Content Manager by using the default values that are specified in fncmis_advanced.properties /profiles/profile1/ fncmis_advanced. bufferLength)” on page 33 “Maximum number of items to return (defaultMaxItems)” on page 34 30 Planning. “Content Engine metadata cache time to live (CMC_TIME_TO_LIVE)” on page 31 “Client server cache time to live (CRC_TIME_TO_LIVE)” on page 31 “CVL caching (CVL_Cache)” on page 32 “Filter hidden properties (filterHiddenProperties)” on page 32 “IBM CMIS URL (cmisURI)” on page 33 “Internal buffer size (com.ibm.api. However. Open the fncmis_advanced. To validate that IBM CMIS was successfully deployed. deploy your changes to WebSphere Application Server.properties file is in the following directory of the IBM CMIS installation directory: Operating system AIX Linux Windows File location /profiles/profile1/ fncmis_advanced.xlxp2.encoding. Edit the entries for the advanced parameters that you want to modify for your IBM CMIS for FileNet Content Manager system. Run the configuration tool or a silent configuration to rebuild and deploy the web application EAR file. The fncmis_advanced. 5. and Configuring IBM CMIS for FileNet Content Manager .properties 2. index. 4. Installing.xml.jsp. Save your changes. To configure the advanced properties: 1.DataSourceFactory. If you selected to manually deploy the application.util. 3.Related concepts “IBM CMIS for FileNet Content Manager index page” on page 53 Related tasks “Configuring advanced IBM CMIS for FileNet Content Manager properties” Configuring advanced IBM CMIS for FileNet Content Manager properties The advanced IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) properties are optional configuration settings that enable you to tune your system for optimal performance and scaling.properties. The default value is 3600000 milliseconds. When you decrease the TTL. you can improve the performance of IBM CMIS. you decrease the performance of IBM CMIS. However. the cache contains more up-to-date information about the content server.“Private working copy content stream (checkout_copycontent)” on page 34 “Query time limit (queryTimeLimit)” on page 34 “Secure metadata caching (SecureMetadataCache)” on page 35 Related concepts “IBM CMIS for FileNet Content Manager index page” on page 53 Related tasks “Configuring IBM CMIS by running the configuration tool” on page 25 “Configuring IBM CMIS by running a silent configuration” on page 27 “Deploying the IBM CMIS for FileNet Content Manager application manually” on page 50 Related reference “Advanced configuration worksheet” on page 14 Content Engine metadata cache time to live (CMC_TIME_TO_LIVE) The CMC_TIME_TO_LIVE property specifies how long the Content Engine metadata is kept in the Content Engine Client Metadata Cache. However. Client server cache time to live (CRC_TIME_TO_LIVE) The CRC_TIME_TO_LIVE property specifies how long object stores are kept in the client-side server cache. when you increase the frequency of cache updates. CMC_TIME_TO_LIVE Specify how long (in milliseconds) the Content Engine metadata is kept in the Content Engine Client Metadata Cache. but the cache might not contain up-to-date information about the content server. When you increase the time to live (TTL). Configuring IBM CMIS for FileNet Content Manager 31 . but the cache might not contain up-to-date information about the object stores on the content server. CRC_TIME_TO_LIVE Specify how long (in milliseconds) object stores are kept in the client-side server cache. you decrease the performance of IBM CMIS. you can improve the performance of IBM CMIS. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the CRC_TIME_TO_LIVE property. When you decrease the TTL. When you increase the time to live (TTL). The default value is 3600000 milliseconds. when you increase the frequency of cache updates. the cache contains more up-to-date information about the object stores on the content server. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the CMC_TIME_TO_LIVE property. In addition. filterHiddenProperties Specify whether IBM CMIS returns hidden properties to client applications. Installing. and Configuring IBM CMIS for FileNet Content Manager . You should modify this parameter if you have security settings configured for your CVLs and you need IBM CMIS to honor those settings. if the CVLs are cached. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the filterHiddenProperties property. Valid values include: true When you specify filterHiddenProperties=true. IBM CMIS does not cache the CVLs. IBM CMIS does not honor the security settings that are configured for CVLs in your IBM FileNet Content Manager system. 32 Planning. v false When you specify CVL_Cache=false.CVL caching (CVL_Cache) The CVL_Cache property determines whether IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) caches IBM FileNet Content Manager controlled vocabulary lists (CVLs) for all users. The default value is true. IBM CMIS does not return hidden properties to improve performance. CVL_Cache Specify whether to cache CVLs for all users. IBM CMIS honors the security settings that are configured for IBM FileNet Content Manager CLVs. However. false When you specify filterHiddenProperties=false. IBM CMIS does not return hidden properties in responses. In addition. The default value is false. By default. Default value. IBM CMIS for FileNet Content Manager caches the CVLs to improve performance. Valid values: v true When you specify CVL_Cache=true. IBM CMIS ignores the security settings that are configured for IBM FileNet Content Manager CLVs. By default. IBM CMIS returns hidden properties in responses. Related concepts “Support for IBM FileNet Content Manager CVL security” on page 6 Filter hidden properties (filterHiddenProperties) The filterHiddenProperties property determines whether IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) returns hidden properties to client applications. IBM CMIS caches the CVLs for all users. Valid values include: 0 If you specify 0 for this parameter. If IBM CMIS is deployed on the same application server as another application. IBM CMIS URL (cmisURI) The cmisURI property specifies the URL by which client applications can access IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). IBM CMIS overrides the default value that is set in WebSphere Application Server with the value that you specify. IBM CMIS does not override the default value that is set in WebSphere Application Server. com. Internal buffer size (com.Default value. cmisURL Specify the URL by which client application can access IBM CMIS. and the other application is initialized before IBM CMIS. To avoid this problem.xml. It is recommended that you do not specify a value for this parameter unless one of the following situations applies to your environment: v You want to force client applications to access IBM CMIS through a specific URL. Integers greater than 0 If you specify an integer greater than 0 for this parameter. v Your proxy server settings cause IBM CMIS to produce invalid URLs.api.xlxp2.bufferLength property specifies the size of the internal buffers that are used to create documents with content on the repository when using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) Web Services.DataSourceFactory.encoding. The URL has the form http://host_name:port.xlxp2.DataSourceFactory. It is recommended that you do not change the default value because increasing the size of the buffer can cause memory consumption issues when uploading documents larger than 50 MB through IBM CMIS Web Services. bufferLength) The com. IBM CMIS uses the default size of 2048 bytes. and you might experience memory consumption issues. WebSphere Application Server uses a 65536 byte buffer.ibm.ibm.ibm.encoding. it is recommended that you deploy IBM CMIS to a dedicated application server.util. For most IBM CMIS systems. However. If you do not specify a value for this property. IBM CMIS might not be able to override the WebSphere Application Server buffer size.xml. IBM CMIS is configured to override this setting and use a 2048 byte buffer.api. Configuring IBM CMIS for FileNet Content Manager 33 .DataSourceFactory.util.util. you do not need to configure the cmisURL parameter.encoding. The default value is 2048 bytes.api.bufferLength Specifies the size of the internal buffers that are used to create documents with content on the repository when using IBM CMIS Web Services.xml.xlxp2. Query time limit (queryTimeLimit) The queryTimeLimit property specifies the maximum length of time (in seconds) to run a query on the repository. The default value is 180 seconds. Private working copy content stream (checkout_copycontent) The checkout_copycontent property determines whether the content stream of a checked out document is copied to the content stream of the private working copy. defaultMaxItems Specify the maximum number of items to return when an HTTP request does not specify a value for the maxItems parameter. Valid values include: 34 Planning. false When you specify checkout_copycontent=false. IBM CMIS copies the content stream of a checked out document to the content stream of the private working copy. Default value. control is returned to IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). Valid values include: true When you specify checkout_copycontent=true. Installing. IBM CMIS does not copy the content stream of a checked out document to the content stream of the private working copy. The default value is 25 items. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the defaultMaxItems property. checkout_copycontent Specify whether to copy the content stream of a checked out document to the content stream of the private working copy.Maximum number of items to return (defaultMaxItems) The defaultMaxItems property determines the maximum number of items to return when an HTTP request does not specify a value for the maxItems parameter. You can use IBM CMIS without modifying the default value of the queryTimeLimit property. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the checkout_copycontent property. If the query is not complete after the time limit elapses. The default value is true. and Configuring IBM CMIS for FileNet Content Manager . queryTimeLimit Specify the maximum length of time (in seconds) to run a query on the repository (IBM FileNet P8 object store). IBM CMIS ignores the ACL settings for the Creator and DateCreated properties. If Content Engine and IBM CMIS for FileNet Content Manager are running on different instances of WebSphere Application Server. false Cache the class definition metadata. Additionally. To configure SSO.0 If you specify queryTimeLimit=0 for this parameter. Integers greater than 0 If you specify an integer greater than 0 for this parameter. each instance of WebSphere Application Server must use the same directory service for authentication. IBM CMIS caches the class definition metadata to improve performance. Valid values include: true Do not cache the class definition metadata. However. you do not need to configure LTPA. you must complete the following tasks. The default value is false. When you specify SecureMetaCache=false. Default value. When you specify SecureMetaCache=true. Secure metadata caching (SecureMetadataCache) The SecureMetadataCache property determines whether IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) caches class definition metadata for all users. you must configure LTPA and enable application security for each instance of WebSphere Application Server. IBM CMIS overrides the default query time limit that is configured for the repository. Configuring single sign-on You must enable single sign-on (SSO) between the application servers that host IBM FileNet Content Engine and IBM Content Management Interoperability Services for FileNet Content Manager If Content Engine and IBM CMIS for FileNet Content Manager are running on the same instance of WebSphere Application Server. IBM CMIS honors the ACL settings for the Creator and DateCreated properties. Configuring IBM CMIS for FileNet Content Manager 35 . By default. IBM CMIS uses the default query time limit that is configured for the repository. IBM CMIS displays the following properties to all users regardless of their access control list (ACL) permissions: v Creator v DateCreated SecureMetadataCache Specify whether to secure class metadata or cache class metadata for all users. if the class definition metadata is cached. Ask your Content Engine administrator whether you are already using LTPA with your Content Engine application server. Installing. To configure LTPA for IBM CMIS for FileNet Content Manager. you must: 1. You must. Export the LTPA key from the Content Engine application server 2. If you are already using LTPA with the Content Engine application server. “Generating the LTPA key from the Content Engine application server” 2. Generate an LTPA key from the Content Engine application server 2. Import the LTPA key to the IBM CMIS for FileNet Content Manager application server Remember: If you generate a new LTPA key. Import the LTPA key to the IBM CMIS application server If you are already using LTPA with the Content Engine application server. If Content Engine and IBM CMIS for FileNet Content Manager are running on the same instance of WebSphere Application Server. it is recommended that you do not generate a new LTPA key from Content Engine application server. Log in to the WebSphere Application Server administrative console on which Content Engine is installed. you must import the new LTPA key to the Content Engine client applications that use the old LTPA key. Open the LTPA settings page: 36 Planning. you do not have to configure LTPA. 1. it is recommended that you do not generate a new LTPA key from Content Engine application server. 2. you must generate an LTPA key from the Content Engine application server. “Exporting the LTPA key from the Content Engine application server” on page 37 3. you must complete the following tasks. If you are not currently using LTPA with the Content Engine application server. and Configuring IBM CMIS for FileNet Content Manager .“Configuring Lightweight Third Party Authentication (LTPA)” “Configuring Lightweight Directory Access Protocol (LDAP)” on page 38 Configuring Lightweight Third Party Authentication (LTPA) The LTPA security settings on the IBM FileNet Content Engine application server and the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application server must match. 1. “Importing the LTPA key to the IBM CMIS for FileNet Content Manager application server” on page 37 Generating the LTPA key from the Content Engine application server If you are not currently using LTPA with the IBM FileNet Content Engine application server. To generate the LTPA key from the Content Engine application server: 1. Export the LTPA key from the Content Engine application server 3. For example. b. Select LTPA. Enter a value for the LTPA timeout that is larger than the default. Enter the fully qualified path for the Key File Name. Importing the LTPA key to the IBM CMIS for FileNet Content Manager application server You must import the LTPA key to the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application server to enable IBM CMIS to authenticate to the IBM FileNet Content Engine application server. a. 2. For example: /opt/LTPA/ltpa_key_name 2. and then click Save changes to the Master Configuration. Save your changes. Verify that a message like the following message is displayed: The keys were successfully exported to the file ltpa_key_name. Click Security → Global security. For example. 3. 3. Stop and restart WebSphere Application Server. Enter a value for the LTPA timeout that is larger than the default. the LTPA key expires after 2 hours. 4. In the Cross-cell single sign-on field. see the WebSphere Application Server documentation. Open the LTPA settings page: a. if the timeout value is left at the default value of 120 minutes. b. Click Security → Global security. /opt/LTPA/ltpa_key_name. 4. 6. Click Generate Keys. 7. 6. Save your changes. Users will not be able to log in to IBM CMIS after being logged in for 2 hours. Exporting the LTPA key from the Content Engine application server You must export the LTPA key from the Content Engine application server before you can import the key file to the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application server. Select LTPA. Configuring IBM CMIS for FileNet Content Manager 37 . Copy the key file from the Content Engine server to a directory on the IBM CMIS server. On the IBM CMIS server. To export the LTPA key from the Content Engine application server: 1. Click Export keys. Click Save. Select LTPA.3. Log in to the WebSphere Application Server administrative console on which Content Engine is installed. Open the LTPA settings page: a. log in to the WebSphere Application Server administrative console. To import the LTPA key to the IBM CMIS application server: 1. 5. 5. Click Security → Global security. For example. Users will not be able to log in to IBM CMIS after being logged in for 2 hours. For password restrictions. the LTPA key expires after 2 hours. type the LTPA password. 4. b. if the timeout value is left at the default value of 120 minutes. Enter a password to create the LTPA password. 5. 6. In the Cross-cell single sign-on field, type the LTPA password. 7. In the Key File Name field, specify the fully qualified path for the key file that you imported. For example, /opt/LTPA/ltpa_key_name. 8. Click Import keys. Verify that a message like the following message is displayed: The keys were successfully imported to the file ltpa_key_name. 9. Click Save, and then click Save changes to the Master Configuration. 10. Stop and restart WebSphere Application Server. Configuring Lightweight Directory Access Protocol (LDAP) The WebSphere Application Server that hosts IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) must use the same LDAP server as the WebSphere Application Server that hosts Content Engine. To enable LDAP communication between IBM CMIS for FileNet Content Manager and Content Engine, you must configure the LDAP settings in WebSphere Application Server. IBM CMIS supports stand-alone LDAP and LDAP for federated repositories. The steps in this task assume that you use stand-alone LDAP. To configure stand-alone LDAP: 1. On the IBM CMIS server, log in to the WebSphere Application Server administrative console. 2. Click Security → Global security. 3. Disable the following Security settings: v Clear the Enable Administrative Security flag. v Clear the Enable application security flag. v Clear the Java 2 security flag. 4. From the Available realm definitions list, select Standalone LDAP registry and click Configure. 5. Configure the LDAP provider settings to exactly match the corresponding settings on the Content Engine application server. Tip: Open the WebSphere Application Server administrative console for the Content Engine server to ensure that the following settings match on both application servers. v Primary administrative user name v Automatically generated server identity v Type of LDAP server v Host v Port v Base distinguished name (DN) v Bind distinguished name (DN) v Bind password 6. Click Apply. 7. Under Additional Properties, click Advanced Lightweight Directory Access Protocol (LDAP) user registry settings. Configure the LDAP user registry settings to exactly match the corresponding settings on the Content Engine application server. 38 Planning, Installing, and Configuring IBM CMIS for FileNet Content Manager Tip: Open the WebSphere Application Server administrative console for the Content Engine server to ensure that the following settings match on both application servers. v User filter v Group Filter v User ID map v Group member ID map v Certificate map mode v Certificate filter 8. Click OK 9. Save your changes. 10. From the Available realm definitions list, ensure that Standalone LDAP registry is selected and click Set as current. 11. Set the following Security flags: v Select the Enable Administrative Security flag. v Select the Enable application security flag. v Clear the Java 2 security flag. Important: The IBM FileNet P8 Platform uses LDAP-based security and does not support Java 2 security. Enabling Java 2 security causes unexpected behavior. 12. Click Save, and then click Save changes to the Master Configuration. 13. Stop and restart WebSphere Application Server. 14. On the Standalone LDAP registry page, test the connection to the LDAP server. If the test fails, correct the error before proceeding. If the connection succeeds, click OK to return to the previous page. Configuring logging IBM Content Management Interoperability Services for FileNet Content Manager uses the standard Apache Commons Logging API, which can be configured at run time through the WebSphere Application Server administrative console. To configure logging for IBM CMIS: 1. Log in to the WebSphere Application Server administrative console and expand Troubleshooting. 2. Click Logs and trace, and then click the name of the server where IBM CMIS is installed. 3. In the Logging and Tracing panel, click Change Log Detail Levels. 4. Select the appropriate tab: Configuration By default, the Configuration tab is active. Any changes that you make on the Configuration tab are saved to the WebSphere Application Server configuration files, but your changes are not activated until you restart the server. Runtime This option is recommended. Any changes that you make to the logging level on the Runtime tab are activated immediately. Configuring IBM CMIS for FileNet Content Manager 39 Tip: If the Runtime tab is active and you want to make your changes permanent, select Save runtime changes to configuration as well. 5. Enter a log detail level that specifies the components or groups to trace. You can enter the log detail level string directly or generate the log detail level string by using the graphical trace interface. 6. Click Apply “Specifying log level entries” “Configuring log location and size” on page 41 “Logged errors” on page 42 “Configuring Content Engine API client logging” on page 42 Specifying log level entries On the Logging and Tracing panel of the WebSphere Application Server administrative console, you can manually specify the logging level of any number of classes or packages. However, you must use the correct syntax when you specify the logging level manually. Each entry must have the form package_name.*=logging_level or class_name=logging_level. Entries are separated with a colon (:). Tip: It is recommended that you add .* after the names of packages to configure logging for all of the subpackages of the specified packages. The minimum recommended log level for a production environment is "info", which includes errors and important informational messages. However, you might need to configure the "finest" log level, which includes entry/exit logging, for temporary troubleshooting. The "fine" log level is used for debug-level logging. Log levels "fine" and below are not recommended for anything other than temporary troubleshooting in a production environment because they are verbose and affect performance. The IBM Content Management Interoperability Services for FileNet Content Manager application can be divided into the following categories for logging: IBM CMIS application logging The package name for the IBM CMIS application is com.ibm.ecm. IBM CMIS component logging The package name for the IBM CMIS components is com.ibm.ecm.cmis. Common component logging The package name for the common application components is com.ibm.ecm.integration. Performance logging The class name for the performance component is com.ibm.ecm.cmis.perf. The following examples show how you can configure common logging levels for IBM CMIS: v To specify info-level logging for the IBM CMIS application, which includes errors, warning, and important informational messages, enter: com.ibm.ecm.*=info v To specify fine-level logging for IBM CMIS components, which includes information that can be used to debug general problems, enter: com.ibm.ecm.cmis.*=fine 40 Planning, Installing, and Configuring IBM CMIS for FileNet Content Manager Tip: If the Runtime tab is active and you want to make your changes permanent. and then click the name of the server where IBM CMIS is installed. 4. enter: com. enter: com. the SystemOut.cmis.cmis.ecm. These settings apply to all applications that use Apache Commons Logging standard. Runtime This option is recommended. you can enable or disable trace logging.*=finest v To specify finest-level logging for performance. 3. Configuring IBM CMIS for FileNet Content Manager 41 . Specify the logging output for your configuration on the appropriate tab for your environment: Configuration By default. click JVM logs in the Logging and Tracing panel. the log files would be in the /opt/IBM/WebSphere/AppServer/profiles/AppSrv01/logs/ server1/ directory. Any changes that you make on the Runtime tab are activated immediately. For example. and modify the log entry format.perf=finest Related information WebSphere log levels Configuring log location and size From the WebSphere Application Server administrative console. select Save runtime changes to configuration as well.log files are located in the WAS_profile_location/logs/server subdirectory of the WebSphere Application Server installation directory.ibm. Log in to the WebSphere Application Server administrative console and expand Troubleshooting. By default. be sure to account for the log level that is configured and the load that the configuration will place on your system.ecm. you can specify the maximum file size and maximum number of historical files.v To specify finest-level logging for the IBM CMIS components. but your changes are not activated until you restart the server. which logs detailed trace information and all the detail that is required to debug performance problems. Click Logs and trace. change the log file location. size and retention. 2. the Configuration tab is active. Click Apply. Any changes that you make on the Configuration tab are saved to the WebSphere Application Server configuration files. which logs detailed trace information and method entry and exit information. on a standard AIX installation.ibm.log and the trace.log. To ensure that log data is retained properly. However. It is not usually necessary to change these settings when troubleshooting IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). To configure logging for IBM CMIS: 1. To configure SystemOut. 6. Any changes that you make on the Runtime tab are activated immediately. The following code is an example of the message format: INVALID_OBJECT_ID_1=CIL1148: The service cannot be completed because the following object ID or path is not valid: {object ID or object path} INVALID_OBJECT_ID_1_E=The object ID or path might contain invalid characters or use invalid syntax. Specify the trace output for your configuration on the appropriate tab for your environment: Configuration By default. see the OASIS CMIS API specification. Action: For information about implementing the argument.DALP8ExceptionHandler handleException null com. select Save runtime changes to configuration as well. Logged errors If you configured logging for IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). Runtime This option is recommended.app.log. or the Web Services binding document.p8. The OASIS CMIS API specification requires applications to throw exceptions when certain errors occur. and Configuring IBM CMIS for FileNet Content Manager .cmis. Configuring Content Engine API client logging IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) bundles and performs most content operations through the IBM FileNet Content Engine Java API. Click Apply. Any changes that you make on the Configuration tab are saved to the WebSphere Application Server configuration files. Stack trace.5.ecm.cmis.InvalidArgumentException: CIL1145: The service cannot be completed because the value that was specified for the following input parameter is not valid. server-side stack trace information is logged but not returned. Installing.ibm. but your changes are not activated until you restart the server.ecm. The following code is an example of the information that is written to the log file when an exception occurs: MM/DD/YY HH:MM:SS] 00000017 DALP8Exceptio E com. the Configuration tab is active. If you use REST services. or the RESTful AtomPub binding service document. server-side stack trace information is logged and returned.ibm. To configure trace. Input parameter: repositoryId Value: bad-dog Explanation: No additional explanation is required. all errors are logged in WebSphere Application Server and returned in a response.. If you use Web Services. You might need to configure Content Engine API client logging when you need to troubleshoot performance problems related to Content Engine. 42 Planning.exceptions. click Diagnostic Trace in the Logging and Tracing panel. Tip: If the Runtime tab is active and you want to make your changes permanent. The client application sees only the client-side stack trace information.. INVALID_OBJECT_ID_1_A=Ensure that a valid object ID or path is retrieved from HTTP responses.dal. FileNetNull Appender ############################################################# # Appenders ############################################################# # === FileNetNullAppender log4j. To configure Content Engine API client logging for IBM CMIS: 1.properties file.ConversionPattern= %d %5p [%t] . the server logs might show stack traces for Content Engine-related errors that occur under normal operation.%m\r\n #=== FileNetErrorAppender log4j.PatternLayout log4j.appender.FileNetNullAppender=org.apache.FileNetErrorAppender.FileAppender log4j.appender.appender.ConversionPattern= %d %5p [%t] .war/WEB-INF/classes /opt/IBM/WebSphere/AppServer/ profile_name/installedApps/cell_name/ fncmis.ear\ fncmis.FileNetConsoleAppender=org.FileNetErrorAppender=org. Restart the IBM CMIS application in the WebSphere Application Server administrative console to distribute the changes to the deployed application. By default.log4j.FileNetErrorAppender.varia.properties file.log # This is the layout that the TraceLoggingConfiguration Configuring IBM CMIS for FileNet Content Manager 43 . ############################################################# # Root logger ############################################################# log4j.File=logs/server1/fncmis_api_trace.appender.FileNetErrorAppender.NullAppender # === FileNetConsoleAppender log4j.FileNetTraceAppender=org.appender.apache.apache.FileAppender log4j.apache.log4j.appender.layout=org.PatternLayout log4j. Create a log4j.appender.war/WEB-INF/classes C:\Program Files\IBM\WebSphere\ AppServer\profiles\profile_name\ installedApps\cell_name\fncmis. Therefore. the Content Engine API client logs are created in the directory that was specified in the log4j.FileNetConsoleAppender.layout=org.log4j. After you deploy the application.ear/fncmis. that uses the Apache Log4J standard library.ear/fncmis.rootLogger=off.FileNetTraceAppender.File=logs/server1/fncmis_api_error.properties file. 2.log4j.layout. Insert the log4j.layout.appender.log log4j. The following code is a sample log4j.The API layer has its own logging structure.FileNetConsoleAppender.%m\r\n #=== FileNetTraceAppender log4j.apache.log4j.war\WEB-INF\classes Linux Windows 3.apache.log4j.appender. the classes directory is located in the following WebSphere Application Server directory: Operating system AIX Default Directory /usr/IBM/WebSphere/AppServer/ profile_name/installedApps/cell_name/ fncmis. no matter what the application log settings are.ConsoleAppender log4j.appender.properties file into the classes directory of the deployed application. filenet_error.FileNetTraceRollingAppender.log log4j.FileNetTraceRollingAppender. log4j. # By default.layout=com.layout.FileNetErrorRollingAppender.layout.ConversionPattern= %d %5p [%t] . it inherents its value from its parent.MaxBackupIndex=1 # This is the layout that the TraceLoggingConfiguration framework on the server uses. #log4j. it inherents its value from its parent.log4j.apache..api = warn ############################################################ # Trace loggers: # # Setting log level to "off" will turn off trace logging.appender.PatternLayout log4j. #log4j.FileNetTraceRollingAppender.MaxBackupIndex=1 log4j.FileNetErrorRollingAppender=org.FileNetTraceAppender.Enables the most detailed level of tracing # # Uncomment corresponding lines to turn tracing on. FileNetConsoleAppender.apache.FileNetErrorRollingAppender.layout=org. set the level of the filenet_tracing # logger to debug.. FileNetErrorRollingAppender.appender. # If a logger is not specified.appender.FileNetTraceRollingAppender.summary -.appender.filenet. # Setting log level to "debug" will turn on trace logging.moderate.FileNetErrorRollingAppender.layout=org. # If a logger is not specified. # To use this layout .File=logs/server1/fncmis_api_trace.FileNetTraceRollingAppender=org.FileNetTraceRollingAppender.appender.appender.appender. To enable trace logging # for all subsystems and all flags. # Child logger’s value overwrites parent logger’s value.appender. jace.logger.util.appender.detail -.apiimpl. Installing.appender. 44 Planning.apache.%m\r\n #=== FileNetErrorRollingAppender log4j. error logging is set to level ERROR.PatternLayout log4j.layout.util.ConversionPattern= %d %5p [%t] .MaxFileSize=100MB log4j.PatternLayout log4j.File=logs/server1/fncmis_api_error.log log4j.RollingFileAppender log4j. # # The general message trace logging has a hierarchy # of three detail levels represented with # hierarchical logger names: # .MaxFileSize=100MB log4j.apache. # To use this layout.appender.apache. ############################################################# # Don’t comment out the following line since it has appenders.FileNetTraceRollingAppender.moderate -.layout=org.jar must be present in the classpath.TraceLayout # Comment out the following lines if using the FileNet TraceLayout log4j..log4j.FileNetErrorRollingAppender.appender.appender.filenet.%m\r\n #=== FileNetTraceRollingAppender log4j.appender.TraceLayout # Comment out the following lines if using the FileNet TraceLayout log4j.RollingFileAppender log4j.ConversionPattern= %d %5p [%t] .layout=com.log4j. # By default. # # Child logger’s value overwrites parent logger’s value.logger.Enables a summary level of tracing # .framework on the server uses.FileNetErrorRollingAppender.. #log4j.log4j.jar must be present in the classpath.apiimpl.log4j.Enables a moderate level of tracing # .appender.appender. and Configuring IBM CMIS for FileNet Content Manager ..detail. trace logging is off.FileNetTraceAppender..filenet_error = error.detail. FileNetTraceRollingAppender #=== SubSystem: api # Uncomment to set error logging level to WARN.%m\r\n ############################################################# # Error Loggers: # # Set log level to either one of off/fatal/error/warn/info.FileNetTraceAppender. jace. # For message tracing.api.<SubSystem>.timer = debug # Remove the comment corresponding to the desired detail level log4j.moderate = debug # log4j. log4j.filenet_tracing = off.filenet_tracing.# # Here are the trace flags used for each sub system.filenet_tracing.logger.detail.logger.moderate = debug #log4j.api.filenet_tracing.detail. log4j.logger.filenet_tracing. enable the line # corresponding to the desired detail level.filenet_tracing.detail = debug Configuring IBM CMIS for FileNet Content Manager 45 .summary = debug # log4j.moderate.logger.detail.detail.<SubSystem>.summary = debug #log4j.moderate = debug ############################################################# # Don’t comment out the following line since it includes an appender.filenet_tracing. # log4j.api.<SubSystem>.logger.filenet_tracing.api.logger.timer = debug # log4j. FileNetTraceRollingAppender #=== SubSystem: api # Uncomment one or more lines to enable tracing.filenet_tracing.logger.logger.api = debug log4j.api.logger.logger.<SubSystem>.logger.detail.filenet_tracing.detail = debug # # For example: # log4j.moderate.filenet_tracing. 46 Planning. Installing. and Configuring IBM CMIS for FileNet Content Manager . sh. the configuration tool remembers your configuration and deployment information across sessions.Deploying IBM CMIS for FileNet Content Manager You can deploy the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application manually or by using the configuration tool./config. change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: . change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: . The configuration tool enables you to deploy IBM CMIS as soon as you modify the application. you can manually deploy the application after you use the configuration tool or run a silent configuration to build the EAR file.bat. you can use the configuration tool to deploy IBM CMIS to WebSphere Application Server. © Copyright IBM Corp. “Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool” “Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration” on page 48 “Deploying the IBM CMIS for FileNet Content Manager application manually” on page 50 Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool When you configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). 47 . Alternatively. 2010. At a command prompt. To deploy IBM CMIS./config. To deploy the IBM CMIS application: 1. change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: config. In addition. Start the configuration tool: Operating system AIX Installation command At a command prompt. At a command prompt. Specify the instance of WebSphere Application Server to which to deploy IBM CMIS. Configure the IBM CMIS application for your environment and select Automatically deploy IBM CMIS. Linux Windows 2. complete one of the following tasks.sh. 3. Instead. Specify the cluster or application server to which to deploy IBM CMIS. A silent configuration uses a response file that contains the configuration and deployment parameters that you specify. Specify the administrator user name and password for the selected application server profile. If prompted.Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. index.properties config\fncmisWIN_SilentConfig. 4. specify the WebSphere Application Server installation directory. If the application server profile contains application servers and application server clusters. you can enter information about your WebSphere Application Server deployment environment in the silent configuration response file. and Configuring IBM CMIS for FileNet Content Manager . the configuration tool uses the installation directory that you specified in the Content Engine Connection Information window. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server or application server cluster. Related concepts “IBM CMIS for FileNet Content Manager index page” on page 53 Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration When you configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). To validate that IBM CMIS was successfully deployed. Open the response file: Operating system AIX Linux Windows Response file config/fncmisUNIX_SilentConfig. d. When you run a silent configuration.jsp. c. specify the type of server to which you plan to deploy IBM CMIS. a. e.properties 48 Planning. f. the configuration program does not display any configuration windows or messages.log file in the log directory. If you tested the connection to the Content Engine server. start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page. Specify the application server profile to which to deploy IBM CMIS. Optional: Specify the name to display for the IBM CMIS application in WebSphere Application Server.properties config/fncmisUNIX_SilentConfig. To deploy the IBM CMIS for FileNet Content Manager application: 1. any messages and errors are written to the fncmis-config. Installing. b. The default display name for the application is FN_CMIS. Verify your WebSphere Application Server deployment information and click Next. 3. you must escape colons (:) and backslashes (\) by adding a backslash before each colon or backslash in the installation directory file path. If you specified USER_DEPLOY_TYPE=appserver. If you specified USER_DEPLOY_TYPE=cluster. For example. Set the USER_WASADMIN_ID parameter to the administrator user name for the specified application server profile. specify values for the following properties. 5. Deploying IBM CMIS for FileNet Content Manager 49 . Set the USER_APPSERVER_HOME parameter to the instance of WebSphere Application Server to which you want to deploy IBM CMIS. a. Remember: If you set the USER_MANUAL_DEPLOY parameter to 1. Important: On Windows. you must manually deploy IBM CMIS. f. set the USER_APPSERVER_CLUSTER parameter to the name of the application server cluster on which to deploy IBM CMIS. g. Set the USER_APPSERVER_PROFILE_NAME parameter to the WebSphere Application Server profile to which you want to deploy IBM CMIS. Specify the information about the WebSphere Application Server environment to which you want to deploy IBM CMIS. e. cluster Specify cluster to deploy IBM CMIS to a cluster on WebSphere Application Server Network Deployment. Ensure that the parameters in the Content Engine Connection Information section are specified correctly for your environment. Set the USER_WASADMIN_PW parameter to the administrator password for the specified application server profile. Set the USER_DEPLOY_TYPE parameter to one of the following values: appserver Specify appserver to deploy IBM CMIS to an application server on WebSphere Application Server or to a managed node or an unmanaged node on WebSphere Application Server Network Deployment. 4. Ensure that the USER_WS_AUTH parameter is specified correctly for your environment. The default profile is AppSrv01. Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. C:\Program Files\IBM\WebSphere\ AppServer would have the following format: C\:\\Program Files\\IBM\\WebSphere\\AppServer b. d. 1) Set the USER_APPSERVER_NAME parameter to the name of the application server on which to deploy IBM CMIS.2. c. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server. 2) Set the USER_APPSERVER_NODE parameter to the name of the application server node that contains the application server on which to deploy IBM CMIS. Set the USER_MANUAL_DEPLOY parameter to 0. “Modifying the generic JVM arguments in WebSphere Application Server” 2. The default display name for the application is FN_CMIS. Log in to the WebSphere Application Server administrative console. 6. complete the following tasks. 1. Save your changes to the response file. start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page. To modify the generic JVM arguments on the server: 1. h. To manually deploy IBM CMIS. Optional: Set the USER_APP_NAME parameter to specify the name to display for the IBM CMIS application in WebSphere Application Server. “Manually deploying IBM CMIS for FileNet Content Manager” on page 51 Related tasks “Configuring advanced IBM CMIS for FileNet Content Manager properties” on page 30 Modifying the generic JVM arguments in WebSphere Application Server Before you manually deploy IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS)./config. Installing. 7./config. If you use the configuration program to deploy IBM CMIS. you can manually deploy IBM CMIS to WebSphere Application Server. 3.bat -s To validate that IBM CMIS was successfully deployed. such as server1.Remember: It is recommended that you deploy IBM CMIS to a dedicated application server cluster. Related concepts “IBM CMIS for FileNet Content Manager index page” on page 53 Deploying the IBM CMIS for FileNet Content Manager application manually After you configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). Click the name of the server where you want to deploy IBM CMIS. 2. index. 50 Planning.sh -s . “Importing the WS-Security policy set to WebSphere Application Server” on page 51 3. you do not need to complete this task. change to the config subdirectory of the IBM CMIS installation directory and run the following command: Operating system AIX Linux Windows Command . and Configuring IBM CMIS for FileNet Content Manager .sh -s config. At a command prompt.jsp. Click Servers → Server Types → WebSphere application servers. you must modify the generic JVM arguments for the server to which you want to deploy IBM CMIS. you can manually deploy IBM CMIS to WebSphere Application Server. To import the WS-Security policy set to WebSphere Application Server: 1. If you use the configuration program to deploy IBM CMIS.zip /usr/IBM/FN_CMIS/config/scripts/ policysets/cmis_auth_policyset. click Java and Process Management → Process definition. Deploying IBM CMIS for FileNet Content Manager 51 .4.zip file from the config/scripts/policysets subdirectory of the IBM CMIS installation directory: Default directory /opt/IBM/FN_CMIS/config/scripts/ policysets/cmis_auth_policyset. 2. 3. you must import the WS-Security policy set to WebSphere Application Server. You must modify the generic JVM arguments for the server on which IBM CMIS will be deployed. Importing the WS-Security policy set to WebSphere Application Server If you configured IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) to use WS-Security. you must import the WS-Security policy set to WebSphere Application Server before you manually deploy IBM CMIS.ear. 5. Click Services → Policy sets → Application policy sets. 6.highFidelity=true. you do not need to complete this task. Manually deploying IBM CMIS for FileNet Content Manager After you configure your WebSphere Application Server environment for IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). fncmis. is created when you select Manually deploy IBM CMIS in the configuration tool or the silent configuration response file. In the Generic JVM arguments field. append -Djaxws.zip C:\Program Files\IBM\FN_CMIS\config\ scripts\policysets\ cmis_auth_policyset. Select Import → From Selected Location. click Java Virtual Machine. 5. 4. In addition. Under Additional Properties. Click OK and save your changes to the master configuration. Under Server Infrastructure. Select the cmis_auth_policyset. The IBM CMIS application EAR file. if you configured IBM CMIS to use WS-Security. Click OK and save your changes to the master configuration.payload. Log in to the WebSphere Application Server administrative console. 7.zip Operating system AIX Linux Windows Important: Do not change the name of the policy set. After the application is deployed. To validate that IBM CMIS was successfully deployed.ear file Operating system AIX Linux Windows Default directory /opt/IBM/FN_CMIS/profiles/profile1/ fncmis. 6. In the Path to the new application window. start the application. 8. select Local file system. 3. 9. Default location of the fncmis. Installing. select Fast Path and click Next.ear file from the profiles/profile1 subdirectory of the IBM CMIS installation directory and click Next.ear C:\Program Files\IBM\FN_CMIS\profiles\ profile1\fncmis. Table 14. Save your changes to the master configuration. 4. 5. 2.The IBM CMIS fncmis. manually deploy IBM CMIS to WebSphere Application Server: Log in to the WebSphere Application Server administrative console. Select the fncmis. In the Summary window. Click Applications → New Application → New Enterprise Application. 7.jsp. click Finish. In the How do you want to install the application window. Related concepts “IBM CMIS for FileNet Content Manager index page” on page 53 52 Planning.ear /usr/IBM/FN_CMIS/profiles/profile1/ fncmis.ear To 1.ear file is created in the profiles/profile1 subdirectory of the IBM CMIS installation directory. start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page. Accept the default values for the remaining parameters. index. and Configuring IBM CMIS for FileNet Content Manager . jsp. “IBM CMIS for FileNet Content Manager service collection URLs” on page 54 “IBM CMIS for FileNet Content Manager URI templates” on page 54 © Copyright IBM Corp. 2010. When IBM CMIS is properly configured and deployed. You can use the information about the index page to: v Interact directly with the OASIS CMIS Web Services binding or RESTful AtomPub binding v Develop against a client API The index page also includes links to the Web Services binding information and the RESTful Atom Protocol (AtomPub) binding information in the OASIS CMIS specification. you can access the index page at http://host_name:port/context_root/index.IBM CMIS for FileNet Content Manager Development Content Management Interoperability Services (CMIS) is an open source OASIS standard that enables applications to work with one or more content management systems by defining a standard domain model and standard set of services and protocol bindings for Web Services and RESTful AtomPub. the context root of IBM CMIS for FileNet Content Manager is fncmis. The CMIS Web Services bindings and RESTful AtomPub bindings are described in the OASIS CMIS specification. By default. Specifically. “IBM CMIS for FileNet Content Manager index page” “OASIS CMIS specification” on page 55 “Useful resources” on page 55 “Extensions for IBM CMIS for FileNet Content Manager” on page 56 “IBM CMIS for FileNet Content Manager implementation of the OASIS CMIS specification” on page 59 “Best practices for developing client applications” on page 63 IBM CMIS for FileNet Content Manager index page The IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) index page contains information about the instance of IBM CMIS that is deployed to your web application server. 53 . the index page includes links to the service documents and information about the URI templates and service collections that are defined for the repositories (IBM FileNet P8 object stores) on your Content Engine server. Types children collection This URL provides a feed of the base object types.jsp. such as a specific folder or document. Query collection This URL provides a feed of the objects that satisfy a predefined query. see section 3. For a list of the service collection URLs for your IBM CMIS for FileNet Content Manager application. The OASIS CMIS specification defines several service collection URLs. Unfiled collection This URL provides a feed of the documents that are not filed in a folder in the repository.7 Service Collections of the OASIS CMIS specification. see the index page at http://host_name:port/context_root/ index. from the repository. the context root of IBM CMIS for FileNet Content Manager is fncmis. Checked out collection This URL provides a feed of the documents that are in the checked-out state in the repository. IBM CMIS for FileNet Content Manager URI templates URI templates enable users to insert values in a standardized URI to retrieve specific data.Related tasks “Configuring IBM CMIS by running the configuration tool” on page 25 “Configuring IBM CMIS by running a silent configuration” on page 27 “Configuring advanced IBM CMIS for FileNet Content Manager properties” on page 30 “Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool” on page 47 “Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration” on page 48 “Manually deploying IBM CMIS for FileNet Content Manager” on page 51 Related information Context root for Web modules settings (WebSphere Application Server Network Deployment) Context root for Web modules settings (WebSphere Application Server) IBM CMIS for FileNet Content Manager service collection URLs Service collection URLs provide feeds that enable users to browse and navigate the items in the repository. specifically cmis:document and cmis:folder. For more information. and Configuring IBM CMIS for FileNet Content Manager . The OASIS CMIS specification defines several URI templates. By default. Installing. 54 Planning. The OASIS specification defines the following service collection URLs: Root folder collection This URL provides a feed that displays all of the folders and documents that are in the root folder. Useful resources Useful resources that help you get started with OASIS Content Management Interoperability Services (CMIS) and CMIS client applications are available online. The OASIS CMIS Technical Committee maintains a website that includes information about various implementations of CMIS at http://www.oasis-open. By default. However.org/committees/tc_home. Query (query) template This URI template enables users to create a URI to search for data in the repository by specifying a CMIS Query Statement. at http://www.ibm. see the index page at http://host_name:port/context_root/index. which includes links to developerWorks® topics and other useful resources. The server returns the class description information in the CMIS format for a type.The OASIS specification defines the following URI templates: Object by ID (objectbyid) template This URI template enables users to create a URI that can directly access a document or folder by specifying the ID of the object.0/os/cmis-spec-v1.org/cmis/CMIS/v1.oasisopen. Important: The IBM Content Management Interoperability Services for FileNet Content Manager documentation does not include specific guidance for developing with the OASIS CMIS APIs. For a list of the URI templates for your IBM CMIS for FileNet Content Manager application. which includes all the property descriptions that are defined for the specified type. IBM CMIS for FileNet Content Manager Development 55 . see section 3. The OASIS CMIS API specification is available in HTML format at http://docs. some of the resources in “Useful resources” provide additional guidance.0.php?wg_abbrev=cmis. Type by ID (typebyid) template This URI template enables users to create a URI to retrieve metadata about a type (IBM FileNet P8 class).html.6. IBM maintains a page for Content Management Interoperability Services (CMIS) Information Management software. The server returns a feed of objects that correspond to the query that is supplied.html. Object by path (objectbypath) template This URI template enables users to create a URI that can directly access a document or folder by specifying the path of the object. OASIS CMIS specification The OASIS Content Management Interoperability Services (CMIS) specification includes detailed information about the CMIS Web Services bindings and the RESTful AtomPub bindings. For more information. the context root of IBM CMIS for FileNet Content Manager is fncmis.com/software/data/contentmanagement/cm-interoperablity-services.jsp.1 URI Templates of the OASIS CMIS specification. nsf/dx/ 11122008094143amwebk95. v If your client application is designed to require values for these extensions. and Configuring IBM CMIS for FileNet Content Manager .htm. IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) includes several extensions that enable client applications to retrieve additional information from an IBM FileNet Content Manager system.The Lotus® Quickr® wiki also includes a compilation of resources at http://www. Remember: If you design your client application to use this IBM CMIS extension. your client application will not work with another CMIS-enabled repository. The extensions are optional and do not interfere with client applications that are not designed to use the extensions. The IBM CMIS extensions are extensions to the XML output from the server and are present on each response from the Content Engine server. Extensions for IBM CMIS for FileNet Content Manager The OASIS Content Management Interoperability Services (CMIS) specification enables developers to extend the RESTful AtomPub bindings and Web Services bindings that are provided by the specification. Important: If you design your client application to use the IBM CMIS extensions.ibm. it is recommended that you design the application to use the values that are provided by the extensions only if values are available. if you design your client application to use the IBM CMIS extensions. If this information is not provided.com/software/lotus/info/r/ldd/lqwiki. Installing. IBM CMIS for FileNet Content Manager includes the following extensions: “Class display name extension” “Hidden properties extension” on page 57 “Choice list symbolic name extension” on page 57 “Choice list display name extension” on page 57 “Domain name extension” on page 57 “Object store ID extension” on page 58 “Object store database type extension” on page 58 “Records management extension” on page 58 “Text search engine extension” on page 58 “GZIP compression extension” on page 59 Class display name extension The class display name (ClassDisplayName) extension enables client applications to retrieve the display name of an object class as part of the object type definition for a collection of objects. In addition. you should keep the following restrictions in mind: v The extensions are for an IBM FileNet Content Manager repository only. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. 56 Planning. such as documents and folders. it is recommended that you design the application to use the value that is provided by the extension only if a value is available. it is recommended that you design the application to use the value that is provided by the extension only if a value is available. Remember: If you design your client application to use this IBM CMIS extension. Remember: If you design your client application to use this IBM CMIS extension. Response format <p8ext:ChoiceListDisplayName>Display Name</p8ext:ChoiceListDisplayName> Domain name extension The domain name (DomainName) extension enables client applications to retrieve the IBM FileNet P8 domain name as part of the repository information. If this information is not provided. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.Response format <p8ext:ClassDisplayName>Class Display Name</p8ext:ClassDisplayName> Hidden properties extension The hidden properties (isHidden) extension enables client applications to determine the object properties that should not be displayed based on the object properties that are marked as hidden in Content Engine. it is recommended that you design the application to use the value that is provided by the extension only if a value is available. Response format <p8ext:ChoiceListSymbolicName>Symbolic Name</p8ext:ChoiceListSymbolicName> Choice list display name extension The choice list display name (ChoiceListDisplayName) extension enables client applications to retrieve the display name of a choice list (also called a controlled vocabulary list or a CVL) from Content Engine. it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not IBM CMIS for FileNet Content Manager Development 57 . it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. Remember: If you design your client application to use this IBM CMIS extension. Response format <p8ext:isHidden>Boolean true or false</p8ext:isHidden> Choice list symbolic name extension The choice list symbolic name (ChoiceListSymbolicName) extension enables client applications to retrieve the symbolic name of a choice list (also called a controlled vocabulary list or a CVL) from Content Engine. If this information is not provided. Remember: If you design your client application to use this IBM CMIS extension. that the repository runs on as part of the repository information. If text search is enabled. Response format <p8ext:ObjectStoreID>{GUID}</p8ext:ObjectStoreID> Object store database type extension The object store database type (ObjectStoreDBType) extension enables client applications to retrieve the type of database. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. Remember: If you design your client application to use this IBM CMIS extension. If this information is not provided. it is recommended that you design the application to use the value that is provided by the extension only if a value is available.provided. and Configuring IBM CMIS for FileNet Content Manager . this extension identifies which text search engine is installed. This information is provided as part of the repository information. Installing. Remember: If you design your client application to use this IBM CMIS extension. If this information is not provided. Response format <p8ext:RecordsManagementEnabled>Boolean true or false</p8ext:RecordsManagementEnabled> Text search engine extension The text search engine (TextSearchEngine) extension enables client applications to determine whether text search is enabled on the repository. it is recommended that you design the application to use the value that is provided by the extension only if a value is available. This information is provided as part of the repository information. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. it is recommended that you design the application to use the value that is provided by the extension only if a value is available. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. 58 Planning. such as DB2® or Oracle. Remember: If you design your client application to use this IBM CMIS extension. Response format <p8ext:DomainName>FileNet P8 Domain Name</p8ext:DomainName> Object store ID extension The object store ID (ObjectStoreID) extension enables client applications to retrieve the object store GUID as part of the repository information. If this information is not provided. Response format <p8ext:ObjectStoreDBType>Database type</p8ext:ObjectStoreDBType> Records management extension The records management (RecordsManagementEnabled) extension enables client applications to determine whether the documents in a repository can be declared as records. it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification. you must be aware of the behaviors and limitations of the implementation. Remember: If you design your client application to use this IBM CMIS extension. Request format Accept-Encoding: gzip Response format Content-Encoding: gzip IBM CMIS for FileNet Content Manager implementation of the OASIS CMIS specification The OASIS Content Management Interoperability Services (CMIS) specification enables applications to implement the specification in slightly different ways to account for the differences between repositories.Regardless of the text search engine that is installed.capabilities structure. The repository has an IBM Legacy Content Search Engine text search engine installed.api. see the com. Tip: To learn about the optional capabilities that a repository supports. IBM CMIS for FileNet Content Manager Development 59 . The repository has a IBM Content Search Services text search engine installed. Important: The values that are returned by this extension are documented in the Content Engine API. When you develop a client application that uses CMIS services to interact with a repository. GZIP compression extension The GZIP compression extension enables client applications to request compressed responses from IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) to increase performance. see the values that are published in the repositoryInfo. it is recommended that you design the application to use the value that is provided by the extension only if a value is available.constants. your client must use OASIS CMIS search syntax.filenet. Response format <p8ext:TextSearchEngine>Integer value for text search engine</p8ext:TextSearchEngine> The extension returns one of the following values: 0 1 2 The repository does not have a text search engine installed. For definitive information about the text search values. If a client application sends a request that contains an Accept-Encoding header that specifies the GZIP file compression. IBM CMIS compresses the response using GZIP compression.CRBSearchType section of the Content Engine API. If this information is not provided. and Configuring IBM CMIS for FileNet Content Manager .In addition.4. relationships. IBM CMIS implementation IBM CMIS for FileNet Content Manager supports the cmis:changeToken property for only documents and folders. repositories.2. The cmis:changeToken property is included in the object metadata for the cmis:document type and the cmis:folder type. OASIS CMIS specification The OASIS CMIS specification uses up links that are defined in the AtomPub RFC.3.1. you should be aware of the following behaviors and limitations when you develop a client application to connect to an IBM FileNet Content Manager system by using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS).2 Hierarchy Navigation Internet Draft Link Relations of the OASIS CMIS specification. “Change token support” “Links in private working copy support” “Paging feed support” on page 61 “Query support” on page 61 “Versioning properties on document objects support” on page 63 Change token support IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports the cmis:changeToken property for only documents and folders. Links in private working copy support IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports up links in private working copies. see section 3. OASIS CMIS specification The OASIS CMIS specification defines the cmis:changeToken property to provide optimistic locking to prevent client applications from updating out-of-date objects.3 Change Tokens of the OASIS CMIS specification. see section 2. For more information. but in some cases the up link leads to an empty feed: v If a version series includes a version other than the private working copy of the document. 60 Planning. IBM CMIS implementation IBM CMIS for FileNet Content Manager always includes an up link in private working copies. in some cases the up link leads to an empty feed. or content streams. the up link in the private working copy leads to an empty feed. For more information. IBM CMIS does not support the property for domains. However. The cmis:changeToken property maps to the IBM FileNet P8 UpdateSequenceNumber property. Installing. and last links that are defined in the AtomPub RFC. previous.v If a version series has only one version and that version is the private working copy of the document. IBM CMIS implementation IBM CMIS for FileNet Content Manager supports the OASIS CMIS query specifications with the following exceptions and limitations. For more information.8 Paging of Feeds of the OASIS CMIS specification. OASIS CMIS specification The OASIS CMIS specification provides a type-based query service to search for objects on the repository.1. Query support IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports queries. IBM CMIS for FileNet Content Manager might provide an unnecessary next link. see section 2. However there are some restrictions that you should be aware of when developing queries. For more information. OASIS CMIS specification The OASIS CMIS specification uses first. IBM CMIS implementation IBM CMIS for FileNet Content Manager supports the paging of feeds. Paging feed support IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports the paging of feeds. IBM CMIS for FileNet Content Manager does not support querying on the percent sign (%) or the underscore (_) characters in a LIKE string because the Content Engine APIs do not support ESCAPE clauses. the up link in the private working copy leads to a feed that contains the parent folder of the private working copy.10 Query of the OASIS CMIS specification. One of the requirements is that in a LIKE string. If IBM CMIS for FileNet Content Manager Development 61 . Next links When the last page of feed is full (more specifically. Character escaping in LIKE strings is not supported The OASIS CMIS specification requires repositories to support the backslash (\) as an escape character in query statements. next. when the number of items returned equals the value specified for the maxItems argument). see section 3.1. However. However. last links are not supported. and next links sometimes return a page that contains no results. but has the following behaviors for next and last links: Last links Last links are not supported. \% represents % and \_ represents _. if you submit the following query. so that IBM FileNet P8 can parse the query. IBM CMIS for FileNet Content Manager converts the characters to an underscore. IBM FileNet P8 returns a parsing error on the INNER JOIN clause: SELECT d.cmis:lastModifiedBy = e. IBM CMIS for FileNet Content Manager requires parentheses around the nested <joined table>. Installing. Tip: You can use percent signs and underscores as wildcard characters in queries that include equality conditions because equality conditions do not require escape characters.cmis:createdBy<>’admin’ To run this query in IBM CMIS for FileNet Content Manager.cmis:createdBy = f. Parentheses are required for nested JOIN clauses The OASIS CMIS specification defines the following syntax for a query that contains nested JOIN clauses: <joined table> ::= "(" <joined table> ")" | <table reference> [ <join type> ] JOIN <table reference> <join specification> In the OASIS CMIS specification. For example.cmis:createdBy INNER JOIN EntryTemplate e ON d. you must use the following syntax: SELECT d.* FROM (cmis:document d INNER JOIN cmis:folder f ON d. document_2. which is a single-character wildcard. and document11.* FROM cmis:document d INNER JOIN cmis:folder f ON d. For example. Converting escaped percent signs and escaped underscores to a single-character wildcard character can result in more search results than expected. The expected result is that document_1 and document_2 are returned by the query. However. You use the query SELECT * FROM Document WHERE DocumentTitle LIKE ’document\_%’ to search for all documents that have a title that starts with document_.cmis:lastModifiedBy WHERE e.cmis:lastModifiedBy = e.cmis:createdBy) INNER JOIN EntryTemplate e ON d.a query includes an escaped percent sign (\%) or an escaped underscore (\_). you can use the query SELECT * FROM Document WHERE DocumentTitle = ’document_1’ OR DocumentTitle = ’document_2’ to return document_1 and document_2. However.cmis:createdBy<>’admin’ Nested JOIN clauses can appear on only one side of the JOIN keyword The OASIS CMIS specification defines the following syntax for a query that contains nested JOIN clauses on both sides of the JOIN keyword: <table reference> ::= <table name> [ [ AS ] <correlation name> ] | <joined table> <joined table> ::= "(" <joined table> ")" | <table reference> [ <join type> ] JOIN <table reference> <join specification> 62 Planning. and Configuring IBM CMIS for FileNet Content Manager . This query returns all three documents.cmis:createdBy = f.cmis:lastModifiedBy WHERE e. when you submit the query. IBM CMIS for FileNet Content Manager converts the query to (SELECT * FROM Document WHERE DocumentTitle LIKE ’document_%’). the parentheses around the nested <joined table> are optional. you have three documents in your repository named document_1. For example. When the service completes. If a document or folder cannot be deleted.cmis:createdBy) ON d. if you submit the following query.cmis:createdBy<>’admin’ Versioning properties on document objects support IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) does not honor the cmis:checkinComment property. folders and documents are deleted individually.5 Versioning Properties on Document Objects of the OASIS CMIS specification.cmis:createdBy = e2. you must remove the nested JOIN clause on one side of the JOIN key word. IBM CMIS for FileNet Content Manager supports nested JOIN clauses on either the left side or the right side of the JOIN keyword.cmis:createdBy) INNER JOIN (EntryTemplate e INNER JOIN Email e2 ON e. IBM FileNet P8 returns a parsing error because there is a nested JOIN clause on each side of the JOIN keyword: SELECT d. IBM CMIS implementation If a value is specified for the cmis:checkinComment property. it returns a list of the document IDs and folder IDs that were not deleted to the client application.In the OASIS CMIS specification.cmis:lastModifiedBy WHERE e. If you call the deleteTree service with the continueOnFailure parameter set to true. see section 2. IBM CMIS for FileNet Content Manager Development 63 .cmis:lastModifiedBy = e.cmis:createdBy = f. which includes the cmis:checkinComment property. However. you can have nested JOIN clauses on either side of the JOIN keyword. the service moves to the next document or folder in the list. For more information.* FROM EntryTemplate e INNER JOIN (cmis:document d INNER JOIN cmis:folder f ON d. Best practices for developing client applications There are several best practices and recommendations that you should keep in mind when accessing content through IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). the value is ignored when the document is checked in. OASIS CMIS specification The OASIS CMIS specification defines a set of versioning properties for document objects.cmis:createdBy) ON d.cmis:createdBy = f. For example. The following query has a nested JOIN clause on the right side of the JOIN keyword: SELECT d.cmis:createdBy<>’admin’ To run this query in IBM CMIS for FileNet Content Manager.9.1. but not on both sides of the JOIN keyword. Recommendations for using the deleteTree service The deleteTree service deletes a folder and all of its subfolders and documents.* FROM (cmis:document d INNER JOIN cmis:folder f ON d.cmis:lastModifiedBy WHERE e.cmis:lastModifiedBy = e. none of the contents of the folder are deleted and an error is returned to the client. This is especially important if you use Web Services to retrieve documents because Web Services does not provide a next link. the most efficient method to access large objects is the SOAP Message Transmission Optimization Mechanism (MTOM) method. v If you want to retrieve a large number of unfiled documents. Recommendations for working with large objects If your repository contains large objects. use the Unfiled service collection URL only when the least number of users are using the system. which improves performance. the service can time out if the parent folder contains many documents and folders.If you call the deleteTree service with the continueOnFailure parameter set to false. you can reduce the impact of using the Unfiled service collection URL: v In REST feeds. the service can consume system resources in a large system. and Configuring IBM CMIS for FileNet Content Manager . If you implement the following suggestions. However. The setContentStream method is defined in section 2. use a custom query to return only the wanted documents.16 setContentStream of the OASIS CMIS API specification. v If your repository (IBM FileNet P8 object store) contains more than 1.000 documents. v If you want to retrieve a specific set of unfiled documents. you can call the deleteTree service on a subfolder of the parent folder to reduce the number of objects that are deleted at one time and to avoid a timeout.000.2. the most efficient method to access large objects is the setContentStream method. use next links to page through results rather than requesting the next page with a skip count. 64 Planning. specify a larger value for the maxItems parameter to reduce the amount of paging that is required to display the documents. which must be configured in client application. Recommendations for getting unfiled documents When you retrieve unfiled documents by using the Unfiled service collection URL. v For Web Services. all of the folders and documents are deleted in a single batch.4. When continueOnFailure is set to false. Installing. you should implement the following recommendations to reduce memory consumption: v For REST Services. If this occurs. if a document or folder cannot be deleted. fncmis-install.log This log file is generated during the IBM CMIS for FileNet Content Manager installation. and information that you must collect before calling IBM Software Support. if the installation program stops before you specify the installation directory. 2010. this section includes information about log files. use this log file to determine where and why the problem occurred: v You cannot establish a test connection to Content Engine v The application EAR file cannot be built v The application cannot be deployed to WebSphere Application Server © Copyright IBM Corp. If the IBM CMIS installation fails.log This log file is generated during the IBM CMIS for FileNet Content Manager installation and contains debug-level logging information. For example. configure. If you experience issues in the following situations. the log file is saved to the desktop on Windows or the home directory of the user who is running the installation on AIX or Linux.log This log file is generated by the IBM CMIS for FileNet Content Manager configuration tool and contains debug-level logging information. use this log file to determine where and why the problem occurred. runtime error messages. However. 65 . Use this log file to determine whether IBM CMIS for FileNet Content Manager was successfully installed.Troubleshooting IBM CMIS for FileNet Content Manager This section includes information that you can use to troubleshoot common problems that you might encounter when using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). This log file is located in the log subdirectory of the IBM CMIS installation directory. Installation log files IBM CMIS for FileNet Content Manager generates two installation log files: fncmis-install-ia. Configuration log files IBM CMIS for FileNet Content Manager generates one configuration log file: fncmis-config. This log file is located in the log subdirectory of the IBM CMIS installation directory. or use IBM CMIS. “IBM CMIS for FileNet Content Manager log files” “Collecting data for IBM CMIS for FileNet Content Manager” on page 67 “Error messages for IBM CMIS for FileNet Content Manager” on page 69 IBM CMIS for FileNet Content Manager log files IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) generates several log files that you can use to troubleshoot problems that occur when you install. and Configuring IBM CMIS for FileNet Content Manager . If you configure finest-level logging or higher (up to fatal-level logging). you can find information that can help you resolve problems that occur when using IBM CMIS for FileNet Content Manager in several locations: SystemOut. For information about configuring the trace.log file. which can be configured through the WebSphere Application Server administrative console. You can configure client-side logging if you need to troubleshoot problems related to Content Engine.log IBM CMIS for FileNet Content Manager uses the Apache Commons Logging API. and error messages.log IBM CMIS for FileNet Content Manager uses the Apache Commons Logging API. see “Configuring logging” on page 39. This log file is used by IBM Software Support to pinpoint when and where a failure occurred. which can be configured through the WebSphere Application Server administrative console. this log file also includes stack trace. see Tracing and logging configuration in the WebSphere Application Server information center. Runtime log files Depending on how you configure logging for IBM CMIS for FileNet Content Manager. To learn more about the trace. fncmis_api_error. see “Configuring logging” on page 39. this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory. warning messages. trace. To learn more about the SystemOut. If IBM CMIS for FileNet Content Manager throws an exception. this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory.log file for IBM CMIS for FileNet Content Manager.This log file is located in the log subdirectory of the IBM CMIS installation directory. see Tracing and logging configuration in the WebSphere Application Server information center.log file.log IBM CMIS for FileNet Content Manager bundles and performs most content operations through the Apache Commons Logging API. 66 Planning.log file for IBM CMIS for FileNet Content Manager. By default. This log file shows the calls that IBM CMIS for FileNet Content Manager makes to the enable IBM Software Support to pinpoint when and where a failure occurred. Use this log file to review messages that occur when IBM CMIS for FileNet Content Manager is running. Installing. If you configure detail-level logging or higher (up to fatal-level logging) information is written to this log file and to the trace.log file. information is written to this log file. For information about configuring the SystemOut. This log file contains informational messages. By default. see “Configuring Content Engine API client logging” on page 42. This log file shows the calls that IBM CMIS for FileNet Content Manager makes to enable IBM Software Support to pinpoint when and where a failure occurred. Collecting data before opening a problem management record (PMR) can help you to answer the following questions: v Do the symptoms match any known problems? If so. In such cases. has a fix or workaround been published? v Can the problem be identified and resolved without a code fix? v When does the problem occur? Complete the following steps before contacting IBM Software Support: 1. this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory. By default. If you experience issues when you uninstall IBM CMIS.log IBM CMIS for FileNet Content Manager bundles and performs most content operations through the IBM FileNet Content Engine Java API. use this log file to determine where and why the problem occurred. You can configure client-side trace logging if you need to troubleshoot problems related to Content Engine.log file for IBM CMIS for FileNet Content Manager. this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory. you must collect diagnostic data before contacting IBM Software Support. This log file is located in the log subdirectory of the IBM CMIS installation directory. Uninstallation log files IBM CMIS for FileNet Content Manager generates one uninstallation log file: fncmis-uninstall. fncmis_api_trace. you might need to contact IBM Software Support for additional assistance. see “Configuring Content Engine API client logging” on page 42.log file. For information about configuring the fncmis_api_trace.log This log file is generated during the IBM CMIS for FileNet Content Manager uninstallation and contains debug-level logging information.log file for IBM CMIS for FileNet Content Manager. For information about configuring the fncmis_api_error.By default. Collecting data for IBM CMIS for FileNet Content Manager If you cannot determine the cause of a problem. Ensure that you have the appropriate versions of the following prerequisite software installed: v IBM WebSphere Application Server v IBM FileNet Content Manager Troubleshooting IBM CMIS for FileNet Content Manager 67 . This log file includes more detailed information than the fncmis_api_error. v IBM FileNet Content Engine Client For more information about the prerequisite software.log For information about the location of the IBM CMIS for FileNet Content Manager log files. Important: After you gather all the information that is needed to open a problem report. which includes information about your IBM CMIS configuration. Gather the following information about your environment: v What version of IBM CMIS for FileNet Content Manager is installed? Recommendation: Copy the installation information from the About your IBM CMIS installation page on the IBM CMIS for FileNet Content Manager index page. system properties. and environment variables. Recreate the problem with finest-level logging and Content Engine Client API trace logging enabled. including the version number. For information about enabling finest-level logging. 4. see “Specifying log level entries” on page 40. Installing. Gather the IBM CMIS for FileNet Content Manager log files: v v v v v fncmis-install-ia.log fncmis-install. 2. of the IBM CMIS for FileNet Content Manager server? v What version of WebSphere Application Server is IBM CMIS for FileNet Content Manager deployed to? (Specify WebSphere Application Server or WebSphere Application Server Network Deployment.log v fncmis_api_trace.) v Was IBM CMIS for FileNet Content Manager deployed automatically or manually? 68 Planning. For information about enabling Content Engine Client API trace logging. see “Prerequisites” on page 5.log v SystemOut. see “Configuring Content Engine API client logging” on page 42. restore your original logging settings to control the size of your log files and to improve performance.log v trace.log fncmis-config. v How is your IBM CMIS for FileNet Content Manager system configured? Recommendation: Copy the configuration information from the About your IBM CMIS configuration page on the IBM CMIS for FileNet Content Manager index page. see “IBM CMIS for FileNet Content Manager log files” on page 65. v Is the IBM CMIS for FileNet Content Manager installation a fresh installation or did you upgrade from a previous version of IBM CMIS for FileNet Content Manager? v What is the operating system. and Configuring IBM CMIS for FileNet Content Manager .log fncmis-uninstall.log (if applicable) fncmis_api_error. 3. “CIL1100” on page 71 “CIL1122” on page 71 “CIL1125” on page 71 “CIL1129” on page 71 “CIL1130” on page 71 “CIL1139” “CIL1140” “CIL1143” “CIL1144” “CIL1145” “CIL1146” “CIL1147” on on on on on on on page page page page page page page 71 71 71 71 72 72 72 “CIL1148” on page 72 “CIL1200” on page 72 “CIL1217” on page 72 “CIL1218” on page 72 “CIL1298” on page 72 “CIL1299” “CIL1300” “CIL1400” “CIL1401” on on on on page page page page 72 72 72 73 “CIL1402” on page 73 “CIL1403” on page 73 “CIL1404” on page 73 “CIL1405” on page 73 “CIL1406” on page 73 Troubleshooting IBM CMIS for FileNet Content Manager 69 . the errors are also provided in the information center for your reference. a managed node. Describe the problem. how? Provide specific steps to reproduce the problem. However. Provide the following information to help IBM Software Support understand the problem that you are encountering: v What are you trying to do when the problem occurs? v Can the problem be reproduced? If so. v How many users are affected by this problem? v What is the business impact of this problem? v Is there a workaround for this problem? Error messages for IBM CMIS for FileNet Content Manager If you receive an error message while using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS).v What type of environment is IBM CMIS for FileNet Content Manager deployed to? For example is IBM CMIS deployed to a single application server. the error that is displayed in the HTTP response contains the information that you need to resolve the issue. or an application server cluster? v How was IBM CMIS for FileNet Content Manager configured? Did you use the configuration tool or did you run a silent configuration? 5. an unmanaged node. and Configuring IBM CMIS for FileNet Content Manager .“CIL1407” “CIL1408” “CIL1412” “CIL1413” “CIL1415” “CIL1416” “CIL1417” “CIL1500” “CIL1502” “CIL1503” “CIL1508” “CIL1510” on on on on on on on on on on on on page page page page page page page page page page page page 73 73 73 73 73 74 74 74 74 74 74 74 “CIL1511” on page 74 “CIL1513” on page 75 “CIL1514” on page 75 “CIL1515” on page 75 “CIL1516” on page 75 “CIL1517” on page 75 “CIL1519” on page 75 “CIL1524” on page 75 “CIL1525” on page 75 “CIL1600” “CIL1601” “CIL1602” “CIL1603” “CIL1604” “CIL1605” “CIL1606” “CIL1607” on on on on on on on on page page page page page page page page 75 75 76 76 76 76 76 76 “CIL1609” on page 76 “CIL1610” on page 76 “CIL1611” on page 76 “CIL1612” on page 76 “CIL1613” on page 76 “CIL1614” on page 77 “CIL1615” “CIL1616” “CIL1700” “CIL1701” “CIL1800” “CIL1900” “CIL2000” on on on on on on on page page page page page page page 77 77 77 77 77 77 77 “CIL2001” on page 77 “CIL2100” on page 77 “CIL2102” on page 78 70 Planning. Installing. see the HTTP resources that are mentioned in the "Normative References" section of the OASIS CMIS API specification. {parameter name}. CIL1140 The service cannot be completed because the following object is a root folder: {object path or object ID} Explanation: Either the query contains an invalid character. User response: Modify the query and try again. was not specified. User response: Specify a path or object ID that points to a document. see the OASIS CMIS API specification. see the OASIS CMIS API specification. User response: Resubmit the request with a properly encoded content stream. User response: Provide the required HTTP header. User response: For more information about the HTTP request header. CIL1139 CIL1122 The query cannot be completed because the query syntax is not correct. However. or the structure of the query is not correct. Query: {query string} OASIS CMIS exception: {exception message} The service cannot be completed because the following object is not a folder: {object path or object ID} Explanation: No additional explanation is required. CIL1129 The service cannot be completed because the content stream cannot be decoded. For more information about implementing the service. Invalid value: {invalid header value} Explanation: No additional explanation is required. User response: Specify a path or object ID that points to a folder other than a root folder. the folder that was specified is a root folder. CIL1143 The service cannot be completed because the following object is not a document: {object path or object ID} Explanation: The service can be performed only for a document. see the "Query Language Definition" section of the OASIS CMIS API specification for more information. CIL1125 The service cannot be completed because the {header name} HTTP header is missing.CIL1100 • CIL1144 “CIL2103” “CIL2104” “CIL2105” “CIL2106” “CIL2107” on on on on on page page page page page 78 78 78 78 78 “CIL2200” on page 78 “CIL2300” on page 78 CIL1100 The service cannot be completed because one or more of the input parameters are missing or are not valid. Explanation: The specified header is required. For more information about required HTTP headers. OASIS CMIS requires a base64 encoding. If the problem persists. which does not have parents. see the OASIS CMIS API specification. Troubleshooting IBM CMIS for FileNet Content Manager 71 . see the HTTP resources that are mentioned in the "Normative References" section of the OASIS CMIS API specification. Explanation: No additional explanation is required. CIL1144 The service cannot be completed because the required input parameter. see the OASIS CMIS API specification. For more information about implementing the service. CIL1130 The service cannot be completed because the {header name} HTTP request header contains an invalid value. Explanation: The service can be performed only for a folder. Input length: {content length} Document MIME type: {MIME type} Required encoding: base64 Explanation: The service returns the parents of a folder. Explanation: The document might be corrupted or truncated. For more information about implementing the service. User response: Specify a path or object ID that points to a folder. User response: For more information about implementing the argument. CIL1146 The service cannot be completed because the value that was specified for the following input parameter is not valid. If the problem persists. User response: Use the getRepositoryInfo service to 72 Planning. Installing. or the Web Services binding document. User response: Specify a URL with the correct format. CIL1218 The major version of the document cannot be retrieved because the version series does not contain a major version. see the OASIS CMIS API specification. see the OASIS CMIS API specification. Explanation: The object ID or path might contain invalid characters or use invalid syntax. User response: If you need different permissions. Object type ID: {object type} Explanation: Either the specified object type ID does not exist or is not a valid argument for the query. and Configuring IBM CMIS for FileNet Content Manager . contact your content management server administrator for assistance. User response: Verify that the path or ID of the object is correct or specify a different object. CIL1300 Your request cannot be completed because you do not have the appropriate permissions on the repository. see the OASIS CMIS API specification. CIL1147 The URL of the request is not valid. User response: For information about implementing the argument. Explanation: No additional explanation is required. CIL1145 The service cannot be completed because the value that was specified for the following input parameter is not valid. CIL1148 The service cannot be completed because the following object ID or path is not valid: {object path or object ID} Explanation: No additional explanation is required. URL: {URL} Invalid portion of the URL: {invalid syntax} Explanation: No additional explanation is required. or the RESTful AtomPub binding service document. For more information about implementing the service. Explanation: No additional explanation is required. CIL1299 The service cannot be completed because the following object cannot be found: Input parameter: {parameter name} Object ID or path: {object path or object ID} Explanation: The syntax of the URL is incorrect. User response: For information on implementing the getObjectOfLatestVersion argument. Input parameter: {parameter name} Value: {parameter value} CIL1217 The query contains an invalid object type ID. see the OASIS CMIS API specification. CIL1200 The service cannot be completed because the object cannot be found. User response: Verify that the path or ID of the object is correct or specify a different object. User response: For information about implementing the argument. such as cmis:document or cmis:folder. CIL1298 The service cannot be completed because the following object cannot be found: {object path or object ID} Explanation: No additional explanation is required. Explanation: No additional explanation is required. User response: Ensure that a valid object ID or path is retrieved from HTTP responses. Input parameter: {parameter name} Value: {parameter value} Valid values: "{list or range of valid values}" Explanation: This error occurs when the object that is specified for the getObjectOfLatestVersion argument does not have a major version.CIL1145 • CIL1400 User response: Specify the required input parameter. User response: Verify that the object type is spelled correctly and is a supported OASIS CMIS object type. See the RESTful AtomPub binding service document for information about the correct format for collection URLs. User response: Verify that the path or ID of the object is correct or specify a different object. CIL1400 The service cannot be completed because the service method that was invoked requires an optional capability that is not supported by the repository. Explanation: No additional explanation is required. see the "Query Language Definition" section of the OASIS CMIS specification for more information. CIL1413 The object cannot be unfiled from the folder because it is not a document. Explanation: The deleteTree service can be used only to delete folders. or orderable cannot be used in a query statement. User response: No action required. Contact your content server system administrator for additional information about the query restrictions that apply to your content management system. or orderable. Explanation: The NOT operator cannot be used with a CONTAINS clause. or orderable. Explanation: A query statement can include only one CONTAINS clause. User response: For more information on the deleteTree Troubleshooting IBM CMIS for FileNet Content Manager 73 . User response: Modify the query to add a CONTAINS clause or remove the SCORE clause. selectable. CIL1412 The object of type {object type} cannot be created. Contact your content server system administrator for additional information about the query restrictions that apply to your content management system. To learn more. User response: Modify the query to replace "NOT CONTAINS(''query_string1 query_string2'')" with "CONTAINS(''-query_string1 -query_string2'')". Contact your content server system administrator for additional information about the query restrictions that apply to your content management system. CIL1404 The following query cannot be used because the NOT operator cannot be used with a CONTAINS clause. Explanation: No additional explanation is required. Use the property definition or contact your content server administrator to determine whether a property is queryable. CIL1407 The query cannot be used because it has more than one CONTAINS clause. User response: Ensure that the object that you want to unfile is a document and try again. Explanation: No additional explanation is required. User response: Modify the query to remove the specified property. User response: Modify the query to use only one CONTAINS clause or separate each CONTAINS clause into a separate query. Content management server error: {exception message} CIL1406 The {0} property cannot be used in a query statement. CIL1405 The query cannot be used because it has a CONTAINS clause and a JOIN clause. Explanation: Only documents can be unfiled. Explanation: IBM CMIS does not support the specified object type. selectable. Explanation: The query supports only equality (=) and IN operators for certain properties. Explanation: A query cannot have both a CONTAINS clause and a JOIN clause. selectable. User response: Ensure that the document that you want to delete is checked out and try again. Query: {query string} Explanation: A query statement that includes a SCORE clause must include a corresponding CONTAINS clause. because the property is not queryable. Explanation: A property that is not queryable.CIL1401 • CIL1415 see the supported services for a repository. User response: Rewrite the query to use the equals (=) or IN operator. CIL1403 The {operator name} operator cannot be used to query the {property name} property. User response: See the content management server documentation for information on resolving the issue. CIL1415 The object cannot be deleted because the object is not a folder. CIL1402 The document cannot be deleted because it is not checked out. To learn more. see the "Query Language Definition" section of the OASIS CMIS specification. CIL1408 The query cannot be used because it has a SCORE clause but does not have a corresponding CONTAINS clause. see the "Query Language Definition" section of the OASIS CMIS specification. CIL1401 The content stream cannot be deleted because the following error occurred on the content management server. User response: Modify the query to remove the CONTAINS clause or the JOIN clause. v The content management server connection information in the IBM CMIS configuration is not correct. By default. modify the fncmis_advanced. Installing.properties file and run the configuration program again to rebuild and deploy the web application EAR file.log file for more information. full-text search must be configured on the repository. see the OASIS CMIS API specification. and Configuring IBM CMIS for FileNet Content Manager .log file is in the WAS_profile_location/logs/server/logs subdirectory of the WebSphere Application Server installation directory. CIL1416 The {operation name} HTTP operation is not supported on this collection or resource.log file is in the WAS_profile_location/logs/server/logs subdirectory Explanation: See the "Installation and configuration checklist" in the information center for information about the valid values and formats for each property. modify the fncmis_advanced. run the configuration program again to rebuild and deploy the web application EAR file. Explanation: To run the query. v IBM CMIS cannot connect to the content management server because of a network connectivity problem. CIL1511 The service cannot be completed because no repositories were found. {value}. that was specified for the {property name} property in the configuration file is not valid. User response: See the WebSphere Application Server SystemOut. v The WebSphere Application Server security information in the IBM CMIS configuration is not correct. The correct syntax is property=value. v An LTPA key expired. User response: Take one of the following actions to resolve the issue: v If the property is a basic configuration property. 74 Planning. Configuration file entry: {property name}/{value} Explanation: The syntax property/value is not correct. CIL1510 The service cannot be completed because the operation requires an object. see the OASIS CMIS API specification. the SystemOut. CIL1503 The syntax of the following entry is not valid.properties file and run the configuration program again to rebuild and deploy the web application EAR file. see the OASIS CMIS API specification. CIL1502 The value.CIL1416 • CIL1511 service. User response: Contact your content server system administrator to determine whether full-text search is configured for the repository. CIL1508 The query cannot be run because full-text search is not configured for the repository. and {path or ID} is not an object. User response: For more information about the specified HTTP operation. CIL1500 The service cannot be completed. Explanation: This error can occur for the following reasons: v No repositories are defined on the content management server. Explanation: No additional explanation is required. Explanation: IBM CMIS does not support the specified object type. User response: For more information about implementing the service. the SystemOut. Explanation: This error can occur for the following reasons: v An error in the IBM CMIS application v An error on the repository User response: See the HTTP response or the WebSphere Application Server SystemOut. User response: No action is required. Explanation: The operation can be performed only for an object. v An LDAP server is not running or cannot be reached because of a network connectivity problem.log file for more information and to review the stack trace for the exception. User response: Take one of the following actions to resolve the issue: v If the property is a basic configuration property. By default. v If the property is an advanced configuration property. See the "Installation and configuration checklist" in the information center for information about the valid values and formats for each property. run the configuration program again to rebuild and deploy the web application EAR file. CIL1417 The service cannot be completed because the {object type} object type is not supported. v If the property is an advanced configuration property. User response: Provide a valid CMIS Atom entry. User response: Run the configuration program again to rebuild and deploy the web application EAR file. For information on how to format the SOAP header. Query: {query string} Content server exception: {exception message} the content management server. Explanation: The folder cannot be deleted if the folder contains an object that cannot be deleted. CIL1525 The service cannot be completed because an error occurred in IBM CMIS. which is a required element. By default. You can use an OASIS CMIS service. CIL1513 The query cannot be run because the following error occurred. User response: See the WebSphere Application Server SystemOut. For more information about Atom entries. see the OASIS CMIS API specification. see the W3C standard Web Services Internationalization (WS-I18N). CIL1601 The service cannot be completed because a value that was specified for a property violated a constraint. take one of the following actions: v Delete smaller folders. CIL1516 The folder cannot be deleted because the {object path or object ID} object cannot be deleted. Before calling.log file is in the WAS_profile_location/logs/server/logs subdirectory of the WebSphere Application Server installation directory. Explanation: An error occurred on the content server when running the query. the SystemOut. such as getChildren or query. Explanation: No additional explanation is required. CIL1600 The service cannot be completed because a constraint was violated. Content management server error: {error message} Explanation: No additional information is available.properties configuration file. cannot be loaded from the web application.log file for more information and to review the stack trace for the exception. For example delete any subfolders before deleting the parent folder. Explanation: The configuration file might be corrupted or might have been moved or deleted. User response: For more information about implementing the service. CIL1517 The service cannot be completed because the XML input cannot be deserialized.CIL1513 • CIL1601 of the WebSphere Application Server installation directory. User response: Run the configuration program again to specify the missing property and to rebuild and deploy the web application EAR file. IBM CMIS error: {additional error information} Explanation: According to the W3C Web Services Internationalization (WS-I18N) standard. ensure that you collect the information that is listed in "Collecting data for IBM CMIS" in the information center. Explanation: No additional explanation is required. Explanation: Either no input was provided or the input is not a well-formed XML document. is not defined in the cmis. {property name}. See the content management server documentation for information about resolving the error that occurred on Explanation: The value that was specified for a property is outside the permitted range or the value exceeds the maximum length allowed. see the OASIS CMIS API specification. CIL1519 The configuration file. Troubleshooting IBM CMIS for FileNet Content Manager 75 . User response: Contact IBM Software Support. User response: Delete the objects in the folder individually. to determine the objects that are still in the folder. Explanation: No additional explanation is required. CIL1514 The required property. CIL1524 The folder cannot be deleted because the deleteTree service timed out. {file name}. User response: To prevent the request from timing out. v Resubmit the delete request with the continueOnFailure property set to true. the international element in a SOAP header must have exactly one locale element. and the locale element must be the first item in the children property of the international element. CIL1515 The SOAP header is missing the locale element. User response: Add the locale element to the international element in the SOAP header. User response: Specify a valid versioning parameter. CIL1605 Versioning is disabled for the {document class} document class when the versioning state is set to "{versioning state}". For more information about the versioning service. see the OASIS CMIS API specification. Explanation: The getObjectParents method returns the parent folders of a fileable object. Explanation: No additional explanation is required. see the OASIS CMIS API specification. Contact your content management system administrator for information about the versioning requirements on the repository. Contact your content management system administrator for information about the versioning requirements on the repository. User response: Specify a valid versioning parameter. User response: Specify a value for each required property and try to create the document again. Explanation: No additional explanation is required. User response: For more information about deleting folders. Installing. CIL1606 The {document path or document ID} document cannot be checked out because versioning is disabled. User response: For more information about the getObjectParents method. Explanation: When versioning is disabled for the document type. CIL1612 The object cannot be updated because the {property name} property is read-only. User response: No action is required. 76 Planning. see the OASIS CMIS API specification. CIL1611 A property cannot be set or modified because it is read-only. Explanation: The specified document type requires versioning. documents cannot be checked out. Explanation: No additional explanation is required. Explanation: The delete operation cannot be performed for a folder that is not empty. Contact your content management system administrator for information about the versioning requirements on the repository. see the OASIS CMIS API specification. see the OASIS CMIS API specification. User response: No action is required. and Configuring IBM CMIS for FileNet Content Manager . Explanation: No additional explanation is required. CIL1604 The document cannot be created because the {versioning state} versioning state is not a valid state for the {document type} document type. Use the document type definition to determine which properties are required. CIL1607 The folder cannot be deleted because it is not empty.CIL1602 • CIL1613 User response: Use the property definition of the object type to get the valid range and maximum length. User response: For more information about the versioning service. If an object is not fileable. Explanation: The service can be completed only for documents that contain content streams. CIL1602 The document cannot be checked out because the object ID was not specified. CIL1610 The document cannot be created because one or more required properties are missing. CIL1613 The service cannot be completed because the document does not contain a content stream. User response: For more information about content streams. User response: Use the property definition to determine which properties can be modified and which properties are read-only. CIL1609 The list of parents cannot be returned for the {object path or object ID} object because the object is not a fileable object. Explanation: Versioning is disabled for the specified document type. Explanation: No additional explanation is required. CIL1603 The object cannot be deleted because it is not a document. the getObjectParents method is not valid. User response: Use the property definition to determine which properties can be modified and which properties are read-only. Explanation: The service can be completed only for the current version of a document. CIL1800 The service cannot be completed because the document type that was specified does not support content streams. right parenthesis ")". see the OASIS CMIS API specification. User response: For more information about updating the contents of a document. User response: Modify the filter to remove the invalid character. User response: Use the object type definition to determine the properties that are available for the object type.". Explanation: No additional explanation is required. CIL1615 The service cannot be completed because one or more specified properties do not exist for the specified object type. ". CIL2001 The contents of the following document cannot be updated because a content stream already exists and the overwriteFlag parameter is set to false: {document path or document ID} Explanation: The following characters are not valid: space " ".".log file is in the WAS_profile_location/logs/server/logs subdirectory of the WebSphere Application Server installation directory. User response: Modify the filter to remove the invalid character. CIL2100 The service cannot be completed because the document is not the current version. Troubleshooting IBM CMIS for FileNet Content Manager 77 . User response: See the WebSphere Application Server SystemOut. see the OASIS CMIS API specification. right parenthesis ")". CIL1900 The service cannot be completed because of a storage problem on the repository. see the OASIS CMIS API specification. CIL1701 The query cannot be completed because the filter contains the following invalid character: {character}. Explanation: No additional explanation is required. Explanation: The value that was specified for the streamId is outside the range of valid streamIds on the content server. CIL1616 The service cannot be completed because the {property name} property does not exist for the specified object type. the SystemOut. Explanation: There is an issue on the repository that prevents objects from being created or updated. For more information about streamIds. Explanation: When the overwriteFlag parameter is set to false. CIL2000 The contents of the document cannot be updated because a content stream already exists and the overwriteFlag parameter is set to false. the content cannot be changed. period. CIL1700 The query cannot be completed because the filter contains an invalid character. Explanation: No additional explanation is required. and apostrophe "'". left parenthesis "(". User response: Specify the current version of the document and try again. double backslash "\\". User response: Use the object type definition to determine the properties that are available for the object type. and apostrophe "'".CIL1614 • CIL2100 CIL1614 The content stream cannot be retrieved because the streamId {stream ID} is not valid. Explanation: The following characters are not valid: space " ". backslash "\". left parenthesis "(". Explanation: When the overwriteFlag parameter is set to false. By default. double backslash "\\".log file for more information about the error that occurred on the repository. backslash "\". ". period. the content cannot be changed. User response: Use the object type definition to determine whether a document type supports content streams. User response: For more information about updating the contents of a document. User response: Specify the streamId of an existing content stream. CIL2104 The {document path or document ID} document cannot be checked out because it is already checked out. User response: If the document is checked out by another user. User response: Specify the current version of the document and try again. User response: If you want to modify the document. Explanation: Only the current version of the object can be moved from one folder into another. Explanation: A newer version of the object exists on the repository. check out the document and try again. CIL2107 The object cannot be moved because it is not the current version. Explanation: No additional explanation is required.CIL2102 • CIL2300 CIL2102 The document cannot be checked in because it is not currently checked out. User response: Specify the current version of the object and try again. User response: If you want to modify the document. Explanation: No additional explanation is required. User response: Specify a different name for the object. Explanation: No additional explanation is required. check out the document and try again. CIL2105 The {document path or document ID} document cannot be checked out because it is not the current version. Use the object type definition to determine the uniqueness requirements for the object type. 78 Planning. CIL2300 The object cannot be updated or created because another object with the same name already exists. you must wait until the user checks the document in. Installing. CIL2200 The object cannot be updated because the object is no longer the current version. and Configuring IBM CMIS for FileNet Content Manager . CIL2103 The {document path or document ID} document cannot be checked in because it is not currently checked out. Explanation: The service can be completed only for the current version of a document. Explanation: No additional explanation is required. CIL2106 The service cannot be completed because the {document path or document ID} document is not the current version. Explanation: The object type requires that each object have a unique name. User response: Specify the current version of the object and try again. User response: Specify the current version of the document and try again. /uninstall.sh v To use the silent uninstallation command. enter . enter . You must manually remove the application from WebSphere Application Server. enter uninstall. Manually remove the deployed IBM CMIS application from WebSphere Application Server. complete the following tasks to complete the uninstallation: © Copyright IBM Corp. enter .sh -s Windows At a command prompt. enter .Removing IBM CMIS for FileNet Content Manager You can use the uninstallation program or the silent uninstallation command to remove IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) from the workstation where the software is installed. 2010. complete the following tasks to complete the uninstallation: 1. Important: When you uninstall IBM CMIS.sh -s Linux At a command prompt. Manually remove any files that were not removed by the uninstallation program./uninstall. 79 .bat -s If you ran the uninstallation program to remove IBM CMIS.sh v To use the silent uninstallation command.bat v To use the silent uninstallation command. 2./uninstall. change to the uninstall directory of the IBM CMIS installation directory and enter one of the following commands: v To use the uninstallation program. change to the uninstall directory of the IBM CMIS installation directory and enter one of the following commands: v To use the uninstallation program. enter uninstall./uninstall. change to the uninstall directory of the IBM CMIS installation directory and enter one of the following commands: v To use the uninstallation program. To uninstall IBM CMIS: Run the uninstallation program: Operating system AIX Command At a command prompt. If you used the silent uninstallation command to remove IBM CMIS. the deployed application is not removed from WebSphere Application Server. Click Services → Policy sets → Application policy sets. d. Click Uninstall. Click Applications → Application Types → WebSphere enterprise applications. to ensure that IBM CMIS was successfully removed from the workstation. the deployed application is not removed from WebSphere Application Server. the application is named fncmis. c. Save your changes to the master configuration. remove the WS-Security policy set from WebSphere Application Server: a. To remove IBM CMIS from WebSphere Application Server: 1. d. Uninstall the application: a. You must manually remove the application from WebSphere Application Server. If you configured IBM CMIS to use WS-Security. On the Uninstall application panel. c. 2. and Configuring IBM CMIS for FileNet Content Manager . Manually remove the deployed IBM CMIS application from WebSphere Application Server. Click Delete. b. 80 Planning. See the fncmis-uninstall. By default. Log in to the WebSphere Application Server administrative console. b. Select the IBM CMIS application. 3. 2. Save your changes to the master configuration. e. “Removing IBM CMIS for FileNet Content Manager from WebSphere Application Server” Removing IBM CMIS for FileNet Content Manager from WebSphere Application Server When you remove the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) software from the workstation.log file in the log subdirectory of the IBM CMIS installation directory. 3. Select the WS-Security policy set. Manually remove any files that were not removed by the uninstallation program. cmis_auth_policyset. click OK. Installing.1. Product documentation The documentation for IBM CMIS is available in HTML format within an accessible information center. The HTML format enables you to view documentation according to the display preferences that are set in your web browser.Accessibility features of IBM CMIS for FileNet Content Manager IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) includes features that make it more accessible to people with disabilities. 2010. © Copyright IBM Corp. The HTML format also supports the use of screen readers and other assistive technologies. you must use the silent installation and silent configuration features. Silent installation and configuration For an accessible version of the IBM CMIS installation and configuration programs. The documentation is also available in PDF format. 81 . and Configuring IBM CMIS for FileNet Content Manager . Installing.82 Planning. program. or service may be used. © Copyright IBM Corp. therefore. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. Changes are periodically made to the information herein. Any functionally equivalent product. For license inquiries regarding double-byte (DBCS) information. program. these changes will be incorporated in new editions of the publication. BUT NOT LIMITED TO. program. IBM may not offer the products. to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd.Notices This information was developed for products and services offered in the U. in writing. However.A. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. The furnishing of this document does not grant you any license to these patents. 2010. or service. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. in writing. program. this statement may not apply to you.A. Yamato-shi Kanagawa 242-8502 Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND. MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. it is the user's responsibility to evaluate and verify the operation of any non-IBM product.S. Consult your local IBM representative for information on the products and services currently available in your area. or service that does not infringe any IBM intellectual property right may be used instead. to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk. NY 10504-1785 U. or service is not intended to state or imply that only that IBM product. Shimotsuruma. contact the IBM Intellectual Property Department in your country or send inquiries. You can send license inquiries. 83 . EITHER EXPRESS OR IMPLIED.S. 1623-14. INCLUDING. THE IMPLIED WARRANTIES OF NON-INFRINGEMENT. Any reference to an IBM product. or features discussed in this document in other countries. services. This information could include technical inaccuracies or typographical errors. IBM may have patents or pending patent applications covering subject matter described in this document. Some states do not allow disclaimer of express or implied warranties in certain transactions. or function of these programs. therefore. Actual results may vary. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. brands. CA 95141-1003 U. compatibility or any other claims related to non-IBM products. some measurements may have been estimated through extrapolation. These examples have not been thoroughly tested under all conditions. and distribute these sample programs in any form without payment to IBM. the examples include the names of individuals. payment of a fee. using. Furthermore. cannot guarantee or imply reliability. 84 Planning. companies.IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Information concerning non-IBM products was obtained from the suppliers of those products. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged. Any performance data contained herein was determined in a controlled environment. and represent goals and objectives only. IBM. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement. marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. This information contains examples of data and reports used in daily business operations. the results obtained in other operating environments may vary significantly. IBM International Program License Agreement or any equivalent agreement between us.S. You may copy. including in some cases. modify. Such information may be available. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice. To illustrate them as completely as possible. subject to appropriate terms and conditions. for the purposes of developing. and Configuring IBM CMIS for FileNet Content Manager . serviceability. COPYRIGHT LICENSE: This information contains sample application programs in source language. Installing. Therefore. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. which illustrate programming techniques on various operating platforms. should contact: IBM Corporation J46A/G4 555 Bailey Avenue San Jose. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance. Users of this document should verify the applicable data for their specific environment.A. and products. All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). including by removing the copyright notice or references to OASIS. The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES. except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights. the owner and developer of this specification.Portions of this product are: v Copyright © OASIS® 2009. can be obtained from the OASIS TC Administrator. The names "OASIS". in fact. 2010. OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard. OASIS welcomes reference to. EXPRESS OR IMPLIED. in whole or in part. This document and translations of it may be copied and furnished to others. and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared. provided that the above copyright notice and this section are included on all such copies and derivative works. without restriction of any kind. Copies of claims of rights made available for publication and any assurances of licenses to be made available. and distributed. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Notices 85 . All Rights Reserved. and implementation and use of. as set forth in the OASIS IPR Policy. this document itself may not be modified in any way. but disclaims any obligation to do so. INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. or that any claims in such list are. to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. The full Policy may be found at the OASIS website. neither does it represent that it has made any effort to identify any such rights. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete. and should be used only to refer to the organization and its official outputs. or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard. published. copied. OASIS may include such claims on its website. Essential Claims. “CMIS” are trademarks of OASIS. OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available. must be followed) or as required to translate it into languages other than English. However. specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance. “Trademarks” Trademarks The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both: http://www.ibm.com/ legal/copytrade.shtml Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries. Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others. 86 Planning, Installing, and Configuring IBM CMIS for FileNet Content Manager Index A accessibility features 81 API OASIS CMIS specification architecture overview 3 55 configuration (continued) planning for (continued) silent configuration 11 silent configuration 27 web application, creating 25 worksheets 8 advanced configuration 15 interactive configuration 9 silent configuration 11 configuration tool deployment 47 controlled vocabulary lists security, support for 7 CVLs security, support for 7 GZIP compression See extensions H hardware requirements IBM CMIS 5 C ChoiceListDisplayName See extensions ChoiceListSymbolicName See extensions ClassDisplayName See extensions CMIS LTPA, configuring 36 SSO LTPA, configuring 36 SSO, configuring 35 CMIS APIs developing with 53 best practices 63 CMIS client APIs resources 55 collecting data IBM CMIS 67 collecting troubleshooting data 67 configuration advanced properties 30 buffer length 33 checkout_copycontent 34 CMC_TIME_TO_LIVE 31 cmisURI 33 CRC_TIME_TO_LIVE 31 CVL_Cache 32 defaultMaxItems 34 filterHiddenProperties 32 queryTimeLimit 34 SecureMetadataCache 35 configuration tool 25 IBM CMIS 25 advanced properties 30 buffer length 33 checkout_copycontent 34 CMC_TIME_TO_LIVE 31 cmisURI 33 configuration tool 25 CRC_TIME_TO_LIVE 31 CVL_Cache 32 defaultMaxItems 34 filterHiddenProperties 32 queryTimeLimit 34 SecureMetadataCache 35 web application 25 logging 39 log location 41 log size 41 planning for 8 advanced configuration 15 interactive configuration 9 © Copyright IBM Corp. 2010, I IBM CMIS 1, 8, 9, 11 accessibility features 81 architecture overview 3 behaviors 59 error messages 69 extensions 56 choice list display name 57 choice list symbolic name 57 ChoiceListDisplayName 57 ChoiceListSymbolicName 57 class display name 56 ClassDisplayName 56 domain name 57 DomainName 57 GZIP compression 59 hidden properties 57 isHidden 57 object store database type 58 object store ID 58 ObjectStoreDBType 58 ObjectStoreID 58 records management extension 58 RecordsManagementEnabled 58 text search engine 59 TextSearchEngine 59 index page 53 service collection URLs 54 URI templates 55 language support 7 limitations 59 cmis:changeToken property 60 cmis:checkinComment property 63 paging of feeds 61 private working copy links 60 queries 61 log files 65 planning for 5 prerequisites 5 removing 79 deployed application 80 service documents 53 service collection URLs 54 URI templates 55 troubleshooting 65 uninstalling 79 IBM CMIS implementations 59 cmis:changeToken property 60 cmis:checkinComment property 63 paging of feeds 61 D deploying 47 deployment configuration tool 47 IBM CMIS 47 IBM CMIS application 47 manual deployment 50 silent configuration 48 manual deployment 50, 51 generic JVM arguments 50 policy sets 51 silent configuration 48 DomainName See extensions E error messages 69 extensions 56 choice list display name 57 choice list symbolic name 57 ChoiceListDisplayName 57 ChoiceListSymbolicName 57 class display name 56 ClassDisplayName 56 domain name 57 DomainName 57 GZIP compression 59 hidden properties 57 isHidden 57 object store database type 58 object store ID 58 ObjectStoreDBType 58 ObjectStoreID 58 records management extension 58 RecordsManagementEnabled 58 text search engine 59 TextSearchEngine 59 G generic JVM arguments manual deployment 50 87 IBM CMIS implementations (continued) private working copy links 60 queries 61 IBM CMIS, configuring 25 advanced properties 30 buffer length 33 checkout_copycontent 34 CMC_TIME_TO_LIVE 31 cmisURI 33 CRC_TIME_TO_LIVE 31 CVL_Cache 32 defaultMaxItems 34 filterHiddenProperties 32 queryTimeLimit 34 SecureMetadataCache 35 configuration tool 25 log location 41 log size 41 logging 39 silent configuration 27 web application 25 IBM CMIS, installing 19 Content Engine Client files 22 installation program 20 silent installation 21 software 19 index page 53 service collection URLs 54 URI templates 55 installation Content Engine Client files 22 IBM CMIS 19 IBM CMIS installation program 20 IBM CMIS software 19 IBM CMISsilent installation 21 planning for 8 interactive installation 9 silent installation 11 worksheets 8 interactive installation 9 silent installation 11 interactive configuration planning for 9 worksheets 9 interactive installation planning for 9 worksheets 9 isHidden See extensions logging (continued) Content Engine API client logging 43 log location 41 log size 41 Log4J 43 logged errors 42 WebSphere Application Server logging levels 40 LTPA configuring 36 key, exporting 37 key, generating 36 key, importing 37 LTPA key exporting 37 generating 36 importing 37 M manual deployment 51 security planning for 6 server configuration 6 server topology 6 service documents 53 service collection URLs URI templates 55 silent configuration deployment 48 planning for 11 worksheets 11 silent installation planning for 11 worksheets 11 Single sign-on (SSO) configuring 35 software requirements IBM CMIS 5 supported languages IBM CMIS 7 54 T TextSearchEngine See extensions troubleshooting collecting data IBM CMIS 67 error messages 69 IBM CMIS 65 error messages 69 log files 65 log files 65 O OASIS CMIS resources 55 OASIS CMIS APIs developing with 53 best practices 63 OASIS CMIS specification 55 object types controlled vocabulary lists security, support for 7 CVLs security, support for 7 ObjectStoreDBType See extensions ObjectStoreID See extensions U uninstallation 79 user authentication planning for 6 P planning for 8, 9, 11 policy sets manual deployment WS-Security 51 prerequisites IBM CMIS 5 51 W web application, creating 25 configuration tool 25 WebSphere Application Server planning for 5 WebSphere Application Server Network Deployment planning for 5 worksheets advanced configuration 15 configuration 8 installation 8 interactive configuration 9 interactive installation 9 silent configuration 11 silent installation 11 L languages IBM CMIS 7 LDAP configuring 38 limitations cmis:changeToken property 60 cmis:checkinComment property 63 paging of feeds 61 private working copy links 60 queries 61 log files 65 log4j.properties 43 sample 43 logging configuring 39 R RecordsManagementEnabled See extensions removing deployed application 80 resources CMIS client APIs 55 OASIS CMIS 55 S samples log4j.properties 43 88 Planning, Installing, and Configuring IBM CMIS for FileNet Content Manager . Program Number: 5724-R81 SC19-3220-00 .
Copyright © 2024 DOKUMEN.SITE Inc.