IBM Content Manager OnDemand Guide

IBM Content Manager OnDemand Guide

Released October 2015
Publisher(s): IBM Redbooks
ISBN: 9780738440958

Read it now on the O’Reilly learning platform with a 10-day free trial.

O’Reilly members get unlimited access to books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial

Book description

This IBM® Redbooks® publication provides a practical guide to the design, installation, configuration, and maintenance of IBM Content Manager OnDemand Version 9.5.

Content Manager OnDemand manages the high-volume storage and retrieval of electronic statements and provides efficient enterprise report management. Content Manager OnDemand transforms formatted computer output and printed reports, such as statements and invoices, into electronic information for easy report management. Content Manager OnDemand helps eliminate costly, high-volume print output by capturing, indexing, archiving, and presenting electronic information for improved customer service.

This publication covers the key areas of Content Manager OnDemand, some of which might not be known to the Content Manager OnDemand community or are misunderstood. The book covers various topics, including basic information in administration, database structure, storage management, and security. In addition, the book covers data indexing, loading, conversion, and expiration. Other topics include user exits, performance, retention management, records management, and many more.

Because many other resources are available that address subjects on different platforms, this publication is not intended as a comprehensive guide for Content Manager OnDemand. Rather, it is intended to complement the existing Content Manager OnDemand documentation and provide insight into the issues that might be encountered in the setup and use of Content Manager OnDemand. This book is intended for individuals who need to design, install, configure, and maintain Content Manager OnDemand.

Table of contents

  1. Front cover
  2. Notices
    1. Trademarks
  3. IBM Redbooks promotions
  4. Preface
    1. Authors
    2. Now you can become a published author, too!
    3. Comments welcome
    4. Stay connected to IBM Redbooks
  5. Summary of changes
    1. October 2015, Fifth Edition
  6. Part 1 Basic system concepts and design
  7. Chapter 1. Overview and concepts
    1. 1.1 Overview of Content Manager OnDemand
    2. 1.2 Content Manager OnDemand concepts
      1. 1.2.1 Background information of an example company
      2. 1.2.2 Reports and documents
      3. 1.2.3 Application, application group, folder, and cabinet
      4. 1.2.4 Indexing methods
    3. 1.3 Content Manager OnDemand server and its components
      1. 1.3.1 Library server and object server
      2. 1.3.2 Content Manager OnDemand server components
  8. enChoice
  9. Chapter 2. Setting up a Content Manager OnDemand instance
    1. 2.1 Introduction
    2. 2.2 Architecture and platform
      1. 2.2.1 Configuration consideration
      2. 2.2.2 Library server and object server functions
      3. 2.2.3 Choosing a platform
    3. 2.3 Implementing a Content Manager OnDemand instance on a multiplatform UNIX environment
      1. 2.3.1 Defining a single instance
      2. 2.3.2 Starting and connecting to the new instance
    4. 2.4 Implementing a Content Manager OnDemand instance on IBM i
      1. 2.4.1 Configuring the instance
      2. 2.4.2 Changing an instance configuration
      3. 2.4.3 Starting and stopping servers
    5. 2.5 Implementing a Content Manager OnDemand instance on z/OS
      1. 2.5.1 Installation overview
      2. 2.5.2 Creating an instance on z/OS
      3. 2.5.3 Starting and verifying the new instance
  10. Chapter 3. Administration
    1. 3.1 Report administration
      1. 3.1.1 Storage sets
      2. 3.1.2 Application groups
      3. 3.1.3 Applications
      4. 3.1.4 Folders
      5. 3.1.5 Cabinets
      6. 3.1.6 The report wizard
    2. 3.2 User and group administration
      1. 3.2.1 User types, authorities, and functions
      2. 3.2.2 System administration
    3. 3.3 Content Manager OnDemand XML Batch Administration
      1. 3.3.1 Using the XML Batch Administration program
      2. 3.3.2 Special features of the XML batch program
      3. 3.3.3 Tips on using the ARSXML command
  11. Chapter 4. Database structure
    1. 4.1 System control tables
    2. 4.2 Main data table structures
    3. 4.3 Relationship between tables when data is loaded
    4. 4.4 Search sequence
    5. 4.5 System log
    6. 4.6 Database creation and relationships on z/OS
      1. 4.6.1 System tables for Content Manager OnDemand z/OS
      2. 4.6.2 Data tables for Content Manager OnDemand z/OS
  12. Chapter 5. Storage management
    1. 5.1 Content Manager OnDemand cache storage
    2. 5.2 IBM Tivoli Storage Manager for Multiplatforms
      1. 5.2.1 Tivoli Storage Manager overview
      2. 5.2.2 Configuring Content Manager OnDemand for Tivoli Storage Manager archive management
      3. 5.2.3 Content Manager OnDemand storage management
      4. 5.2.4 Storage set definition
      5. 5.2.5 Application group storage management
      6. 5.2.6 Advanced application group storage management
      7. 5.2.7 IBM System Storage Archive Manager
      8. 5.2.8 The arsmaint command
    3. 5.3 Object access method for z/OS
      1. 5.3.1 OAM components and SMS terminology
      2. 5.3.2 OAM configuration recommendations
      3. 5.3.3 Defining a storage set
      4. 5.3.4 Storing data in Virtual Storage Access Method datasets
    4. 5.4 Archive Storage Manager for IBM i
      1. 5.4.1 Migration policy
      2. 5.4.2 Application group storage management
      3. 5.4.3 Advanced application group storage management
  13. Chapter 6. Security
    1. 6.1 Content Manager OnDemand security overview
    2. 6.2 Code security
      1. 6.2.1 Controlled environment
      2. 6.2.2 Code scanning
      3. 6.2.3 Quality assurance testing
    3. 6.3 Data separation
      1. 6.3.1 Multiple systems
      2. 6.3.2 Multiple object servers
      3. 6.3.3 Multiple archive servers
    4. 6.4 API access
    5. 6.5 Data security
      1. 6.5.1 Content Manager OnDemand object-owner model
      2. 6.5.2 Administrative features
      3. 6.5.3 SQL macro support
      4. 6.5.4 Annotations security
      5. 6.5.5 Securing access with ARSSTASH and the stash file
    6. 6.6 Data encryption
      1. 6.6.1 Encrypting data at rest
      2. 6.6.2 Encrypting data in motion: Secure communications
    7. 6.7 Security exits
      1. 6.7.1 User security and permissions exits
      2. 6.7.2 Security systems other than SAF (z/OS only)
      3. 6.7.3 Unified logon exit (ARSPTGN): z/OS only
      4. 6.7.4 System log user exit
    8. 6.8 Summary
  14. Part 2 Data indexing, loading, retrieval, and expiration
  15. Chapter 7. Indexing and loading
    1. 7.1 Introduction
      1. 7.1.1 Loading and indexing files that were created on another system
      2. 7.1.2 Understanding input data types
      3. 7.1.3 Choosing an indexer
    2. 7.2 Getting started with PDF indexing
      1. 7.2.1 Limitations
    3. 7.3 Performance considerations
      1. 7.3.1 PDF fonts and output file size
      2. 7.3.2 Reducing output file size with PDF documents
      3. 7.3.3 PDF indexing: Using PDF metadata
      4. 7.3.4 PDF indexing: Using the report wizard (graphical indexer)
      5. 7.3.5 PDF indexing: Using internal indexes (Page Piece Dictionary)
    4. 7.4 Getting started with ACIF indexing
      1. 7.4.1 Understanding the input data
      2. 7.4.2 The index file
      3. 7.4.3 Fully composed AFP input
    5. 7.5 OS/390 indexer on z/OS and AIX
    6. 7.6 OS/400 indexer on Content Manager OnDemand on IBM i
    7. 7.7 Getting started with XML Indexing
    8. 7.8 User exits
    9. 7.9 Additional references
  16. Chapter 8. User clients
    1. 8.1 Choosing the correct client for your implementation
      1. 8.1.1 Viewer options
      2. 8.1.2 Client infrastructure options
      3. 8.1.3 Client compatibility
    2. 8.2 Content Manager OnDemand Client options
      1. 8.2.1 IBM Content Navigator
      2. 8.2.2 Content Manager OnDemand Windows client
      3. 8.2.3 CICS Client
      4. 8.2.4 Integration with other Enterprise Content Manager products
      5. 8.2.5 Federated search with IBM Information Integrator
      6. 8.2.6 Integration with IBM FileNet P8
    3. 8.3 Client API overview
      1. 8.3.1 Content Manager OnDemand Web Enablement Kit
      2. 8.3.2 Content Management Interoperability Services
      3. 8.3.3 Other client-based API options
  17. Chapter 9. Data conversion
    1. 9.1 Overview of data conversion
      1. 9.1.1 Why convert data streams
      2. 9.1.2 When to convert data streams
      3. 9.1.3 How to convert the data
    2. 9.2 Generic Transform Interface
      1. 9.2.1 Overview
      2. 9.2.2 Configuration
      3. 9.2.3 Basic implementation: Executable interface
      4. 9.2.4 V9.5 enhancement: Customizing values that are returned from ODWEK
      5. 9.2.5 V9.5 enhancement: Application Group and Application-specific XML
      6. 9.2.6 Advanced implementation: Custom Java interface
  18. Chapter 10. Migration and expiring data and indexes
    1. 10.1 Introduction
    2. 10.2 Loading and storing the data
      1. 10.2.1 Storing the report (document) data
      2. 10.2.2 Storing the index data
      3. 10.2.3 Storing the resource data
    3. 10.3 Configuring for migration and expiration
      1. 10.3.1 Migrating index data
      2. 10.3.2 Expiring data and indexes
      3. 10.3.3 Expiring document data
      4. 10.3.4 Expiring annotations
    4. 10.4 Reloading data
    5. 10.5 Expiration processing on Multiplatforms and z/OS
      1. 10.5.1 Content Manager OnDemand expiration: ARSMAINT
      2. 10.5.2 Expiring indexes
      3. 10.5.3 Removing documents from the Tivoli Storage Manager archive
      4. 10.5.4 Storage Manager-based expiration (z/OS only)
    6. 10.6 Expiring data on Content Manager OnDemand for i
      1. 10.6.1 Content Manager OnDemand expiration
      2. 10.6.2 Storage Manager expiration
  19. Chapter 11. Exits
    1. 11.1 Introduction to user exits
    2. 11.2 ACIF exits
      1. 11.2.1 New macro for user exits
      2. 11.2.2 Input record exit
      3. 11.2.3 Index record exit
      4. 11.2.4 Output record exit
      5. 11.2.5 Resource exit
      6. 11.2.6 Debugging input user exit programs
    3. 11.3 OS/390 indexer exits
      1. 11.3.1 ANYEXIT exit
      2. 11.3.2 INPEXIT exit
      3. 11.3.3 INDXEXIT exit
    4. 11.4 System administration
      1. 11.4.1 System log exit for Multiplatforms
      2. 11.4.2 System log exit for z/OS
      3. 11.4.3 Print exit for Multiplatforms
    5. 11.5 Customized functions (Multiplatforms and z/OS only)
      1. 11.5.1 User exit header file (arscsxit.h)
      2. 11.5.2 Load exit
      3. 11.5.3 Report specifications archive definition exit
      4. 11.5.4 Table space creation exit
      5. 11.5.5 ARSYSPIN and sample APKACIF exit on z/OS
  20. Part 3 Advanced system concepts and design
  21. Chapter 12. Scalability, reliability, and availability architectures
    1. 12.1 Scalability, reliability, and availability defined
    2. 12.2 Scaling a Content Manager OnDemand system
      1. 12.2.1 Vertical scalability
      2. 12.2.2 Horizontal scalability: Library server
      3. 12.2.3 Horizontal scalability: Multiple object servers
      4. 12.2.4 Horizontal and vertical scalability: Storage manager
      5. 12.2.5 Horizontal scalability: Multiple logical partitions and systems
      6. 12.2.6 Multiple server configuration rules
    3. 12.3 High availability
      1. 12.3.1 Redundant systems: All platforms
      2. 12.3.2 Multiple LPAR sysplex: z/OS
      3. 12.3.3 High availability: IBM i
      4. 12.3.4 Horizontal and vertical scalability summary
  22. Chapter 13. Performance
    1. 13.1 Tuning Content Manager OnDemand to enhance performance
      1. 13.1.1 Content Manager OnDemand configuration
      2. 13.1.2 System logging
      3. 13.1.3 System management
      4. 13.1.4 Storage management
    2. 13.2 Data loading performance
      1. 13.2.1 Factors that affect the load performance
      2. 13.2.2 Recommendations
      3. 13.2.3 Load testing
    3. 13.3 Data retrieval performance
      1. 13.3.1 Data retrieval parameters
      2. 13.3.2 Factors that affect retrieval performance
      3. 13.3.3 Retrieval testing
      4. 13.3.4 System testing
    4. 13.4 Performance issues that are based on data type
      1. 13.4.1 PDF data
      2. 13.4.2 Line data
      3. 13.4.3 AFP data
      4. 13.4.4 Image data
  23. Part 4 Enhancement options
  24. Chapter 14. Report distribution
    1. 14.1 Introduction to Content Manager OnDemand Distribution Facility
      1. 14.1.1 What documents are needed
      2. 14.1.2 Who receives the documents
      3. 14.1.3 When the documents are retrieved and delivered
      4. 14.1.4 Where are they delivered
      5. 14.1.5 Cross-platform access
    2. 14.2 Defining the objects with the Administrator Client
      1. 14.2.1 Adding a recipient
      2. 14.2.2 Adding a recipient list
      3. 14.2.3 Adding a report ID
      4. 14.2.4 Adding a distribution
      5. 14.2.5 Adding a report bundle
    3. 14.3 Defining the objects by using batch administration
      1. 14.3.1 Recipient
      2. 14.3.2 Report ID
      3. 14.3.3 Distribution and report bundle
    4. 14.4 Customizable user exits
      1. 14.4.1 arsodfxa: Spool file dataset allocation attributes exit
      2. 14.4.2 arsodfxb: Banner, header, and trailer exit
      3. 14.4.3 arsodfxm: Bundle manifest exit
      4. 14.4.4 ODFProcessDist.java: Processed distribution exit
    5. 14.5 Status and monitor tool
  25. Chapter 15. Full text search
    1. 15.1 Introduction to full text search in Content Manager OnDemand
    2. 15.2 Full text search architecture in Content Manager OnDemand
      1. 15.2.1 Full Text Search Server
      2. 15.2.2 Index structure
      3. 15.2.3 Indexing document through FTS Exporter
      4. 15.2.4 Searching
    3. 15.3 Planning and installing FTS
      1. 15.3.1 Component overview
      2. 15.3.2 Installing the FTS Server
      3. 15.3.3 Operating system resources
      4. 15.3.4 Workload
      5. 15.3.5 Memory heap size
      6. 15.3.6 Index considerations
    4. 15.4 Configuring and operating full text search
      1. 15.4.1 Base configuration in Content Manager OnDemand
      2. 15.4.2 Configuration of the Full Text Search Exporter
    5. 15.5 Running the full text indexing process
      1. 15.5.1 Automatically indexing new data during the load
      2. 15.5.2 Indexing existing data through the arsdoc command
      3. 15.5.3 Indexing existing data through ODWEK
      4. 15.5.4 Running the FTS Exporter
    6. 15.6 Using full text search in Content Manager OnDemand clients
      1. 15.6.1 Syntax
      2. 15.6.2 Boolean searches
      3. 15.6.3 Wildcard searches and optional terms
      4. 15.6.4 Fuzzy and proximity searches
      5. 15.6.5 Weighted searches (boosting terms)
    7. 15.7 Troubleshooting tips
      1. 15.7.1 Content Manager OnDemand server log
      2. 15.7.2 Full Text Search Server log
      3. 15.7.3 Full Text Search Exporter trace
      4. 15.7.4 Authentication and FTS Exporter errors
  26. Chapter 16. Enhanced Retention Management
    1. 16.1 Enhanced Retention Management overview
    2. 16.2 Configuring Enhanced Retention Management
      1. 16.2.1 Enabling Enhanced Retention Management
      2. 16.2.2 Identify the application groups
      3. 16.2.3 Specify the application group lockdown field
      4. 16.2.4 Enabling hold permission for the application group
      5. 16.2.5 Assigning hold permissions to users
      6. 16.2.6 Creating holds by using the Administrator Client
      7. 16.2.7 Configuring a folder to display that a document is held
    3. 16.3 Applying and releasing holds
      1. 16.3.1 Managing holds
      2. 16.3.2 Applying holds
      3. 16.3.3 Creating and removing custom holds
      4. 16.3.4 Search for hold documents
    4. 16.4 Enhanced Retention Management use cases
      1. 16.4.1 Ad hoc holds
      2. 16.4.2 Load holds
  27. Chapter 17. Content Federation Services for Content Manager OnDemand and IBM Enterprise Records
    1. 17.1 Content Federation Services for Content Manager OnDemand and IBM Enterprise Records overview
    2. 17.2 Administration of Content Federation Services for Content Manager OnDemand for Enterprise Records
      1. 17.2.1 Enabling Content Federation Services for Content Manager OnDemand
      2. 17.2.2 Identify the application groups where Content Federation will be enabled
      3. 17.2.3 Specifying the application group field
      4. 17.2.4 Enable Content Federation permissions for the application group
      5. 17.2.5 Federating document metadata to Content Federation Services for Content Manager OnDemand
    3. 17.3 Content Federation Services for Content Manager OnDemand architecture
    4. 17.4 Deployment considerations
  28. Part 5 Troubleshooting, hints, and techniques
  29. Chapter 18. Troubleshooting and tracing
    1. 18.1 Troubleshooting common problems
      1. 18.1.1 Client issues
      2. 18.1.2 Indexing and loading issues
      3. 18.1.3 Content Manager OnDemand maintenance issues
      4. 18.1.4 Monitoring the main server task arssockd
      5. 18.1.5 Installation and migration issues
      6. 18.1.6 Common server messages
    2. 18.2 Information collection
      1. 18.2.1 Indexing or loading
      2. 18.2.2 Database
      3. 18.2.3 Tivoli Storage Manager
      4. 18.2.4 Content Manager OnDemand Client logon
      5. 18.2.5 Performance
      6. 18.2.6 ODWEK
      7. 18.2.7 Content Manager OnDemand server hangs or crashes
      8. 18.2.8 Exporting information to a local server
    3. 18.3 Content Manager OnDemand trace facility
      1. 18.3.1 Enabling the trace facility
      2. 18.3.2 Setting trace parameters
    4. 18.4 Other tracing options
      1. 18.4.1 ARSLOAD
      2. 18.4.2 MidServer trace (z/OS only)
      3. 18.4.3 ODWEK trace
      4. 18.4.4 TCP/IP packet trace
      5. 18.4.5 Language Environment (z/OS only)
      6. 18.4.6 ARSSUPPORT utility
      7. 18.4.7 ARSJESD
      8. 18.4.8 PDF Indexer trace
      9. 18.4.9 Trace resolver
      10. 18.4.10 Conclusion
  30. Related publications
    1. IBM Redbooks
    2. Other publications
    3. Online resources
    4. Help from IBM
  31. Back cover

Product information

  • Title: IBM Content Manager OnDemand Guide
  • Author(s):
  • Release date: October 2015
  • Publisher(s): IBM Redbooks
  • ISBN: 9780738440958