Planning for IBM ECM CMIS

About this task

Procedure

  1. Ensure you have the prerequisites.
    The prerequisites that you must install depend on the type of web application server that you are deploying IBM ECM CMIS on, the database you are using, and the type of repositories that you are connecting to. In your environment, you must have the following:
    • A supported content management server and any required components for that server
    • A supported database server where you can create a database for IBM ECM CMIS
    • A supported web application server where you can deploy IBM ECM CMIS
    Important: If you plan to connect to IBM CMIS for Content Manager OnDemand repositories, you must also install the IBM Content Manager OnDemand Web Enablement Kit (ODWEK) on the web application server.

    If your IBM CMIS for Content Manager OnDemand repository includes APF documents, then you must also install the AFP2PDF conversion tool, on the web application server.

    If you are installing IBM ECM CMIS on AIX®, Linux, or Linux for System z®, ensure that you install the Eclipse GTK (Gimp Toolkit) libraries for graphical user interfaces on the IBM ECM CMIS server if you plan to use the graphical user interface version of the IBM ECM CMIS Configuration and Deployment Tool.
  2. Ensure you meet the system requirements.

    Use the Software Product Compatibility Reports page to generate a report for supported operating systems, related software, hypervisors, hardware requirements, and detailed system requirements, including component-level details. You can also get support information related to product translations and product end of service.

    Go to the page at Software Product Compatibility Reports to create a high-level report for operating systems, related software, hypervisors, and supported translations. You can also create an in-depth report to get detailed system requirements, hardware requirements, and end of service information. You can search for specific products in all of the report types and reports are generated based on your query values.

    The following report types are the most commonly generated reports from software product compatibility reports:
    • Detailed system requirements: When you select your product version for the detailed system requirements report, you can set a report filter for Operating system platforms, Product components, and Capabilities, including prerequisites and support software. After you view the report, you can save it as a URL to generate anytime or download it as a PDF.
    • Hardware requirements: When you select your product version for the hardware requirements report, you can set a report filter by the Operating system families option. Set the operating system filter by selecting some or all of the operating systems that are supported by your product. After you view the report, you can save it as a URL to generate anytime or download it as a PDF.
    • Translations: You can search for the list of available translations by a specific product or for a list of products that are translated into a specific language. For example, when you select Translations available for a specific product and enter the product and version, you can see a list of the available translations for that product version. After you view the report, you can save it as a URL to generate anytime or download it as a PDF.
    • End of service: The end of service report shows the service window of the products that you specify over an eight-year span. For example, you can find out when your product is scheduled to go out of service.
  3. Plan for your content repository.
    You can use IBM ECM CMIS to connect to the following types of repositories from a single instance:
    • IBM CMIS v1.0 for FileNet Content Manager
    • IBM CMIS v1.1 for FileNet Content Manager
    • IBM CMIS v1.0 for Content Manager
    • IBM CMIS v1.1 for Content Manager
    • IBM CMIS for Content Manager OnDemand
    • IBM FileNet Collaboration Services
    See the following information for planning details: Planning for OASIS Content Management Interoperability Services (CMIS)
  4. Plan for your configuration database.

    IBM ECM CMIS stores configuration data and preferences in a database. You can use an existing database or create a database for the IBM ECM CMIS data. However, you must create the database before you install and configure IBM ECM CMIS.

    If you choose to reuse an existing database, it is recommended that you:
    • Create a separate schema for IBM ECM CMIS to use
    • Create a separate user for IBM ECM CMIS to use

    Oracle Database only: A schema is equivalent to a user. Creating a new schema will result in a new user being created.

    Restriction: Keep in mind the following restrictions when you plan for your configuration database:
    • FileNet P8: Do not use the global configuration database to store IBM ECM CMIS data.
    • If you plan to use IBM ECM CMIS to connect to multiple types of repositories, such as IBM CMIS for Content Manager and IBM CMIS for Content Manager OnDemand, do not use a database that is used by either repository. If either repository is down for backups, upgrades, and so on, it can affect the users of the other repository.

    You can use any of the supported database types for your IBM ECM CMIS configuration database, regardless of the type of database that your content repository uses. However, you can reuse your content repository database to store your IBM ECM CMIS configuration data.

    Work with the database administrator to collect the information that is listed in the database worksheet for your database server type. Enter the values into the worksheet so that you can easily provide that information when required.

    Capacity planning for the configuration database: For each desktop that a user has, one row in the table is used, with a maximum of 32 KB per row. A general rule for initially sizing the database is 32 KB multiplied by the number of users, which is multiplied by the average number of desktops that each user will use.

    User accounts for the configuration database: To create the IBM ECM CMIS configuration table on the database that you create, you must have user accounts with specific privileges. In addition, you might need additional privileges if you plan to run the script to build and configure your database from the IBM ECM CMIS Configuration and Deployment Tool.

  5. Plan for your web application server.

    IBM® ECM CMIS 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 following table shows which web applications are supported on each web application server. Ensure that you are running a supported version of your web application server.

    Table 1. Web applications supported on each web application server
    Repository Type IBM WebSphere® Application Server Version 8.5.5 IBM WebSphere Application Server Version 9 Oracle WebLogic Server 12 or later
    IBM CMIS for Content Manager X X  
    IBM CMIS for Content Manager OnDemand X X X
    IBM CMIS for FileNet Content Manager X X X
    IBM FileNet Collaboration Services X X  

    If you use IBM CMIS for Content Manager or IBM CMIS for FileNet Content Manager repositories, you must deploy IBM ECM CMIS on the same type of web application server as your repository, including the version.

    You can use one instance of IBM ECM CMIS to interact with all the supported repositories, or you can use separate instances for each repository.

    Memory requirements: You must have sufficient memory in the Java virtual machine (JVM) in the web application server where you plan install and deploy IBM ECM CMIS:
    • If you are deploying to WebSphere Application Server, you must increase the JVM minimum heap size on the web application server to at least 1 GB or, preferably, to 2 GB. This setting prevents the web application server from hanging when deploying IBM ECM CMIS.
    • If you are deploying to WebSphere Application Server Network Deployment, you must increase the JVM minimum heap size on the deployment manager to at least 1 GB or, preferably, to 2 GB. This setting prevents the web application server from hanging or running out of memory when deploying IBM ECM CMIS.
    • If you are deploying to Oracle WebLogic Server, you must set the memory arguments (MEM_ARGS) parameter to at least 1 GB or, preferably, to 2 GB. This prevents the web application server from running out of memory when deploying IBM ECM CMIS.

    Application server administrative security requirements: IBM ECM CMIS supports or requires application server administrative security. Additionally, the IBM ECM CMIS Configuration and Deployment Tool requires you to specify the name and password of a web application server administrator to connect to your web application server.

    Restriction: IBM CMIS for Content Manager OnDemand uses application managed authentication and does not work when application server administrative security is enabled. You must disable administrative security after you deploy IBM CMIS for Content Manager OnDemand and before you use IBM CMIS for Content Manager OnDemand to connect to your repository.

  6. Planning for security This information applies to both IBM ECM CMIS and IBM Content Navigator.
  7. Language support for IBM Content Navigator This information applies to both IBM ECM CMIS and IBM Content Navigator.