Mastering IBM CMOD for RedHat Linux and Windows 11 Servers: Effortlessly Streamline Your Content Management by Deploying IBM CMOD with IBM Content Navigator and Filenet Fixed Content Device for Red Hat Linux and Windows Platforms (English Edition)

Mastering IBM CMOD

for RedHat Linux and

Windows 11 Servers

Effortlessly Streamline Your Content

Management by Deploying IBM CMOD With

IBM Content Navigator and Filenet Fixed

Content Device for Red Hat Linux and

Windows Platforms

Alan S. Bluck

www.orangeava.com

Copyright © 2024 Orange Education Pvt Ltd, AVA™

All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.

Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author nor Orange Education Pvt Ltd or its dealers and distributors, will be held liable for any damages caused or alleged to have been caused directly or indirectly by this book.

Orange Education Pvt Ltd has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capital. However, Orange Education Pvt Ltd cannot guarantee the accuracy of this information. The use of general descriptive names, registered names, trademarks, service marks, etc. in this publication does not imply, even in the absence of a specific statement, that such names are exempt from the relevant protective laws and regulations and therefore free for general use.

First Published: October 2024

Published by: Orange Education Pvt Ltd, AVA™

Address: 9, Daryaganj, Delhi, 110002, India

275 New North Road Islington Suite 1314 London,

N1 7AA, United Kingdom

ISBN (PBK): 978-81-97953-44-6

ISBN (E-BOOK): 978-81-97953-46-0

Scan the QR code to explore our entire catalogue

www.orangeava.com

Dedicated To

My Beloved Wife, Jenny

My Children, Julie and Rosalie

and

Their Families

About the Author

Alan S. Bluck is the Director of ASB Software Development Limited and also provides consultancy as a systems architect. He offers a broad range of services, from high-level technical design to mentoring for code development and installation and configuration of IBM FileNet’s core products. He is also a member of the Association of Computing Machinery (ACM), the British Computer Society (MBCS), an IBM Silver Level PartnerWorld Business Partner, and a RedHat Accredited Business Partner.

Nominated as an IBM Champion in 2022 and re-elected in 2023 and 2024, Alan has published six technical books and 40 ResearchGate papers, all available for free download.

He is responsible for high-level analysis and configuration of both existing and new IBM FileNet systems, mentoring and troubleshooting high-level systems and issues, and ensuring that scheduled timelines are maintained and deadlines are met.

With over 45 years of software development experience in both business and scientific systems, Alan has 5 years of experience as a Project Manager/Analyst Developer, 11 years as a Software Development Manager for a team of 12 software engineers, 11 years as a Technical Consultant, and 20 years as a Solutions Architect.

About the Technical Reviewer

Gil Metcalf has had a long and varied career, initially qualifying as an industrial microbiologist, working for an oil company on projects relating to microbial mining of heavy metals as well as enhanced oil recovery from spent wells.

After working as an industrial microbiologist, Gil spent several years at a major pharmaceutical company, where he held roles such as project manager, development team leader, and network administrator. During this time, he developed software for clinical trials management and hospital tools for cancer patient care.

As a solutions architect, Gil has gained extensive experience across financial technologies, manufacturing, logistics, and energy sectors. His expertise covers document management, case management, business process automation, identity management, and online banking technologies.

Renowned in the industry, Gil has collaborated with leading banks and institutions, solving complex challenges with innovative solutions. For the past 10 years, he has focused on fintech, designing and implementing solutions for blue-chip enterprises. He holds multiple qualifications in document management, business automation, and identity management, recently specializing in profile management and passwordless authentication for mobile banking.

Gil believes that successful software architecture requires both technical expertise and strong soft skills, including explaining complex concepts to non-technical audiences, understanding the big picture, and refining vague requirements.

He says that preparing for solution design is often an exercise in extrapolation and interpolation at the same time!.

He is a member of several professional associations, including the Chartered Institute for IT, the Identity Management Institute, and the International Association for Software Architects.

Acknowledgements

There are a few people I want to thank for their continued and ongoing support while I wrote this book. First and foremost, I would like to thank my wife, Jenny, for continuously encouraging me to write the book — I could never have completed this book without her support.

I would also like to thank my son-in-law, Dr. Chris Howles, for his advice and encouragement.

I am grateful for the support of the ResearchGate website, which has hosted over 30 of my free publications since 2019, many of which are referenced in this book.

I extend my gratitude to the team at AVA Orange for their support and dedication, allowing me to publish this book in such a short time and update the material during the production process as well as for their invaluable advice.

Lastly, I would like to thank Gil Metcalf, the technical reviewer of this book, for his diligence and helpful suggestions.

Preface

This book provides ab initio step-by-step instructions for the installation and configuration of IBM Content Manager OnDemand (IBM CMOD) version 10.5.0.7.

The configuration covers the integration of IBM Content Manager OnDemand with IBM Content Navigator and IBM FileNet Content Engine. IBM CMOD is the leading data archiving and retrieval system on the global market.

Additionally, the book includes working examples of the Java API using the ODApi.jar and covers the OnDemand Web Enablement Kit (ODWEK) installation for web development.

The book also describes the Windows Client IBM CMOD installation and details the search and download of Base and Fix Pack from IBM’s Software Catalog and Fix Central websites using IBM Download Director software.

This book is divided into 14 chapters and includes 4 appendices. It is designed for Java programmers, IT consultants, and systems and solution architects, with basic IT knowledge. The book provides step-by-step instructions for downloading, installing, and configuring IBM Content Manager OnDemand (CMOD) version 10.5.0.7 as well as the configuration required for integrating IBM Content Manager OnDemand with IBM Content Navigator and IBM FileNet Content Engine. This is useful for developers and installers involved in document management, as well as for implementation in manufacturing industries, banks, and insurance companies.

Chapter 1 covers the purpose and supported platforms of the IBM Content Manager OnDemand software. It describes the available functions and outlines the prerequisites for its integration with IBM FileNet Content Engine and IBM Content Navigator.

Chapter 2 covers the step-by-step download, installation, and configuration of IBM Content Manager OnDemand version 10.5, including the Base and Fix Pack 10.5.0.7 upgrade on a RedHat Linux version 8.8 server running on a VMware virtual system.

Chapter 3 covers the installation and administration of the supporting optional software components, including the Db2 databases, the PDF Indexing feature, the Distribution Facility feature, and the Full Text Search server feature.

Chapter 4 covers the IBM Fix Pack upgrade RPM files and some additional Linux operating system library packages that are required to be installed to support the GSKit for CMOD version 10.5.0.7. This chapter describes their installation and the process of debugging the main arssockd program load and run.

Chapter 5 provides step-by-step for downloading, installing, and configuring IBM Content Manager OnDemand version 10.5, including the Base and Fix Pack 10.5.0.7 upgrade on a Windows 11 server, as well as some configuration on the connected Linux server.

Chapter 6 covers the restart of the Linux system server after the upgrade and configuration, including the supporting application systems: the IBM Directory Services (LDAP server), the IBM Db2 (database server), the IBM WebSphere (web application server for IBM FileNet P8 Content Engine), and the IBM Content Navigator (desktop client).

Chapter 7 describes the OnDemand Configurator program V10.5, the OnDemand Client configuration program, the use of the arsxml command on Windows, and the configuration of the system after installing IBM CMOD Fix Pack 10.5.0.7.

Chapter 8 covers the Object Type model and the Object Owner model for decentralizing system administration users, as well as resetting an expired or lost IBM CMOD admin user password on the Linux Db2 server. It also describes the use of the arsstash program for storing encrypted passwords for users.

Chapter 9 lists several example Java programs updated to work with the IBM CMOD OnDemand API and demonstrated running in an Eclipse IDE environment on a Linux server.

Chapter 10 outlines the procedure for creating a repository for the Linux server version of IBM Content Navigator and demonstrates the browse access to the folders on a Windows CMOD server from the Content Navigator desktop created for CMOD.

Chapter 11 describes the network requirements to be checked to successfully run the arssockd program on a Linux server, including the command parameters to use for running and debugging the program. It also covers the use of the IBM OnDemand Full Text Search service, which utilizes the open-source Apache Lucene system, and provides a detailed use of the arsdb database configuration and maintenance program. Additionally, it covers the step-by-step procedure for creating a second Linux IBM CMOD instance, ARCHIVE2.

Chapter 12 covers the purpose and supported platforms of the IBM Content Manager OnDemand arsload software and describes the available functions and prerequisites, including the creation of the System Log and System Load database tables using the arssyscr program. Additionally, it outlines the use of the ARSXML Windows program and the Linux arsxml program to import and export the IBM CMOD Application Groups from XML files and perform XML file validation.

Chapter 13 covers examples of running the ARSLOAD program in both Windows and Linux environments. It describes the Index Fields required for loading documents and explains the use of the ARSSOCKD program to display the list of IBM CMOD program services running on the Windows system. Finally, it covers the use of the arsdoc program to generate the Generic Index Field file used by ARSLOAD.

Chapter 14 demonstrates how to process an AFP input file located in a directory and redirect the line data output to a file using the IBM Content Manager OnDemand ARSXAFP program in both Windows and Linux server environments.

Appendix A covers the download, extraction, and installation of Windows Fix Pack 7 for IBM Content Manager OnDemand, as well as the running of the Windows IBM Configurator program.

Appendix B describes the step-by-step procedure required to remove and re-add an IBM CMOD application group.

Appendix C lists each of the CMOD configuration files and environment settings for the Windows client, Windows server, and Linux server.

Appendix D lists the supporting documentation provided by ResearchGate and other book publications, along with contact details for supporting IBM CMOD integration, developed by ASB Software Development Limited.

Downloading the code

bundles and colored images

Please follow the link or scan the QR code to download the

Code Bundles and Images of the book:

https://github.com/ava-orange-education/Mastering-IBM-CMOD-for-RedHat-Linux-and-Windows-11-Servers

The code bundles and images of the book are also hosted on

https://rebrand.ly/f69543

In case there’s an update to the code, it will be updated on the existing GitHub repository.

Errata

We take immense pride in our work at Orange Education Pvt Ltd and follow best practices to ensure the accuracy of our content to provide an indulging reading experience to our subscribers. Our readers are our mirrors, and we use their inputs to reflect and improve upon human errors, if any, that may have occurred during the publishing processes involved. To let us maintain the quality and help us reach out to any readers who might be having difficulties due to any unforeseen errors, please write to us at :

[email protected]

Your support, suggestions, and feedback are highly appreciated.

DID YOU KNOW

Did you know that Orange Education Pvt Ltd offers eBook versions of every book published, with PDF and ePub files available? You can upgrade to the eBook version at www.orangeava.com and as a print book customer, you are entitled to a discount on the eBook copy. Get in touch with us at: [email protected] for more details.

At www.orangeava.com, you can also read a collection of free technical articles, sign up for a range of free newsletters, and receive exclusive discounts and offers on AVA™ Books and eBooks.

PIRACY

If you come across any illegal copies of our works in any form on the internet, we would be grateful if you would provide us with the location address or website name. Please contact us at [email protected] with a link to the material.

ARE YOU INTERESTED IN AUTHORING WITH US?

If there is a topic that you have expertise in, and you are interested in either writing or contributing to a book, please write to us at [email protected]. We are on a journey to help developers and tech professionals to gain insights on the present technological advancements and innovations happening across the globe and build a community that believes Knowledge is best acquired by sharing and learning with others. Please reach out to us to learn what our audience demands and how you can be part of this educational reform. We also welcome ideas from tech experts and help them build learning and development content for their domains.

REVIEWS

Please leave a review. Once you have read and used this book, why not leave a review on the site that you purchased it from? Potential readers can then see and use your unbiased opinion to make purchase decisions. We at Orange Education would love to know what you think about our products, and our authors can learn from your feedback. Thank you!

For more information about Orange Education, please visit www.orangeava.com.

Table of Contents

1. Introduction to IBM Content Manager OnDemand

Introduction

Structure

Links from IBM and the CMOD Blog Website

Hardware and Software Requirements

Operating System Environment Variable Settings

Required Extensions for IBM FileNet Add-on

Setting Up CFS-CMOD on Windows Server

Creating a Custom Document Class in the Linux IBM FileNet P8 Content Engine

Conclusion

Multiple Choice Questions

Answers

Questions

Key Terms

2. Installing CMOD on Linux Systems

Introduction

Structure

Downloading the Base CMOD Version 10.5 System for Linux

Linux Prerequisites for CMOD Release 10.5

Installing CMOD on RedHat RHEL 8.0 Linux

Installing the Linux GSKit

Installing Apache Zookeeper

Configuring IBM FileNet P8 for a Fixed Content Device Using CMOD

Fix Pack 10.5.0.7 Installation

Older CMOD References

Creating an Instance of Content Manager OnDemand

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

3. Installing Optional CMOD Software on Linux

Introduction

Structure

List of Created Db2 Tables for CMOD in the ARCHIVE Database

Removing a CMOD Db2 Archive Database

Manually Starting and Stopping CMOD Instances

Updating the archive instance ARCHIVE database

Moving the Database Schema from root to archive on Linux

Installing the PDF Indexing Feature

Running the arspdump Program

Installing the Distribution Facility Feature

Installing the Full Text Search Server Feature

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

4. Installing the Upgraded Linux GSKit and Libraries

Introduction

Structure

Installing with the Linux rpm command line tool

Installing with the Linux yum command line tool

Creating the CMOD Cache Data Area(s)

Running the arsstash Encryption Program

Linux – The Method Used for Debugging ARSSOCKD with a Trace Logging File Output

Configuring the LIBPATH, LD_LIBRARY_PATH, and PATH on Linux

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

5. Installing CMOD on Windows Systems

Introduction

Structure

Downloading the Base Installation Program

Downloading the Fix Pack Installation Program

Installing the Fix Pack for the Windows Client

ARCHIVE Database Creation Update Log on Windows

Setting the Db2 ARCHIVE Port 50001 Access on Windows

Creating the IBM FileNet Fixed Content Device Support for IBM Content Manager OnDemand

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

6. Restarting the CMOD System on Linux

Introduction

Structure

Starting the IBM Security Directory Services Server

Starting the Db2 Database Server

Starting the IBM WebSphere Profiles for IBM FileNet P8 Content Engine and IBM FileNet Content Navigator

Starting the Linux CMOD Object Server, the arsobjd Program

Resetting an Expired or Lost CMOD ADMIN User Password on Db2

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

7. CMOD Administration on Windows

Introduction

Structure

Updating the Windows ADMIN Password

Updating the Windows Server Firewall

The OnDemand Client Folder Selection

The OnDemand Configurator Password Load Program Update Option

The OnDemand Configurator V10.5 – Server Instance Creation

The OnDemand Client Configuration

Configuring the System After Installing CMOD Fix Pack 10.5.0.7

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

8. CMOD System User Administration on Linux

Introduction

Structure

The Object Type Model and Object Owner Model for Decentralizing the System Administration

The Object Type Administrative Model

The Object Owner Administrative Model

Resetting an Expired or Lost CMOD ADMIN User Password on Db2

Updating the File Permissions in the Linux System for the Program Binaries

Moving the Database Schema from Root to Archive on Linux

Running the arsstash Program to Encrypt User Passwords

Administration of the CMOD Generic Indexer

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

9. CMOD Java API Examples

Introduction

Structure

ODPing.java Java Source Code and Testing

module-info.java

Run Results for ODPing

Setting the Linux Archive User with IBM FileNet P8 Administrator Permissions

CallbackSearchExample.java Java Source Code and Testing

Run Results for the CallbackSearchExample

Loading a document – TcLoadDocs.java

Logs for the Document Loaded on the Windows Server, DESKTOP-B3JB93R

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

10. Connecting CMOD to IBM Content Navigator

Introduction

Structure

Setting Up the IBM Websphere Classpath

Configuring a New IBM Content Navigator Desktop for IBM CMOD

IBM Content Navigator Desktop After Loading Documents on Windows

arsload Parameters

Another Example of the arsload Program Command Line on Linux

Setting Up a Viewer Map

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

Further References

11. Starting arssockd on the Linux Server

Introduction

Structure

Starting the arssockd Program

Checking to See if IPv6 is Enabled

Checking and Changing the Port Range Limits

Linux Server Start up

Starting the IBM OnDemand Full Text Search Server

Running the arsdb Program and Switch Use

Using arsdb to Create a Second IBM CMOD Instance

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

12. Configuring the arsload Program

Introduction

Structure

Creating the Database System Tables Using arssyscr

Initializing the System Load Logging Facility

Initializing the System Connection Logging Facility

Initializing the System Migration Facility

Creating an Index

Web Enablement Kit Implementation Guide

Setting Up Test Data for the Windows ARSLOAD Program

Starting the First Run

Adding IBM CMOD Application Groups Using arsxml

Exporting an IBM CMOD Application Group

Updating IBM CMOD Application Groups

Exporting All the Users

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

13. Running ARSLOAD

Introduction

Structure

Indexing Fields for the Baxter Bay Credit Application Group

Running the arsdoc Program to Generate the Generic Index field file

Running ARSLOAD on Windows

First Run of ARSLOAD After the Fix Pack 10.5.0.7 Configuration Update

Updating Baxter Bay Credit Application Group Fields

Second Run of the ARSLOAD Program

Third Run Issue with Date

Fourth Run Success with Date Fixed by Editing the .ind file

Running ARSLOAD on Linux

Running ARSSOCKD to Display the Services

CMOD Video Training Link

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

14. Running the ARSXAFP Program on Windows and Linux

Introduction

Structure

ARSXAFP Program Parameter Options

ARSXAFP Command Line Examples

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

APPENDIX A: IBM Content Manager OnDemand Fix Pack Installation

Introduction

Structure

Downloading the CMOD Fix Pack

Linux Server Start Up

First Run of ARSLOAD After Configuration

Updated Fields for Loading

Second Run of the ARSLOAD Program

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

APPENDIX B: Recreating an Application Group

Introduction

Structure

Deleting an Existing Application Group

Creating a New Application Group

Third Run Issue with Date

Fourth Run Success After Editing the Data File

Creating a New Invoices Folder

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

APPENDIX C: List of Configuration Files and Settings

Introduction

Structure

Windows Server Configuration Files

CMOD Environment (OnDemand Command Window)

Linux Configuration Files

To Clean and Reset a RedHat Linux Subscription

To Drop an Active DB2 ARCHIVE Database

Rebuilding the ARCHIVE Database

Setting the WebSphere Data Sources for the IBM FileNet Content Engine Fixed Content Device

Trace Settings

/root/.bash_profile

/home/archive/.bash_profile

ars.cfg Configuration File

ars.ini Configuration File

ars.dbfs Configuration File

ars.cache Configuration File

The Archive First Instance Start, with Settings Listed

ars.archive2.cache Configuration File

ars.archive2.cfg Configuration File

ars.archive2.dbfs Configuration File

The archive2 Second Instance Start, with Settings Listed

Procedure to Reset an ADMIN Password Using the arsadm.exe Program

Conclusion

Points to Remember

Multiple Choice Questions

Answers

Questions

Key Terms

APPENDIX D: ASB Software Development Limited Publications

Introduction

Structure

ResearchGate Publications

Molecular Biology Installations - ASB Software Development Limited Publications

IBM Installations - ASB Software Development Limited Publications

Contact Details

Index

CHAPTER 1

Introduction to IBM Content Manager OnDemand

Introduction

This book provides ab initio step-by-step instructions for the installation and configuration of IBM Content Manager OnDemand (CMOD) version 10.5.0.7.

The configuration covers the integration of IBM Content Manager OnDemand with IBM Content Navigator and IBM FileNet Content Engine. CMOD is the leading data archiving and retrieval system on the world market.

The book also provides working examples of the Java API using the ODApi.jar, and it covers the OnDemand Web Enablement Kit (ODWEK) installation for web development.

Additionally, the Windows Client CMOD installation is described, along with the process of searching and downloading the Base and Fix Pack from IBM’s Software Catalog and Fix Central websites using IBM Download Director software.

IBM describes the purpose of CMOD in detail, which can be accessed through this link:

https://www.ibm.com/support/pages/system/files/support/swg/swgdocs.nsf/0/eeee7450f3eb8e6385257b6e0047cef4/$FILE/IBM%20Content%20Manager%20OnDemand%20Best%20Practices_033015v2.pdf

This introduces the IBM Content Manager OnDemand (CMOD) system as follows:

"IBM® Content Manager OnDemand (CMOD) is the premier data archiving and retrieval system on the global market. CMOD is installed at thousands of customer locations worldwide serving a user base in the millions of users on a daily basis. The CMOD product is extremely scalable and flexible, allowing customers to create customized solutions that best meet their requirements. CMOD provides extremely high performance for loading, retrieving, and expiring of data."

In this chapter, we cover the purpose and supported platforms of the IBM Content Manager OnDemand software and describe the available functions supplied. The chapter outlines the prerequisites for CMODs integration with IBM FileNet Content Engine and IBM Content Navigator.

Structure

In this chapter, we will discuss the following topics:

Links from IBM and the CMOD Blog Website

Hardware and Software Requirements

Operating System Environment Variable Settings

Required Extensions for IBM FileNet Add-on

Setting Up on the Windows Server for CFS-CMOD

Creating a Custom Document Class in the Linux, IBM FileNet P8 Content Engine

Links from IBM and the CMOD Blog Website

The following ResearchGate free download links can be followed to install the supporting software systems for the base system platform for IBM Content Manager OnDemand:

For the user security LDAP server, IBM Security Directory Services 6.4: Installation on RHEL 8.0:

https://doi.org/10.13140/RG.2.2.33527.57761

For the installation of the IBM Database, Db2 10.5 Installation on RHEL 8.0 V1:

https://doi.org/10.13140/RG.2.2.10491.67369

Upgrade of IBM FileNet systems from DB2 10.5 FP 10 to the latest DB2 11.5 version on