Content Manager OnDemand for i


Version 7.1

Common Server Administration Guide

SC19-2792-00
Content Manager OnDemand for i


Version 7.1

Common Server Administration Guide

SC19-2792-00
 Note
Before using this information and the product it supports, read the information in “Notices” on page 277.

This edition applies to version 7, release 1 of IBM Content Manager OnDemand for i and to all subsequent releases
and modifications until otherwise indicated in new editions.
© Copyright International Business Machines Corporation 1991, 2010.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
 Contents
About this guide . . . . . . . . . . vii | Using a Network File System (NFS)
| directory for document storage . . . . 23
Summary of changes . . . . . . . . . xi | Setting up an NFS disk pool . . . . . . . . . 23
| New functions . . . . . . . . . . . . . xi | Example scenario . . . . . . . . . . . . 24
| Command enhancements . . . . . . . . . xiii | On the Storage System (RDR400X). . . . . . 24
| Additional functions added previously and | On the Archive System (RDR400Y) . . . . . 25
| included in OnDemand version 7.1 . . . . . . xiv | Special consideration for UIDs . . . . . . . . 26
| When you upgrade to version 7.1, be aware of the
| following . . . . . . . . . . . . . . . xiv | Using Tivoli Storage Manager . . . . . 27
| Using Tivoli Storage Manager as a separate storage
Database concepts . . . . . . . . . . 1 | manager . . . . . . . . . . . . . . . 27
System . . . . . . . . . . . . . . . . 1 | Hardware prerequisites . . . . . . . . . 27
Instance . . . . . . . . . . . . . . . . 1 | Software prerequisites . . . . . . . . . . 27
Database. . . . . . . . . . . . . . . . 1 | Setting up Tivoli Storage Manager as a separate
Table . . . . . . . . . . . . . . . . . 2 | storage manager . . . . . . . . . . . . 27
Index . . . . . . . . . . . . . . . . . 2 | Use instructions . . . . . . . . . . . . 33
Journals and journal receivers . . . . . . . . 2 | Using Tivoli Storage Manager as an ASM migration
| policy level . . . . . . . . . . . . . . 35
Database maintenance . . . . . . . . 3 | Hardware prerequisites . . . . . . . . . 35
Before you begin . . . . . . . . . . . . . 3 | Software prerequisites . . . . . . . . . . 35
Expiring index data . . . . . . . . . . . . 3 | Setting up Tivoli Storage Manager as an ASM
How to expire index data . . . . . . . . . 5 | migration policy level . . . . . . . . . . 35
Migrating indexes . . . . . . . . . . . . 5 | Use instructions . . . . . . . . . . . . 38
How to migrate indexes . . . . . . . . . 6
Backup and recovery . . . . . . . . 41
Migrating and importing index data . . . 7 Backup considerations . . . . . . . . . . . 41
Configuring the system . . . . . . . . . . . 7 Recovery considerations . . . . . . . . . . 42
System Log messages . . . . . . . . . . 7 Reports . . . . . . . . . . . . . . . . 42
System Log user exit program . . . . . . . 8
Archive Storage Manager . . . . . . . . . 8 Installing the administrative client . . . 45
Storage sets . . . . . . . . . . . . . . 8 Hardware . . . . . . . . . . . . . . . 45
Application groups . . . . . . . . . . . 8 Software . . . . . . . . . . . . . . . 45
What happens when a user queries migrated data . . 9 Memory . . . . . . . . . . . . . . . 45
Message to the user . . . . . . . . . . . 9 Disk space. . . . . . . . . . . . . . . 46
Message to the System Log . . . . . . . . 9 Installing the System i Navigator interface to
Importing index data . . . . . . . . . . . 9 OnDemand . . . . . . . . . . . . . . 46
Run the STRIMPOND command . . . . . . 10 Installing the administrative client . . . . . . . 46
After you import index data . . . . . . . . . 10 Running Setup . . . . . . . . . . . . 47
Expiring imported migrated indexes . . . . . 10 To install on a PC . . . . . . . . . . . 47
Configuring index migration . . . . . . . 10 To install on a network file server . . . . . . 47
To use automated install . . . . . . . . . 47
Document storage . . . . . . . . . . 13 To uninstall . . . . . . . . . . . . . 48
Defining document storage management . . . . 13
Application groups . . . . . . . . . . . 13 About the administrative client . . . . 49
Disk storage manager . . . . . . . . . . 15 Getting started . . . . . . . . . . . . . 50
Archive storage manager . . . . . . . . . 15 Using online help . . . . . . . . . . . 50
Migrating documents . . . . . . . . . . . 15 Adding a server . . . . . . . . . . . . 50
Processes that should not be run simultaneously 17 Logging on a server . . . . . . . . . . 51
Migration processing in the system log . . . . 17 Changing passwords . . . . . . . . . . 51
Removing documents . . . . . . . . . . . 18 System parameters . . . . . . . . . . . . 52
Removing documents from disk storage . . . . 18 Maximum Password Age . . . . . . . . . 52
Removing documents from archive storage . . . 19 Minimum Password Length . . . . . . . . 53
| Eliminating the need to run Disk Storage Inactivity Time Out . . . . . . . . . . . 53
| Manager (DSM) . . . . . . . . . . . . 20 System Logging . . . . . . . . . . . . 54

© Copyright IBM Corp. 1991, 2010 iii

 User Exit Logging . . . . . . . . . . . 54 Examples . . . . . . . . . . . . . . 107
Login Processing . . . . . . . . . . . 54 Adding server printers . . . . . . . . . . 110
| Annotations . . . . . . . . . . . . . 55 Choose a server . . . . . . . . . . . 110
| System Log Comments . . . . . . . . . 56 Two ways to add a server printer. . . . . . 110
| LDAP Authentication . . . . . . . . . . 56 Adding the server printer . . . . . . . . 111
Setting system parameters . . . . . . . . 56 Examples . . . . . . . . . . . . . . 111
Setting trace parameters . . . . . . . . . 58 Adding storage sets . . . . . . . . . . . 112
Adding items to a server . . . . . . . . . . 58 Adding a report . . . . . . . . . . . . 112
New command . . . . . . . . . . . . 59 An example . . . . . . . . . . . . . 113
Copy command . . . . . . . . . . . . 59 Adding a new field to an existing application
Export command . . . . . . . . . . . 59 group/application/folder . . . . . . . . . 142
Drag and drop operation . . . . . . . . . 59 Local server setup for offline administration . . . 142
Report Wizard . . . . . . . . . . . . . 60
Starting the Report Wizard . . . . . . . . 60 Loading spooled file data . . . . . . 145
Using the Report Wizard . . . . . . . . . 61 Overview. . . . . . . . . . . . . . . 145
Preparing to load reports . . . . . . . . . 146
Concepts. . . . . . . . . . . . . . 65 Storage space . . . . . . . . . . . . 146
Migration Policies . . . . . . . . . . . . 65 Defining the application group . . . . . . 146
Monitor Definitions. . . . . . . . . . . . 66 Defining the application . . . . . . . . . 147
Tape devices . . . . . . . . . . . . . . 67 Loading reports . . . . . . . . . . . . 147
Tape volumes. . . . . . . . . . . . . . 67 Running the ADDRPTOND command . . . . 147
Optical storage groups. . . . . . . . . . . 68 Using an output queue monitor . . . . . . 147
Optical volumes . . . . . . . . . . . . . 68 Indexing reports . . . . . . . . . . . 149
Disk pool storage groups . . . . . . . . . . 68 Processing the input data . . . . . . . . . 149
Users . . . . . . . . . . . . . . . . 68 Processing index data . . . . . . . . . 149
User types . . . . . . . . . . . . . . 69 Processing reports and resources . . . . . . 150
Authority . . . . . . . . . . . . . . 70 Loading index data . . . . . . . . . . . 150
Groups . . . . . . . . . . . . . . . . 71 Loading storage objects . . . . . . . . . . 150
Printers. . . . . . . . . . . . . . . . 71 Disk storage . . . . . . . . . . . . . 151
Storage sets . . . . . . . . . . . . . . 72 Archive storage. . . . . . . . . . . . 151
Application groups . . . . . . . . . . . . 72 Resources . . . . . . . . . . . . . 151
Applications . . . . . . . . . . . . . . 73 Verifying processing . . . . . . . . . . . 151
Folders . . . . . . . . . . . . . . . . 73 Backing up databases. . . . . . . . . . . 152
About application groups, applications, and folders 74
OnDemand permissions . . . . . . . . . . 75 Loading image files. . . . . . . . . 155
Folder permissions . . . . . . . . . . . 76 Overview. . . . . . . . . . . . . . . 155
Application group permissions . . . . . . . 76 Defining the application group . . . . . . . 155
Specifying permissions . . . . . . . . . 76 Database Organization . . . . . . . . . 156
Hints and tips . . . . . . . . . . . . . 80 Expiration Type . . . . . . . . . . . 156
Permissions . . . . . . . . . . . . . 156
| LDAP (Lightweight Directory Access Field Definition. . . . . . . . . . . . 156
| Protocol) authentication support . . . 83 Defining the application . . . . . . . . . . 157
Application Group . . . . . . . . . . 157
Examples . . . . . . . . . . . . . 85 Data Format . . . . . . . . . . . . . 157
Indexer . . . . . . . . . . . . . . 157
System configuration . . . . . . . . . . . 86
Data Compression . . . . . . . . . . . 157
Adding tape devices . . . . . . . . . . . 86
Defining the folder . . . . . . . . . . . 158
Adding tape volumes . . . . . . . . . . . 87
Application Group . . . . . . . . . . 158
Creating optical storage groups . . . . . . . . 89
Permissions . . . . . . . . . . . . . 158
Adding optical volumes . . . . . . . . . . 90
Field Definition. . . . . . . . . . . . 158
Creating disk pool storage groups . . . . . . . 91
Field Mapping . . . . . . . . . . . . 158
Creating monitor definitions . . . . . . . . . 92
Accessing the image files . . . . . . . . . 159
Creating migration policies . . . . . . . . . 95
Creating index data . . . . . . . . . . . 159
Adding users . . . . . . . . . . . . . . 97
Configuring the ARSLOAD program . . . . . 160
The basics . . . . . . . . . . . . . . 97
Processing the input data . . . . . . . . . 161
Examples . . . . . . . . . . . . . . 101
Processing index data . . . . . . . . . 161
Adding groups . . . . . . . . . . . . . 105
Processing the image files . . . . . . . . 161
Choose a server . . . . . . . . . . . 106
Verifying processing . . . . . . . . . . 162
Two ways to add a group . . . . . . . . 106
Adding users . . . . . . . . . . . . 106
Adding the group . . . . . . . . . . . 107 Loading user-defined data . . . . . . 163

iv Common Server Administration Guide

 Defining the application group . . . . . . . 164 OnDemand server commands . . . . . . . . 197
Database organization . . . . . . . . . 164 ADDRPTOND . . . . . . . . . . . . 197
Expiration type . . . . . . . . . . . . 164 CHGPLDOND . . . . . . . . . . . . 198
Permissions . . . . . . . . . . . . . 164 | CRTINSTOND . . . . . . . . . . . . 198
Field definition . . . . . . . . . . . . 164 ENDMONOND . . . . . . . . . . . 198
Defining the application . . . . . . . . . . 165 FNDKEYOND . . . . . . . . . . . . 198
Application Group . . . . . . . . . . 165 MGRMEDRDAR . . . . . . . . . . . 198
Data Format . . . . . . . . . . . . . 165 | MRGSPLFOND. . . . . . . . . . . . 199
File Extension . . . . . . . . . . . . 165 PRTRPTOND . . . . . . . . . . . . 199
Indexer . . . . . . . . . . . . . . 166 PRTTXTOND . . . . . . . . . . . . 200
Data Compression . . . . . . . . . . . 166 RMVRPTOND . . . . . . . . . . . . 200
Defining the folder . . . . . . . . . . . 166 STRASMOND . . . . . . . . . . . . 200
Application Group . . . . . . . . . . 166 STRDSMOND . . . . . . . . . . . . 201
Permissions . . . . . . . . . . . . . 166 STRIMPOND . . . . . . . . . . . . 201
Folder fields . . . . . . . . . . . . . 166 STRMONOND . . . . . . . . . . . . 201
Field Mapping . . . . . . . . . . . . 167
Accessing the input files. . . . . . . . . . 167 System log messages. . . . . . . . 203
Creating the index data . . . . . . . . . . 167 Overview. . . . . . . . . . . . . . . 203
Configuring the ARSLOAD program . . . . . 168
Processing the input data . . . . . . . . . 169
5250 host connection to client viewer 205
Processing index data . . . . . . . . . 169
Operational and environmental considerations . . 205
Processing the Lotus WordPro files . . . . . 169
Workstation installation tasks . . . . . . . 205
Verifying processing . . . . . . . . . . 170
Server configuration . . . . . . . . . . 207

Restarting a load process . . . . . . 171

Server printing and faxing . . . . . . 209
Using an IBM i printer file to define server print
Importing and exporting OnDemand parameters . . . . . . . . . . . . . . 209
objects through batch administration . 173 Server fax setup . . . . . . . . . . . . 210
Overview. . . . . . . . . . . . . . . 173
Installing batch system administration . . . . . 173 API and user exit reference . . . . . 213
Prerequisites. . . . . . . . . . . . . 173 API reference . . . . . . . . . . . . . 213
| Configuring Xerces2 Java Parser . . . . . . 174 Using quotes when executing the APIs . . . . 213
Installation verification . . . . . . . . . 174 Using the QSHELL environment . . . . . . 213
Common problems during installation Calling QSHELL commands from an IBM i
verification . . . . . . . . . . . . . 175 command line . . . . . . . . . . . . 214
Importing an XML file into an OnDemand system 176 How to read a syntax diagram . . . . . . 215
Preparing an XML file for the import process 176 ARSDATE . . . . . . . . . . . . . 217
Creating an XML file . . . . . . . . . . 178 ARSDOC . . . . . . . . . . . . . . 221
Importing the XML file by using the ARSXML ARSLOAD . . . . . . . . . . . . . 248
command . . . . . . . . . . . . . 184 ARSXML . . . . . . . . . . . . . . 256
Exporting OnDemand administrative objects to an User exit reference. . . . . . . . . . . . 264
XML file . . . . . . . . . . . . . . . 184 Output queue or directory monitor user exit
program . . . . . . . . . . . . . . 264
Deleting a report . . . . . . . . . . 187 Overview of the monitor . . . . . . . . 265
| How the monitor exit works . . . . . . . 265
Managing the server . . . . . . . . 189 Exit program details . . . . . . . . . . 267
Errors and alerts . . . . . . . . . . . . 189 Facsimile user exit program . . . . . . . 267
System logging facility . . . . . . . . . . 189
Searching for and viewing messages. . . . . 190 Automating ARSLOAD data loading 269
System Log user exit . . . . . . . . . . 191 ARSLOAD . . . . . . . . . . . . . . 269
Monitoring users . . . . . . . . . . . 191 Automating ARSLOAD . . . . . . . . . 269
Generating usage statistics . . . . . . . . 191
| ARSSUPPORT utility . . . . . . . . . . . 192 Alternative to starting the
Finding or changing the server job and its
administrative client . . . . . . . . 271
attributes for a particular instance . . . . . . 193
Starting the Administrator . . . . . . . . . 271
Controlling the run priority of instance server jobs 194
Administrator start up parameters . . . . . 271
| Using OnDemand data areas . . . . . . . . 195
Restarting journaling . . . . . . . . . . . 196
Appendix. Accessibility features . . . 275
Command reference . . . . . . . . 197
Contents v
Notices . . . . . . . . . . . . . . 277 Index . . . . . . . . . . . . . . . 281
Trademarks . . . . . . . . . . . . . . 279

vi Common Server Administration Guide

About this guide
The information in this book can help administrators maintain an IBM® Content
Manager OnDemand for i Common Server Version 7 Release 1 (Content Manager
OnDemand) system.

This book describes how to:

v Maintain the database
v Manage disk and archive storage
v Use the administrative client to define reports to the system and maintain other
types of objects on the system
v Load reports and other types of data into the system
v Use administrative commands to complete other types of tasks

Before you begin, IBM recommends that you familiarize yourself with concepts
and terminology used in this book. See the IBM Content Manager OnDemand for i:
Common Server Planning and Installation Guide for information about Content
Manager OnDemand.

Who should read this book

This book is of primary interest to administrators who are responsible for

implementing and maintaining a Content Manager OnDemand system. Some
administrators can use this book and the tools described in it to define reports to
the system. Other administrators can use this book and the tools described in it to
maintain users, groups, printers, and so forth. Still other administrators can use the
administrative commands described in this book to maintain the database, disk
and archive storage, extract documents from the system, and so forth.

How this book is organized

″Database administration″ describes the key database objects that you will need to
understand to perform the tasks in this book, describes how to maintain the
database, and provides information about backup and recovery. This part contains
the following sections:
“Database concepts” on page 1
“Database maintenance” on page 3
“Migrating and importing index data” on page 7

″Storage administration″ contains information about managing disk and archive

storage devices and objects. This part has the following sections:
“Document storage” on page 13
“Using Tivoli Storage Manager as a separate storage manager” on page 27
“Backup and recovery” on page 41

″Using System i® Navigator for OnDemand administration″ contains information

about System i Navigator, a program that you can use to define and maintain
objects on the system. For example, you can use System i Navigator to define
reports to Content Manager OnDemand and maintain Content Manager
OnDemand users, groups and printers. This part contains the following sections:

© Copyright IBM Corp. 1991, 2010 vii

 “Installing the administrative client” on page 45 describes the hardware,
software, memory, and disk space requirements for the administrative client
and how to install the administrative client
“About the administrative client” on page 49 provides an introduction to the
System i Navigator, including how to start the program, log on to a server, and
maintain passwords, describes the types of tasks that you can do with the
System i Navigator, and contains information about the system parameters that
you can maintain with the System i Navigator
“Concepts” on page 65 provides an overview of the System i Navigator objects:
users, groups, printers, migration policies and storage sets, application groups,
applications, and folders.
“Examples” on page 85 provides step-by-step instructions for using the System
i Navigator to define users, groups, printers, migration policies and storage
sets, and reports to the system

″Loading data″ provides information about and examples of loading reports on the
system. This part contains the following sections:
“Loading spooled file data” on page 145
“Loading image files” on page 155
“Loading user-defined data” on page 163
“Restarting a load process” on page 171
“Importing and exporting OnDemand objects through batch administration” on
page 173
“Deleting a report” on page 187

″Server administration″ describes errors and alerts, system logging and how to find
the server job system logging, how to find the server job, and how to restart
journaling.
“Managing the server” on page 189

“Command reference” on page 197 contains reference information about the

Content Manager OnDemand server commands.

“System log messages” on page 203 contains many of the most common messages
found in the Content Manager OnDemand System Log.

“5250 host connection to client viewer” on page 205 describes the Content Manager
OnDemand 5250 Host Connection, which allows an IBM i application to send
information to the Content Manager OnDemand client workstation viewer
program (the viewer).

“Server printing and faxing” on page 209 describes how to define some of the
server print parameters in your Common Server application definition.

“API and user exit reference” on page 213 describes the Content Manager
OnDemand APIs.

“Automating ARSLOAD data loading” on page 269 describes how to automate the
ARSLOAD command.

“Alternative to starting the administrative client” on page 271 describes a different

way to start the administrative client.

viii Common Server Administration Guide

 “Accessibility features,” on page 275 describes Content Manager OnDemand
features that provide accessibility to users with disabilities.

Conventions and terminology used in this book

The term Windows® client refers to the Content Manager OnDemand client
software that runs under Windows 2000, Windows XP, and Windows Server 2003.

Prerequisite and related information

Use the IBM i Information Center as your starting point for looking up IBM i
technical information.

You can access the Information Center in two ways:

v From the following Web site: http://www.ibm.com/systems/i/infocenter/
v From CD-ROMs that shipped with your IBM i order: IBM i Information Center
SK3T-4091-07
The IBM i Information Center contains:
v Updated and new information, including i installation and upgrades, data
migration, service and troubleshooting, availability, System i integration,
connecting to System i, database, Linux®, WebSphere®, Java™, CL commands,
system APIs, and manuals.
v Advisors and other interactive tools to assist in troubleshooting and configuring
your i software.

IBM Content Manager OnDemand Information Center

In addition to the IBM i Information Center (previously mentioned), be sure to

visit the Content Manager OnDemand Information Center, which focuses only on
information pertaining to Content Manager OnDemand. The Content Manager
OnDemand Information Center provides fast, online centralized access to product
information. It is a task-based documentation repository that allows you to search
across the entire product library for commands, error codes, or any other topic of
interest. You can bookmark pages of interest and retrieve them later for quick
reference.

| To access the Content Manager OnDemand Information center, go to

| http://publib.boulder.ibm.com/infocenter/cmod/v8r4m1//index.jsp.

Traditional product documentation has been moved from the library page to the
support page on the Content Manager OnDemand for i product Web site. To see a
list of all available Content Manager OnDemand for i product documentation, go
to http://www.ibm.com/software/data/ondemand/400/support.html. Under the
″Learn″ heading, select ″Version 7.1 documentation (all supported languages).″

System i Navigator

IBM System i Navigator is a powerful graphical interface for managing your IBM i
servers. System i Navigator functionality includes system navigation, configuration,
planning capabilities, and online help to guide you through your tasks. System i
Navigator makes operation and administration of the server easier and more
productive and is the only user interface to the new, advanced features of the i
operating system. It also includes Management Central for managing multiple
servers from a central server.

About this guide ix

 For more information on System i Navigator, see the IBM i Information Center.

How to send your comments

Your feedback helps IBM to provide quality information. Please send any
comments that you have about this publication or other Content Manager
OnDemand documentation. Visit the IBM Data Management Online Reader’s
Comment Form (RCF) page at http://www.ibm.com/software/data/rcf.

Be sure to include the name of the product, the version number of the product,
and the name of the book. If you are commenting on specific text, please include
the location of the text (for example, a chapter and section title, a table number, a
page number, or a help topic title).

Product support

Product support is available on the Web. See www.ibm.com/software/data/

ondemand/400/support.html.

The IBM support center maintains product updates for Content Manager
OnDemand. You can obtain the latest product updates for the end-user client and
the administrative client from IBM service on the Web at http://
service.software.ibm.com/software/ondemand/fixes/.

| The current list of Content Manager OnDemand server and System i Navigator
| component PTFs is available in informational APAR II14497.

If you encounter problems or errors running any of the Content Manager

OnDemand programs, you can call the IBM support center to obtain software
problem and defect support.

x Common Server Administration Guide

 Summary of changes
This edition of IBM Content Manager OnDemand for i: Common Server
Administration Guide contains new technical information. There might be some
instances where changes were made, but change bars are missing. Significant
changes to note are:
“New functions”
“Command enhancements” on page xiii
“Additional functions added previously and included in OnDemand version
7.1” on page xiv
“When you upgrade to version 7.1, be aware of the following” on page xiv

| New functions
| v New commands were added to replace program calls for a number of different
| OnDemand functions:
| – Use the new Create Instance for OnDemand (CRTINSTOND) command
| instead of calling the QRLMINST program to create new OnDemand
| instances. The new command provides additional parameters beyond what
| the QRLMINST program provided. The command allows you to specify Port,
| Autostart, Security, and Auxiliary Storage Pool (ASP)-related parameters on
| the command so that the ars.ini and ars.cfg configuration files do not need
| editing in many cases. Note that the program call interface is no longer
| supported. The command interface is the only supported interface in version
| 7.1.
| – Use the new Merge Spooled Files (MRGSPLFOND) command instead of the
| old MRGSPLFOND sample command (shipped in previous releases) or
| calling the QRLMQMRGF program to merge small spooled files into one
| larger file before archiving. The new MRGSPLFOND command shipped with
| version 7.1 contains new and enhanced parameters that provide significantly
| more function than the previous sample command. Any of your existing
| programs that use the previous sample command must be changed to use the
| version 7.1 parameters.
| – Use the Migrate Media (MGRMEDRDAR) command instead of calling the
| QRLCSFAMMF program to migrate OnDemand data from one media type to
| another. (This command was available in OnDemand version 6.1, but is listed
| here to note that the program call is no longer supported. Only the command
| interface is supported in version 7.1.)
| – Use the Change Policy Level Date (CHGPLDOND) command instead of
| calling the QRLCASMCLD program if you need to change migration policy
| level dates for archived data. (This command was available in OnDemand
| version 6.1, but is listed here to note that the program call is no longer
| supported. Only the command interface is supported in version 7.1.)
| v A new System i Navigator function has been added to replace the program call
| for setting up Network File System (NFS) disk pools for use with OnDemand.
| – Use the new Network File System (NFS) panels of the OnDemand System i
| Navigator plug-in instead of calling the QRLCASMNFS program.
| – See the Content Manager OnDemand for i: Common Server Administration
| Guide for instructions on using NFS with OnDemand.

© Copyright IBM Corp. 1991, 2010 xi

| v Enhanced retention management capabilities are now available as a separately
| priced feature of OnDemand for i at 7.1, which provide new hold and release
| functions for the OnDemand end-user client, and HOLD-ADD and
| HOLD-RELEASE parameters for the ARSDOC API, and the ODWEK ODHold
| and ODHit Java APIs. Expiration for held documents can be prevented until the
| hold is released. See the new ARS_SUPPORT_HOLD entry for the ARS.CFG file
| in the IBM Content Manager OnDemand for i: Common Server Planning and
| Installation Guide.
| IMPORTANT NOTE: When using enhanced retention management, the
| OnDemand Disk Storage Manager (DSM) must be in complete control of
| expiration processing. If you are using the OnDemand Archive Storage Manager
| (ASM) or Tivoli® Storage Manager, you must disable the ability for either of
| these storage managers to expire data. For example, in ASM, this means
| disabling or deleting any Expire levels in migration polices that are used with
| OnDemand application groups that have enhanced retention management
| enabled.
| v All of the storage management data was moved from the QUSRRDARS library
| to the individual instance library with which it is associated. A few objects
| remain in the QUSRRDARS library. This change removes the need to move the
| QUSRRDARS library to an Independent Auxiliary Storage Pool (IASP).
| v An instance library can be located in a user Auxiliary Storage Pool (ASP 2
| through 32).
| v A new System Load application group was added, which contains one entry for
| each input file that is loaded into OnDemand. Using the OnDemand client, you
| can verify what data was successfully loaded into OnDemand.
| v A new Java-based ARSSUPPORT utility is available to gather diagnostic
| information such as log entries. This tool is helpful when you need to report
| problems to IBM Software Support. See the IBM Content Manager OnDemand
| for i: Common Server Administration Guide for details.
| v The Xerces2 Java Parser Version 2.6.2 is included in this version of Content
| Manager OnDemand for i. See the IBM Content Manager OnDemand for i:
| Common Server Planning and Installation Guide for instructions on using this
| version of the parser.
| v Numerous OnDemand Web Enablement Kit (ODWEK) changes are included in
| version 7.1. Look for change bars throughout the IBM Content Manager
| OnDemand for i: Common Server ODWEK Installation and Configuration Guide
| to identify the changes.
| v Updates were made to the batch administration function (ARSXML API),
| including new, renamed, and removed attributes. For example, the name
| attribute value of _ALL was removed for update and delete. (_ALL is still
| supported for export operations.) See the IBM Content Manager OnDemand for
| i: Common Server Administration Guide for details.
| v New sample programs were added and existing samples have been updated. See
| QSAMPLES2 source file in the QRDARS library.
| v Documentation was added for Archive Storage Manager (ASM)-based
| expiration, which might eliminate the need to run Disk Storage Manager (DSM).
| This capability became available in OnDemand 6.1, but is listed here to note that
| additional documentation was added to the IBM Content Manager OnDemand
| for i: Common Server Administration Guide on this topic. Also see the
| IMPORTANT NOTE above, under enhanced retention management, regarding
| existing OnDemand storage management functions and the new retention
| management capabilities.

xii Common Server Administration Guide

| v The AFP2WEB Transform (which includes both AFP2PDF and AFP2HTML) that
| allows AFP data to be viewed using an OnDemand Web Enablement Kit
| (ODWEK) interface is available as a separately priced feature of OnDemand for i
| at version 7.1. See your IBM representative or business partner for more
| information on the AFP2WEB Transform.
| v The PDF indexer supports resource grouping and removing unused resources.
| After you enable resource grouping, common resources across documents in a
| single input file are grouped and stored as a single object, and unused resources
| from an input file can be removed before indexing. New PDF indexer
| parameters (RESTYPE and REMOVERES) have been added to support this new
| capability. For more information, see the IBM Content Manager OnDemand for i:
| Common Server Indexing Reference.
| v Integration with FileNet® P8 platform is now supported as a separately priced
| feature at version 7.1, allowing you to send Content Manager OnDemand for i
| metadata to FileNet® and take advantage of FileNet’s Business Process
| Management (BPM) and FileNet Records Manager (RM) capabilities. For more
| information on this Content Federation Services for OnDemand feature, see the
| new ARS_SUPPORT_CFSOD entry for the ARS.CFG file in the IBM Content
| Manager OnDemand for i: Common Server Planning and Installation Guide and
| the new CFSOD-FED function for ARSDOC in the IBM Content Manager
| OnDemand for i: Common Server Administration Guide.
| v Documentation on various data areas that control OnDemand functions was
| consolidated and added to the IBM Content Manager OnDemand for i: Common
| Server Administration Guide.
| v A new column header was added to the OnDemand post processor program
| input file. This new header begins with the ″<″ character and ends with the ″>″
| character. Your post processor programs must be tested to ensure compatibility
| with this addition.

| Command enhancements
| v A new *DIR2 monitor type was added to the Start Monitor for OnDemand
| (STRMONOND) command, triggered by .ARD files (like the ARSLOAD API)
| instead of the .IND files like the current *DIR monitor type. Note that the *DIR
| monitor type on the End Monitor for OnDemand (ENDMONOND) command
| ends either type of monitor, regardless of whether it was started as a *DIR or
| *DIR2 monitor.
| v Two new parameters were added to the Start Monitor for OnDemand
| (STRMONOND) command. The End server (ENDSVR) parameter allows you to
| end the instance server when monitor ends. The Monitor job name (JOB) allows
| you to specify the name you want to use for the monitor job.
| v Two new parameters were added to the Add Report to OnDemand
| (ADDRPTOND), Print Report from OnDemand (PRTRPTOND), Start Monitor for
| OnDemand (STRMONOND), Remove Report from OnDemand (RMVRPTOND),
| Start Import into OnDemand (STRIMPOND), Start Archive Storage Mgmt
| (STRASMOND), Start Disk Storage Management (STRDSMOND), Merge
| Spooled Files (MRGSPLFOND), Change Policy Level Date (CHGPLDOND), and
| Migrate Media (MGRMEDRDAR) commands.
| – Using INSTANCE(*DFT), which is the new default rather than
| INSTANCE(QUSROND), a default instance name can be retrieved from a data
| area named QDFTINST so that the instance name does not need to be
| explicitly specified on each command. See online help and the IBM Content
| Manager OnDemand for i: Common Server Administration Guide for details
| on the QDFTINST data area.

Summary of changes xiii

| – The Start server (STRSVR) parameter can be specified to start the instance
| server when the command is executed. (The STRSVR parameter does not
| apply for the CHGPLDOND command.) See online help for more
| information.
| v A new VALIDATE parameter has been added to the Start Disk Storage
| Management (STRDSMOND) command to ensure that all disk storage files are
| correctly linked and contain the proper file permissions.
| v The Maximum number of monitors to start parameter on the Start Monitor for
| OnDemand (STRMONOND) command when starting an output queue monitor
| was reduced from 99 to 9 to avoid locking delays that can occur if a large
| number of monitors are started against the same output queue.

| Additional functions added previously and included in OnDemand

| version 7.1
| v The INSTANCE parameter of the Start TCP/IP Server (STRTCPSVR) and End
| TCP/IP Server (ENDTCPSVR) commands is now supported when specifying
| *ONDMD (for OnDemand) for the SERVER parameter. You can name a specific
| instance to start, or use one of three special values (*DFT, *ALL, *AUTOSTART).
| Note that calling the QRLMCTL program to start or end an instance is still
| supported, but using the STRTCPSVR and ENDTCPSVR commands is
| recommended. See the IBM Content Manager OnDemand for i: Common Server
| Planning and Installation Guide and online help for more information.
| v Lightweight Directory Access Protocol (LDAP), an open industry standard that
| shares information between distributed applications on the same network, can
| be used to manage basic login authentication directly on the server. See the IBM
| Content Manager OnDemand for i: Common Server Administration Guide for
| more information.
| v Support for the Internet Protocol Version 6 (IPv6) addressing format, which is a
| revision of the IPv4 addressing scheme for TCP/IP, is included in the 7.1 version
| of Content Manager OnDemand for i. See the IBM Content Manager OnDemand
| for i: Common Server Planning and Installation Guide for more information.
| v *ASM can now be specified as the target (TGT) destination on the Migrate
| Media MGRMEDRDAR command, allowing data to be moved from the Spool
| File Archive architecture (managed by RMC) to the Common Server architecture
| (managed by ASM).
| v The PDF indexer now allows part of the input file name to be used as an index
| value when storing data using the ARSLOAD API.

| When you upgrade to version 7.1, be aware of the following

| v If you are upgrading from a previous version of OnDemand, you must be
| running OnDemand server version 7.1.2.8 or higher prior to upgrading to
| Content Manager OnDemand for i Version 7 Release 1. To determine your
| current server version, see the IBM Content Manager OnDemand for i: Common
| Server Planning and Installation Guide for instructions.
| v Version 7.1 of Content Manager OnDemand for i does not support OnDemand
| client software prior to version 7.1.2.0. This includes, but is not limited to, the
| OnDemand Windows (end-user) client, ODWEK CGI/Servlet/Java APIs, CICS®,
| and II4C (eClient).
| v The OnDemand Administrator client must be at the same version or higher as
| the OnDemand server. For version 7.1 of Content Manager OnDemand for i, the
| OnDemand Administrator client must be at version 8.4.1.3 or higher.

xiv Common Server Administration Guide

| v Starting an instance or starting the Archive Storage Management (ASM) process
| for the first time after your upgrade to version 7.1 takes longer than usual due
| to file conversions and movement of instance-specific data and objects from
| QUSRRDARS into the instance libraries.
| – Do not end the server job or ASM if you are concerned that it is not
| progressing.
| – Status messages are written to the job log during the file conversions and the
| data movement from QUSRRDARS to the instance library which you can
| check to confirm that the job is making progress.
| v If a job description (object type *JOBD) exists in the QUSRRDARS library that
| matches an OnDemand instance name defined to your system, the job
| description is moved from QUSRRDARS to the instance library. When
| OnDemand looks for a job description to use to start the instance server,
| OnDemand looks first for a *JOBD object that is named the same as the instance
| name in the instance library. If one is not found, OnDemand looks for a *JOBD
| object that is named the same as the instance name in the QUSRRDARS library.
| If one is not found, OnDemand uses the QOND400 job description located in the
| QRDARS library.
| v The following program calls were replaced by new commands or a new System
| i Navigator interface in version 7.1:
| – Replace the MRGSPLF sample program and the previous MRGSPLFOND
| sample command with the new MRGSPLFOND command.
| – Replace the QRLMINST program with the CRTINSTOND command.
| – Replace the QRLCASMNFS program with the System i Navigator plug-in
| interface.
| – Replace the QRLCSFAMMF program with the MGRMEDRDAR command.
| – Replace the QRLCASMCLD program with the CHGPLDOND command.
| v The OnDemand Commands (CMDOND) menu, which includes all of the
| OnDemand for i Common Server commands, is the only 5250 menu that is
| shipped with OnDemand version 7.1. The following OnDemand 5250 menus
| were removed:
| – CMDRDAR
| – ONDEMAND
| – RDARS
| – RDARSDEF
| – RDARSM
| – RDARSOBJ
| – RDARSRLA
| – RDARSRPT
| – RDARSUTL
| v If you installed fonts for use with the PDF indexer, you should verify the
| location of the fonts and move them to the directories required by the PDF
| indexer if necessary. For specific details, see the IBM Content Manager
| OnDemand for i: Common Server Indexing Reference.
| v The QPRLR133 printer file in the QRDARS library is no longer part of the
| product, because it was a component of Spool File Archive, which is no longer
| available. The printer file is removed when version 7.1 is installed.

Summary of changes xv
| v The unmount file system program (QRLCASMUFS ) no longer supports *ALL
| for the instance name, because all instance-specific files are now in the
| individual instance libraries. You must name a specific instance when you call
| the program.
| v Before using the latest version of the OnDemand Web Enablement Kit (ODWEK)
| CGI/Servlet, you must delete all of the files from the Web Enablement Kit cache
| and temp directories. The directories are specified by the CACHEDIR and
| TEMPDIR entries in the arswww.ini file.
| v Existing Spool File Archive implementations must be migrated from the Spool
| File Archive environment to Common Server before the system on which they
| are running is upgraded to 7.1. Content Manager OnDemand releases 5.3 and
| 5.4 included the Common Server environment, as well as the legacy
| environments of Spool File Archive, AnyStore, Record Archive, and Object
| Archive. All of these environments are fully supported through and including
| i5/OS® 5.4.
| As stated in IBM Announcement Letter #206-030 dated February 14, 2006, 5.4
| was the last release that Spool File Archive, AnyStore, Record Archive, and
| Object Archive would be shipped and supported. Beginning with Content
| Manager OnDemand 5.3, a Spool File Archive migration utility was available as
| part of the Content Manager OnDemand licensed program product. The
| migration utility provides the capability to migrate report definitions and
| indexes from the legacy Spool File Archive environment to the Common Server
| environment. Detailed information on the migration utility can be found in
| Appendix A of the IBM Content Manager OnDemand for iSeries®: Common
| Server Planning and Installation Guide for version 5.4. Existing Spool File
| Archive implementations must be migrated from the Spool File Archive
| environment to Common Server before the system is upgraded to version 7.1.

xvi Common Server Administration Guide

Database concepts
“System”
“Instance”
“Database”
“Table” on page 2
“Index” on page 2
“Journals and journal receivers” on page 2

System
A database system represents a physical machine that contains a copy of the
database manager. In IBM Content Manager OnDemand, the server is the physical
machine referred to as the system.

Instance
An IBM Content Manager OnDemand instance is a logical server environment
consisting of a server and its own separate database and disk space. Each Content
Manager OnDemand instance (the server, database and disk):
v Has its own definition of folders, application groups, applications and printers
v Must run in a single CCSID
v Has different security (users, groups, folder and application group permissions)
v Must have its name specified on commands if it is not the default instance
v Has its own System Log
Some reasons you might have multiple instances on a machine are:
v To have distinct test and production environments
v To have databases using different CCSIDs

For Content Manager OnDemand, IBM recommends that you name your primary
production, or only, instance QUSROND. This is the default OnDemand instance
that is used on all OnDemand commands unless you explicitly specify a different
instance name. Using this as your primary OnDemand instance will save you from
having to specify an instance name in most cases.

Database
A database is a collection of data that is stored in tables. In IBM Content Manager
OnDemand, generally speaking, there are two types of tables:
v System tables, which contain information about the objects you define to the
system, such as users, groups, application groups, applications, folders, storage
sets, and printers. There are also system tables that contain information Content
Manager OnDemand uses to control and maintain the system.
v Application group tables, which contain the index data for the reports that you
load on the system
.

© Copyright IBM Corp. 1991, 2010 1

Table
A table consists of data logically arranged in columns and rows. For example, when
you create an application group, the system creates a table definition that contains
one column for each field that you define. When you load a report into an
application group, the system adds one row to an application group table for each
document contained in the report.

Index
In IBM Content Manager OnDemand, an index is a key that points to a document.
An index allows more efficient access to documents by creating a direct path to a
document through pointers.

You define indexes when you create an application group. The indexes should
contain information that uniquely identify a document, such as date, account
number, and customer name. Indexes are populated by values extracted from a
report when you load a report on the system. Each row in an application group
table identifies one document.

However, keep in mind that you do not want lots of indexes on a report just to
have indexes. You should have a good business reason to have an index. While
indexes can help you find documents faster, having too many of them can slow
you down when you load reports on the system. Every time you add a new row
(document) to a table, you have to add a row to each and every one of the indexes
for that table. So the more indexes that you have, the longer it may take when you
load a report.

The SQL optimizer automatically chooses the most efficient way to access data in
tables. The optimizer takes indexes into consideration when determining the fastest
access path to data.

Journals and journal receivers

Each database includes recovery journals and journal receivers, which are used to
recover from application or system errors. In combination with database backups,
journals are used to recover the consistency of the database right up to a point in
time when an error occurred.

All instances have journals associated with them. These journals keep records of
database changes. Journals prevent a failure (system power, application error) from
leaving a database in an inconsistent state. They restore the state of a database to
the point before the change. Journals can also enable forward recovery to any point
in time before the failure.

In planning for disaster recovery, be sure to remember that journals must be stored
off site, or at least safely away from the disaster, in order to recover your database
beyond the point of the last full, off line backup.

2 Common Server Administration Guide

Database maintenance
You need to maintain the IBM Content Manager OnDemand database to keep it
performing in an optimal manner. IBM recommends that you run the following
database maintenance tasks on a regular basis:
v Expire index data that has reached its life of data and indexes period
v Migrate indexes to archive storage, if your organization needs to keep indexes
for some period of time after users no longer need to retrieve the documents to
which they point. This is not recommended.
“Before you begin”
“Expiring index data”
“Migrating indexes” on page 5

Before you begin

IBM recommends that you do the following:
v Keep the index data for any given version of a report in the database on disk at
least until such time that 99 percent of the requests for the report have passed.
As a rule of thumb, if there is any chance that someone in your organization
will need to retrieve a version of a report, keep the index data in the database –
don’t allow it to be migrated.
v Expire data periodically, and migrate index data only when absolutely necessary.
v Select Multiple Loads per Database Table when you define the Database
Organization within your application group definitions. With this selection, each
time that you load a report into an application group, IBM Content Manager
OnDemand inserts the index records into an existing database table. Index
records for every report loaded into the application group are stored in the same
database table. Content Manager OnDemand maintains the application group
data so that, as far as a user querying the application group knows, they appear
to reside in one database table. Content Manager OnDemand automatically
segments the application group data when it grows beyond a certain size (unless
you select Single table for all loads). Content Manager OnDemand maintains a
segment table for each instance. The segment table provides faster query
performance by limiting searches to a specific table of application group data,
using a date value to construct the query. This method is the default, and should
be used in most cases.

Expiring index data

Indexes expire (are eligible for removal) because their life of data period has
passed. The indexes, and the documents that they point to, can then be removed
from the system. When you remove an index, information about the document to
which it points is removed from the database (the document can no longer be
retrieved). However, because indexes are eligible to be removed does not mean
that they will be deleted from the database. IBM Content Manager OnDemand
does not delete expired index data from the database until expiration processing
runs.

© Copyright IBM Corp. 1991, 2010 3

 The application group expiration policy determines when index data is eligible for
deletion from the database. You define the expiration policy when you create the
application group. The following properties on the Storage Management page
comprise the expiration policy:
v Life of data and indexes. The length of time in days to maintain index data and
documents on the system. After the index data is on the system for this number
of days, it is eligible to be deleted. The value of Life of Data and Indexes is set
in the Storage Management tab of the Content Manager OnDemand application
group definition. If you change this value after you have loaded data, the
change affects the data that is already in Content Manager OnDemand as well as
any new data loaded after the change is made.

Tip: If you specify Never Expire, then expiration processing is disabled for the
application group. (That is, index data will not be removed from the database.)
| v Expiration Type. Determines whether individual indexes or an entire table of
| index data is deleted at a time. When Content Manager OnDemand deletes
| index data, it either deletes a row (if the Expiration Type is Document), deletes
| all rows for the specific load (if the Expiration Type is Load), or deletes a table
| (if the Expiration Type is Segment). The amount of index data in a table and the
| number of reports the data represents is determined by the Database
| Organization. If the Database Organization is Multiple Loads per Database
| Table, then by default, a table of index data can hold up to 10 million indexes
| (unless you select Single table for all loads, in which case there is no maximum
| number of records for the index table). These types of tables usually hold the
| indexes for many reports. If the Database Organization is Single Load per
| Database Table, then each table holds the indexes for one and only one load.

| A table of index data is not eligible to be deleted until the latest date in any of its
| rows reaches the Life of Data and Indexes period. For example, suppose that the
| Life Of Data and Indexes is set to 365 days, the Expiration Type is set to Segment,
| and the Database Organization is set to Multiple Loads per Database Table. By
| default, a table will contain approximately 10 million rows. Further, suppose that a
| report is loaded into the application group once every month and that each report
| adds one million rows to the database. Each table can hold the index data from
| approximately ten reports. Using these assumptions, the data that is loaded into
| the application group in January will not be eligible to be deleted by expiration
| processing until November of the following year. If you need to remove the index
| data for a report as soon as it reaches its Life of Data and Indexes period, then set
| the Database Organization to Single Load per Database Table and set the
| Expiration Type to Load. (And run expiration processing at least once a month.)
| You should consider selecting Single table for all loads if you have a small number
| of documents to be archived over time. You would not want to select Single table
| for all loads if your Expiration Type is Segment.

| Content Manager OnDemand uses the application group’s expiration policy to

| determine when indexes and documents expire and should be removed from the
| system. The archive storage manager marks documents for removal based on the
| Expire level specified in the migration policy. However, you should specify the
| same criteria to the disk storage manager and the archive storage manager. For
| more information on migrating and expiring documents, and recommendations for
| storage management criteria defined in your application groups, storage sets, and
| migration policies, see “Defining document storage management” on page 13.
“How to expire index data” on page 5

4 Common Server Administration Guide

 How to expire index data
IBM Content Manager OnDemand does not delete expired index data from the
database until expiration processing runs. The STRDSMOND command is the
expiration utility. You can schedule the STRDSMOND command to run
automatically or you can run it manually. You should make sure that the
STRDSMOND command runs periodically so that Content Manager OnDemand
deletes indexes when it is time to do so (so that expired documents can no longer
be retrieved).

When the STRDSMOND command removes indexes, it saves a message similar to

this in the System Log: 128 ApplGrp Segment Expire (ApplGrp) (Segment)

One message is saved in the System Log for each table that was deleted during
expiration processing.

While not recommended, if you have migrated indexes to archive media, then the
STRASMOND command will perform expiration processing on that index data.

Migrating indexes
This section provides an overview of the process of migrating index data from the
database to archive storage. See “Migrating and importing index data” on page 7
for information about configuring the system for migration processing.

IBM Content Manager OnDemand provides automatic migration to move indexes

from the database to archive storage to maintain seldom used indexes for long
periods of time.

Important: If you use migration to move indexes to archive storage, make sure
that you migrate them after there is no longer a need to retrieve the documents to
which they point.

The STRDSMOND command uses an application group’s migration policy to

control when migration of indexes for an application group occurs:
v Migration of Indexes. If you specify No Migration, then migration of indexes is
disabled for the application group. (That is, index data will not be migrated.) If
you specify Migrate After n Days, then index data is eligible to be migrated after
reaching the specified number of days. Indexes will be migrated the next time
that the STRDSMOND command runs.
v Life of Data and Indexes. The length of time in days to maintain index data on
the system. For migration, this value must be greater than the Migrate After n
Days value. The value of Life of Data and Indexes is set in the Storage
Management tab of the Content Manager OnDemand application group
definition. If you change this value after you have loaded data, the change
affects both the data that already exists in Content Manager OnDemand as well
as any new data loaded after the change has been made.

Content Manager OnDemand does not migrate index data from the database to
archive media until migration processing runs. The STRDSMOND command is the
migration utility. You can control automatic migration processing by scheduling the
command to run with the appropriate options. You can also manually start
migration processing by running the command from the command line.

After a migrated table is successfully loaded into the System Migration application
group, the table is deleted from the database. However, Content Manager

Database maintenance 5
 OnDemand keeps track of all migrated tables. That way, if index data in a
migrated table is needed, then Content Manager OnDemand can alert an
administrator to take action (such as manually import the table back into the
database).
“How to migrate indexes”

How to migrate indexes

You can control automatic migration processing by scheduling the STRDSMOND
command to run with the appropriate options. You can also manually start
migration processing by running the STRDSMOND command from the command
line.

When the STRDSMOND command migrates indexes, it saves the following

messages in the System Log. A set of three messages should be saved in the
System Log for each table that is migrated from the database to archive storage:
166 ApplGroup Segment Export (ApplGrp) (Segment)
14 DB Info Exported (SQL Code)
87 ApplGrp Load (System Migration)

The first message identifies a table of application group index data that is to be
migrated from the database to archive storage. The second message reports the
status of exporting the table from the database to temporary storage. The third
message reports the loading of information about the migrated table into the
System Migration application group. The System Migration application group must
be assigned to a storage set that identifies an archive storage media type (such as
optical or tape).

6 Common Server Administration Guide

Migrating and importing index data
Index migration is the process by which IBM Content Manager OnDemand moves
index data from the database to archive storage. This process optimizes database
storage space while allowing you to maintain index data for a very long time. You
typically migrate index data after users no longer need to access the information,
but for legal or other business requirements, you still need to maintain the data for
some number of years. If a user queries index data that has been migrated, an
administrator must import a copy of the migrated table into the database. After
maintaining the imported table in the database for a specified number of days,
Content Manager OnDemand deletes it from the database.

This section provides information about importing index data into the database,
including what happens when a user queries for migrated data, how to import the
index table or tables required by the query, and what happens after you import a
table into the database.

IBM assumes that an experienced Content Manager OnDemand administrator will

use the information provided in this section. If you have questions about any of
the topics in this section or if you would like help configuring your system to
support migrating and importing of index data, contact the IBM support center.

In general, migrating index data is not recommended.

“Configuring the system”
“What happens when a user queries migrated data” on page 9
“Importing index data” on page 9
“After you import index data” on page 10

Configuring the system

There are a number of things you should consider regarding system configuration
before you make any decisions about index migration.
“System Log messages”
“System Log user exit program” on page 8
“Archive Storage Manager” on page 8
“Storage sets” on page 8
“Application groups” on page 8

System Log messages

IBM Content Manager OnDemand provides the System Log for administrators to
monitor the system. When you install and configure Content Manager OnDemand,
you initialize the System Log tables. The System Log is critical to the operation of
the system.

When Content Manager OnDemand processes a query for application group

indexes that have been migrated to archive storage, it saves a message in the
System Log and sends a message to the System Log user exit program. A message
is also sent to the QSYSOPR message queue.

© Copyright IBM Corp. 1991, 2010 7

 You can configure the system to examine the messages that Content Manager
OnDemand sends to the System Log user exit and mail them to an administrator
or send them to another program. You can also configure the System Log user exit
program to determine what action to take when a user queries for data that has
been migrated to archive storage. See “System log messages” on page 203 for more
information and a list of the most common System Log messages.

System Log user exit program

When a client queries index data that has been migrated to archive storage, IBM
Content Manager OnDemand saves message number 168 ApplGrp Segment Not
Available in the System Log. Content Manager OnDemand also sends the message
to the System Log user exit program. If you have defined your own System Log
user exit program, then you can determine the action to take when Content
Manager OnDemand sends the message to the System Log user exit program. For
example, you may want the program to notify an administrator that a request for a
table of migrated index data has occurred. See the IBM Content Manager OnDemand
for i: Common Server Planning and Installation Guide for more information about the
System Log user exit program.

Archive Storage Manager

Before IBM Content Manager OnDemand can migrate index data to archive
storage, you must configure a migration policy with the information that the
archive storage manager uses to maintain the data. The migration policy should
maintain the data indefinitely. If you need the system to maintain a backup copy of
the index data, then you should specify this in the migration policy.

Storage sets
IBM Content Manager OnDemand uses the System Migration application group to
manage all index data that is migrated to archive storage. You must assign the
System Migration application group to a storage set that identifies an archive
storage media type.

Application groups
When you define an application group, you specify the storage management
information that determines how long IBM Content Manager OnDemand
maintains data stored in the application group and when Content Manager
OnDemand takes certain actions. For example:
v Life of Data and Indexes: Determines the length of time that Content Manager
OnDemand maintains index data and report data stored in the application
group.
v Migration of Indexes: Determines the number of days before Content Manager
OnDemand moves index data from the database to archive storage.
You should plan to migrate index data only after users no longer need to access
the reports to which it refers. Only in exceptional situations should users need to
access index data that has been migrated. If a user needs to access index data
that has been migrated to archive media, the process of importing the table back
into the database requires manual actions by an administrator, and usually
results in a significant delay in completing the query. The import process also
requires additional space in the database to hold the imported tables, additional
log file storage, and temporary storage on the server to run the import process.

8 Common Server Administration Guide

 v Keep Imported Migrated Indexes: Determines how long that Content Manager
OnDemand maintains the imported index data in the database before it is
scheduled for deletion.

If you need to maintain index data in archive storage, then you must configure the
Migration of Indexes in your application groups. You must specify the number of
days to keep the index data on disk in Keep Imported Migrated Indexes. Content
Manager OnDemand will schedule imported index data for deletion from the
database after it resides in the database for the number of days specified in Keep
Imported Migrated Indexes or Life of Data and Indexes, whichever occurs first.

You can use the administrative client to configure your application groups.

What happens when a user queries migrated data

There are several ways to be notified when a user requests queries migrated index
data.
“Message to the user”
“Message to the System Log”

Message to the user

When the server determines that the index data required to complete a query has
been migrated to archive storage, it sends a message to the client program. The
message states that the data required to complete the query is not available and
that the user should contact an administrator.

Message to the System Log

When IBM Content Manager OnDemand determines that the index data required
to complete a query has been migrated to archive storage, it saves a message in the
System Log. An administrator can open the System Log folder to search for and
display messages in the System Log.

Content Manager OnDemand also sends a message to the QSYSOPR message

queue and the System Log user exit program. You can configure the system to
examine the message and send an alert to an administrator or call another
program to take some action. See “System log messages” on page 203 for more
information and a list of the most common System Log messages.

Importing index data

If index data is to be imported back from archive media, it is important to consider
the following:

Verify database storage space

Importing migrated index data from archive storage back into the database
requires additional database storage. Before you import the index data, you should
verify that sufficient free space is available.

Migrating and importing index data 9

 Verify database log file space

Importing migrated index data from archive storage back into the database
requires database journal storage. Before you import the index data, you should
verify that sufficient free space is available.
“Run the STRIMPOND command”

Run the STRIMPOND command

IBM Content Manager OnDemand provides the STRIMPOND command to import
tables of migrated index data from archive storage back into the database. (The
name of the application group and the index table to import can be obtained from
the message that Content Manager OnDemand saved in the System Log.)

After the STRIMPOND command completes the import operation, you can open
the System Log folder to see the messages that were generated by the import
process. The messages will reference the ARSADMIN program name. See “System
log messages” on page 203 for more information and a list of the most common
System Log messages.

See online help for more information about the STRIMPOND command and its
parameters.

After you import index data

After you import index data from archive storage back into the database, you
should notify the user to retry the query.
“Expiring imported migrated indexes”
“Configuring index migration”

Expiring imported migrated indexes

IBM Content Manager OnDemand schedules an imported index table for deletion
after it resides in the database for the number of days specified in the Length of
Time to Keep Imported Indexes property in application groups. After an imported
index data reaches the specified value, the next time that the STRDSMOND
command runs, the imported index table is deleted from the database. (However,
the table still exists in archive storage.)

You typically configure the STRDSMOND command to run automatically on a

regular schedule. You can also run the STRDSMOND command manually.

Configuring index migration

If you find that your users are often querying for index data that has been
migrated to archive storage, then IBM recommends that you configure your
application groups to increase the length of time that IBM Content Manager
OnDemand maintains the index data in the database. This should reduce the
number of queries that need migrated index data.
“Keeping imported migrated indexes” on page 11

10 Common Server Administration Guide

Keeping imported migrated indexes
IBM Content Manager OnDemand schedules imported index data for deletion after
the index data resides in the database for the number of days specified in Keep
Imported Migrated Indexes or Life of Data and Indexes, whichever occurs first.

Migrating and importing index data 11

12 Common Server Administration Guide
Document storage
“Defining document storage management”
“Migrating documents” on page 15
“Removing documents” on page 18

Defining document storage management

The document storage management definitions determine where and when IBM
Content Manager OnDemand stores documents and how it maintains them.

When you load a document into Content Manager OnDemand, you assign it to an
application group. The application group is the last document storage management
component that you define, because it requires storage set and migration policy
definitions, which you must create first. The application group identifies the
storage set and determines where documents should be loaded. You assign each
application group to a storage set. You can load documents onto disk, onto archive
media, or onto both disk storage and archive storage. The disk storage manager
maintains documents on disk. The archive storage manager maintains documents
on archive media. The archive storage manager uses a migration policy to
determine where to store documents and how long to maintain them. After a
document ages for the specified number of days, the migration process can move it
from disk to archive storage.

This chapter refers to the Content Manager OnDemand Archive Storage Manager
(ASM) as the storage manager for your Content Manager OnDemand data.
However, Tivoli Storage Manager can be enabled to be used in addition to, or in
place of ASM on your IBM i server. See “Using Tivoli Storage Manager as a
separate storage manager” on page 27 for more information on using the Tivoli
Storage Manager.
“Application groups”
“Disk storage manager” on page 15
“Archive storage manager” on page 15

Application groups
The application group is the last component that you must define because it
requires storage set and migration policy definitions. The application group
provides a way to group related documents. All documents in the application
group are loaded on the media that is part of the storage set to which the
application group is assigned. All documents in the application group migrate
according to the rules that are defined for the application group’s migration policy.

Use the administrative client to create the application groups that determine the
document storage for your documents. You typically define one application group
for each set of your documents that have similar storage requirements. For
example, documents that must be retained for a specific length of time, in specific
storage locations and stored on specific types of media.
“Loading” on page 14
“Migrating” on page 14

© Copyright IBM Corp. 1991, 2010 13

 Loading
An application group definition contains the rules for loading documents into an
application group. It requires a storage set, which you must create first. The
application group determines if documents are loaded onto disk, archive storage,
or both. If the application group causes documents to be stored on archive storage,
then the migration policy specifies when (or if) documents are copied to archive
storage.

See the following properties on the Storage Management tab of the application
group:
v Storage Set Name: Determines where documents will be loaded. Note that the
storage set name will match its associated migration policy name (created using
the OnDemand Archive plug-in for System i Navigator) except for cache or
Tivoli Storage Manager storage sets, which do not have associated migration
policies.

Important: If you specify Cache Only, documents can only be loaded onto disk.
This value cannot be changed later, so carefully consider possible future
requirements before you select Cache Only. Unless you are certain that you will
never want to migrate the data for this application group from disk (cache), a
better choice might be to create your own migration policy or select another
storage set from the pulldown list. Your new migration policy/storage set could
be defined to use ASP01 (the system Auxiliary Storage Pool on disk on your
IBM i system) as the first level of storage, and then later optical or tape could be
added.
v Cache Data: Determines if documents will be loaded into disk storage. If the
storage set is a cache-only storage set, documents must be loaded onto disk. For
this reason, you cannot select No for Cache Data if the storage set is cache-only.
v Migrate Data from Cache (on the Advanced panel): If you specify When Data is
Loaded, then documents will be loaded into archive storage.

Migrating
Migration is the process of copying documents from disk to archive storage as
controlled by the rules of the application group’s storage management criteria and
migration policy. However, because a document is eligible to be migrated does not
mean that it will be migrated. Other factors affect migration, such as the frequency
with which you run migration processing. (Migration cannot take place until you
run migration processing.)

The Storage Management tab of the application group and the application group’s
migration policy contain the rules for migrating the documents in an application
group. They define how long a document stays on disk and, through the storage
set and migration policy, where the document will be moved next. The migration
policy level identifies the next location.

See the following settings on the Storage Management tab:

v Storage Set Name: Determines the next location for documents. If you specify
Cache Only, then migration is disabled for the application group.
v Migrate Data From Cache: Determines when documents are eligible to be
migrated. If you specify When Data is Loaded, then migration is done at the
time the data is loaded. If you specify No, then migration is disabled for the
application group.

14 Common Server Administration Guide

 Disk storage manager
The Disk Storage Manager (DSM, which is initiated by using the STRDSMOND
command) maintains documents in cache (on disk, not in a disk pool). Documents
migrate from disk storage to archive storage based on the migration policy that is
defined for the application group. The disk storage manager can delete documents
after they exceed the Cache Data for n Days or Life of Data, whichever occurs first.
See “Removing documents” on page 18 for more information.

Archive storage manager

| The archive storage manager (ASM, initiated by using the STRASMOND
| command) is the interface to the archive media (typically disk pools, Tivoli Storage
| Manager, optical, or tape). The archive storage manager maintains a backup or
| long-term copy of documents. Before loading documents, you must define storage
| sets and migration policies, optical volumes, tape devices, and tape volumes. The
| archive storage manager can delete documents after they exceed the retention
| period specified in the migration policy levels and reach the expiration level. See
| “Removing documents” on page 18 for more information.

Migrating documents
IBM Content Manager OnDemand provides automatic migration to copy
documents from disk storage to archive storage (for documents that were not
copied to archive storage during the load process) and to make documents eligible
for deletion to maintain free space on disk. Automatic migration is provided by
using the Start Disk Storage Management (STRDSMOND) and Start Archived
Storage Management (STRASMOND) commands. Migration helps to ensure that
there is sufficient free space on disk, where faster response time can provide the
most benefit to your users.

Important:
v You should run migration processing on a regular schedule to make sure that a
backup copy of your documents gets created as soon as practically possible. If
you defer the migration of documents to archive storage, and disk storage were
to become corrupted, then you could be left without a copy of your documents.
v The STRASMOND command must only be run in batch (SBMJOB parameter set
to *YES). Running this command interactively (with SBMJOB(*NO)) may cause
SQL errors.
| v By default, the QUSROND default instance is used, and will produce the desired
| results for most systems. You can use an instance other than QUSROND as your
| default by defining the QDFTINST data area as described in “Using OnDemand
| data areas” on page 195. You can also specify the instance name directly when
| you run the commands. If you need to run the STRASMOND command for
| multiple instances, you must issue the command separately for each instance.
| Note that if you initiate the archive storage manager by running the
| STRDSMOND command with RUNASM(*YES), then the instance name is
| passed from the disk storage manager and no further specifications are needed.
v If you run STRDSMOND for a specific application group (rather than the default
of *ALL) and you set the Run ASM (RUNASM) parameter to *YES, be aware
that ASM will run for ALL application groups, even though you have named a
specific application group for DSM to use. You can, however, name a specific
Policy for ASM to process, if desired. Also note that when you specify
RUNASM(*YES), Content Manager OnDemand will initiate a separate batch job
for ASM.

Document storage 15
| v If you specify Cache Data for 90 Days on the Storage Management tab within
| the application group, DSM will keep the data in the IBM i IFS directory for 90
| days after the report date (a segment field) before it removes the data from the
| IFS CACHE directory. Regardless of the settings on the Storage Management tab
| of the application group definition, DSM will not delete data before it is sent to
| ASM. To determine when data is sent to ASM, select the Advanced button on
| the Storage Management tab within the application group. Data is passed to
| ASM based on the criteria specified in the Migrate Data from Cache section on
| the Advanced panel as shown in the table:
| Table 1. Criteria specified in the Migrate Data from Cache section on the Advanced panel of
| the Storage Management tab
| Criteria Description
| No Data is never passed to the archive media.
| This option is only allowed if you specify a
| cache only Storage Set and is not
| recommended.
| When Data is Loaded Archive objects are passed to ASM when the
| store process runs from one of the load
| processes, such as ADDRPTOND,
| STRMONOND, arsload, arsdoc add.
| Next Cache Migration Archived objects are passed to ASM the next
| time STRDSMOND is run.
| After xx Days in Cache After reaching xx days, archived objects are
| passed to ASM the next time that
| STRDSMOND is run.
|
| For a basic approach to the expiration of data, the Life of Data and Indexes
| should be the total of Cache Data days from the application group and the sum
| of the Duration at this level for all levels of the migration policy that is used for
| this application group. For example: The value for Cache Data days is 90 days,
| the migration policy for this application group has two levels, 100 days at the
| disk pool level and 7 years at the optical level so the Life of Data and Indexes
| value should be set to 2745 days.
| You can, instead, take a more advanced approach to managing the expiration of
| your data. If you want to continue to use DSM to manage the expiration of your
| data, by using Life of Data and Indexes to control expiration, you should
| consider setting the duration of the last level of the migration policy to Never
| Expire. This allows controlled movement to a new level if one should be added
| in the future. If you want to manage the expiration of your data using ASM,
| using an expire level as the last level of the migration policy, you should
| consider setting the Life of Data and Indexes to Never Expire. This ensures that
| DSM will never expire the data. See “Eliminating the need to run Disk Storage
| Manager (DSM)” on page 20 for more information regarding Archived Storage
| Manager-based expiration.

| After the data is sent to ASM and has entered a level as specified in the migration
| policy, the number of days at that level can only be changed using the Change
| Policy Level Date (CHGPLDOND) command for that particular data. If you change
| any of these values in the migration policy (instead of using the CHGPLDOND
| command), only newly archived documents are affected. All previously archived
| documents are unaffected.

You control automatic migration processing by scheduling the STRDSMOND and

STRASMOND commands to run with the appropriate options. See your operating

16 Common Server Administration Guide

 system information for details about how to schedule tasks. You can also start
migration processing by running the command manually.

The STRDSMOND command uses an application group’s storage management

information to control when movement of data for an application group occurs:
| v If you use Next Cache Migration to control when migration for an application
| group occurs, then the disk storage manager migrates data from cache each time
| that you start the STRDSMOND command with the appropriate options.
v If you use After xx Days in Cache to control when migration for an application
group occurs, then a document must be stored in cache for at least the specified
number of days before it is eligible to be migrated.

The disk space that migrated documents occupy can be reused after expiration
processing completes. When you run migration processing, you should also run
expiration processing so that the disk storage manager can reclaim the disk storage
space occupied by migrated documents.
“Processes that should not be run simultaneously”
“Migration processing in the system log”

Processes that should not be run simultaneously

The following list identifies Common Server processes that should not be run at
the same time:
v Do not run multiple Start Archived Storage Management (STRASMOND)
commands against the same migration policy.
v Do not run multiple Start Disk Storage Management (STRDSMOND) commands.
v Do not run STRDSMOND while loading data using the following commands:
– Add Report to OnDemand (ADDRPTOND)
– Start Monitor for OnDemand (STRMONOND)
– ARSLOAD API
– ARSDOC add API
v Do not run STRDSMOND and STRASMOND at the same time. (ASM can start
after DSM completes.)
v Do not perform system backups while any of the following processes are
running:
– ADDRPTOND, STRMONOND, ARSLOAD, ARSDOC add
– STRDSMOND
– STRASMOND
– The instance server is running (for example, the QUSROND server job)

Migration processing in the system log

| When you run the STRDSMOND command, it saves messages about its activities
| in the system log. The types of messages saved in the system log depend on the
| options that you specify when you run the STRDSMOND command and can be
| found by searching for the user ARSMAINT for the time that STRDSMOND was
| running. The number of messages saved in the system log during a migration
| process depends on the options that you specify for the STRDSMOND command
| and the number of application groups and segments of data processed. The
| viewable detail of message number 197: Cache Migration contains a list of each
| document that is migrated during the STRDSMOND process. Although you can

Document storage 17
| run multiple STRDSMOND commands for different application groups within the
| same instance or different instances, it is not recommended due to possible locking
| issues.

Removing documents
Documents expire (are eligible for removal) because their disk expiration date or
archive retention period has passed. Expired documents can then be removed by
the storage managers. The disk storage manager identifies documents for removal
by using the application group’s expiration information. The archive storage
manager marks documents for removal based on the criteria defined in the
migration policy.

Documents expire from disk when they reach their disk expiration date. If a
document’s disk expiration date is less than its Life of Data period, then the
document is simply removed from disk storage. Subsequent requests for the
document are satisfied by the archive storage manager. When the document
reaches its Life of Data period, information about it is removed from the IBM
Content Manager OnDemand database (the document can no longer be retrieved).
When the document’s archive retention period has passed, information about it is
removed from the archive storage manager database.

Because a document is eligible to be removed does not mean that it will be deleted
from storage. The disk storage manager does not delete expired documents from
storage until expiration processing runs. During expiration processing, the archive
storage manager deletes information about expired documents from its database.
However, the actual documents may remain on archive media until such time that
the media on which they reside is reinitialized.

Important: The disk storage manager and the archive storage manager delete
documents independently of each other. Each uses its own criteria to determine
when documents expire and should be removed from the system. Each uses its
own utilities to remove documents. However, for final removal of documents from
the system, you should specify the same criteria to the disk storage manager and
the archive storage manager. For more information on recommendations for
storage management criteria defined in your application groups, storage sets, and
migration policies, see “Migrating documents” on page 15.
“Removing documents from disk storage”
“Removing documents from archive storage” on page 19
| “Eliminating the need to run Disk Storage Manager (DSM)” on page 20

Removing documents from disk storage

The options specified on the Storage Management tab when the application group
is created determines when documents are eligible for deletion from disk. The
options on the Storage Management tab are as follows:
v Cache Data for n Days. The length of time in days to keep documents on disk.
After a document reaches this value, it is eligible to be deleted from disk.
v Life of Data. The length of time in days to maintain documents on the system. If
you specify Never Expire, then expiration processing is disabled for the
application group.
v Expiration Type. Determines whether one or more documents are eligible to be
deleted at a time. For example, by default, the Load expiration type means that
the set of documents that were loaded together will also expire together.

18 Common Server Administration Guide

 Alternative: Segment (in contrast to Load) is another possible choice for
expiration type. This is the first time that a segment has been mentioned. Up to
now, the term documents has been used, which is the data object that most
people associate with the IBM Content Manager OnDemand system. However,
administrators who maintain the system may also work with segments, which
represent many documents, and storage objects, which are containers of
compressed documents that are maintained by the storage managers.

The disk storage manager does not delete expired documents from disk until
expiration processing runs. The STRDSMOND command is the expiration utility.
You can schedule the STRDSMOND command to run automatically or you can run
it manually. You should make sure that the STRDSMOND command runs
periodically so that the disk storage manager can reclaim the space that is
occupied by expired documents.
“Expiration processing in the system log”

Expiration processing in the system log

| When you run the STRDSMOND command, it saves messages about its activities
| in the system log. These messages can be found by searching on user ARSMAINT
| for the time period that STRDSMOND was running. The types of messages saved
| in the system log depend on the options that you specify when you run the
| STRDSMOND command. The number of messages saved in the system log each
| time that expiration processing runs depends on the options that you specify for
| the STRDSMOND command and the number of application groups and segments
| of data processed. The viewable detail of message number 196: Cache Expiration
| contains a list of each document that is expired during the STRDSMOND process.

Important: In addition to the messages in the system log, you should monitor
your system every day for messages that indicate that your disk space is becoming
full.

Removing documents from archive storage

Important: Removing a document from archive storage means that the backup or
long-term copy of the document will be deleted from the system. You typically
remove documents from archive storage when you no longer have a business or
legal requirement to keep them.

A migration policy specifies the criteria that makes a document eligible for
deletion. Documents become eligible for deletion under the following conditions:
v Administrators delete documents from archive media (using the Remove Report
from OnDemand (RMVRPTOND) command)
| v An archived document exceeds the time criteria defined in the Expire level of
| the migration policy (processed by the Start Archived Storage Mgmt
| (STRASMOND) command) or the Life of Data and Indexes (processed by the
| Start Disk Storage Management (STRDSMOND) command).

The storage manager does not delete information about expired documents from
its database until expiration processing runs. You can run expiration processing
either automatically or manually using the STRASMOND command (or you can
use the STRDSMOND command with the Run ASM parameter set to *YES). You
should make sure that expiration processing runs periodically to allow the archive
storage manager to reuse storage space that is occupied by expired documents.

Document storage 19
 When expiration processing runs, the archive storage manager deletes documents
from its database. The storage space that these documents occupy then may
become reusable.

| Eliminating the need to run Disk Storage Manager (DSM)

| OnDemand provides both Disk Storage Manager (DSM) and Archive Storage
| Manager (ASM) functions to facilitate a broad range of storage management
| options for your archived data. DSM manages the archived data stored in ″cache″
| within OnDemand, which is typically used for short term storage. Most customers
| configure the system to maintain the most recent and frequently used versions of
| reports in cache storage. ASM manages the archived data that no longer resides in
| cache, which may include disk storage such as Auxiliary Storage Pools (ASPs) or
| Independent Auxiliary Storage Pools (IASPs) on your IBM i system, or Network
| File System (NFS) drives, as well as optical and tape media.

| With Archive Storage Manager (ASM)-based expiration, it is possible to eliminate

| the need to run DSM. There are some advantages to doing this. For example, DSM
| should not be run while loading data into OnDemand, so it may be difficult to
| find a large enough window of time for both loading data and running DSM.
| Another advantage is eliminating the need to run two processes to manage the
| migration and expiration of the data archived into OnDemand, namely DSM and
| ASM.

| When choosing whether or not to implement ASM-based expiration processing,

| you should first understand the differences between how DSM expires data and
| how ASM expires data. DSM and ASM each use a different date to determine
| when the data should be expired. DSM uses the last segment date from the
| document. For example, if you have defined your segment date to be a statement
| date in the document and you are loading statements that are one year old, the
| segment date used to determine the life of the data would be a year prior to the
| date the data is being loaded. If you have set the Life of Data and Indexes to five
| years in your OnDemand application group definition, the data will actually expire
| four years after it is loaded into OnDemand, which is five years from the segment
| date. The same document, when using ASM-based expiration, would be expired
| five years after being loaded into OnDemand since the data is passed to ASM at
| the same time it is loaded and ASM uses the date it receives the data to determine
| the length of time until it is expired.

| You should also be aware of the impact of changes made to the Life of Data and
| Indexes in an application group which is used by DSM to expire data and an
| expiration level in a migration policy which is used by ASM to expire data. A
| change to the Life of Data and Indexes will only impact the application group in
| which you are making the change. A change to the expiration level in the
| migration policy will affect all application groups that are using that particular
| migration policy.

| To configure OnDemand to eliminate the need for running DSM for new
| application groups, you must first define your application groups to:
| v not cache data
| v migrate data at load time
| You do this using the OnDemand Administrator client, on the Storage
| Management and Advanced Storage Management tabs of the application group
| definition. On the Storage Management tab, you must specify ’No’ for the Cache
| Data option, and on the Advanced Storage Management tab, you must specify

20 Common Server Administration Guide

| ’When Data is Loaded’ for the Migrate Data from Cache option. Note that when
| you specify ‘No’ for the Cache Data option, the Migrate Data from Cache option is
| automatically changed to ‘When Data is Loaded.’ For any OnDemand migration
| policy specified in an application group definition that does not use cache, you
| should also define an expiration level as the last level of the policy if you wish to
| have your data expire after a designated length of time.

| To configure OnDemand to eliminate the need for running DSM for existing
| application groups which already have data archived to them, you must first
| change your application groups to no longer cache the data. You must also specify
| to migrate data from cache at load time. You do this using the OnDemand
| Administrator client, on the Storage Management and Advanced Storage
| Management tabs of the application group definition. On the Storage Management
| tab, specify ’No’ for the Cache Data option, and on the Advanced Storage
| Management tab, specify ’When Data is Loaded’ for the Migrate Data from Cache
| option. Note that when you specify ‘No’ for the Cache Data option, the Migrate
| Data from Cache option is automatically changed to ‘When Data is Loaded.’ Note
| also that the change to the Cache Data option will be retroactive for data that is
| already stored in cache. For example, if you originally specified 90 days for the
| Cache Data option and then you change this option to ’No,’ all the data still in the
| CACHE directory for this application group will be removed the next time DSM is
| run. Note, if you archive AFP data, you may notice AFP resource objects remaining
| in the CACHE directory. This behavior is to be expected.

| ASM-based expiration also requires that the IBM i user profile that owns the
| OnDemand instance library be added to the instance as a System Administrator.
| (The user profile of the instance owner has the same name as the instance, for
| example QUSROND.) You can add this user to the OnDemand instance using the
| OnDemand Administrator client. Note that new instances created after installing or
| upgrading to OnDemand 7.1 or higher will have this user profile added to the
| instance automatically when the instance is created. Instances that were created
| prior to OnDemand 7.1 will require that this user profile be added to the
| OnDemand instance manually.

| If you make the changes described, you are no longer required to run DSM. As
| data is loaded into OnDemand, a copy of the data is placed in the ASMREQUEST
| directory. When ASM is run, it takes the data from the ASMREQUEST directory
| and processes it based on the information in the migration policy defined in the
| application group. ASM will manage the data for the life of the data specified by
| the levels defined in the migration policy. When the expiration level is reached,
| assuming one is specified in the migration policy, ASM will remove the data from
| the storage media and make a request to the server to also remove the index data.
| If there is no expiration level defined in the migration policy for the data, then the
| data will never be removed.

| Important: Archive Storage Manager-based expiration is not compatible with the

| Hold and Release capabilities of OnDemand (known as enhanced retention
| management). This incompatibility is due to the fact that ASM does not check for
| holds before expiring documents.

Document storage 21
22 Common Server Administration Guide
|

| Using a Network File System (NFS) directory for document

| storage
| Network File System (NFS) is a distributed file system implementation providing
| remote, transparent access to files and directories. OnDemand can use an NFS
| exported directory as a disk pool for document storage.

| A few key points regarding NFS include the following:

| v You make a directory or an object available to NFS clients by exporting it.
| Therefore, you have very specific control over which parts of your system you
| will make available to NFS clients in your network.
| v When you export, you can specify which clients have access to the objects. You
| identify a client by system name or IP address.
| v You make a directory or an object available on your NFS client by mounting it.
| v When you mount remote server file systems over local client directories, you
| allow System i servers to work with file systems that have been exported from a
| remote server. The mounted file systems will act and perform as if they exist on
| the local server.
| v The NFS does not provide password protection. It is designed and intended for
| data sharing within a trusted community of systems. When a user requests
| access, the server receives the user’s User ID number (UID). The UID is used to
| determine the permissions of the user.
| v When using NFS with OnDemand, note that directories located in an
| Independent ASP (IASP) cannot be mounted over an NFS exported directory.
| This limitation affects only installations that locate a complete instance,
| including the instance library, within an IASP.

| More information on NFS can be found within the IBM i information center at
| http://www.ibm.com/systems/i/infocenter/
| “Setting up an NFS disk pool”
| “Example scenario” on page 24
| “Special consideration for UIDs” on page 26
|
| Setting up an NFS disk pool
| About this task

| To setup an NFS disk pool to use for OnDemand document storage, follow these
| steps:
| 1. Access the OnDemand Archive plug-in of System i Navigator.
| 2. Expand Common Server Administration.
| 3. Click NFS Storage Groups.
| 4. Enter the instance name, pool number (2 through 32), pool type (primary or
| backup) and NFS path name (in the form hostname:path) for which the NFS
| disk pool should be defined. For example, you might enter QUSROND for the
| instance name, 7 for the pool number, select Primary for the pool type, and
| specify host name RDR400X.RTP.RALEIGH.IBM.COM and
| /NFSSTG/YQUSROND/PRIMARY as the path name. Note that if you use an

© Copyright IBM Corp. 1991, 2010 23

| existing pool number, its contents will not be accessible after the file system is
| mounted. You should use a pool number that is not already in use by a
| physical ASP on your system.
|
| Example scenario
| In our example NFS scenario, we will use two IBM i servers. One server is called
| the Archive System, where OnDemand is running and where the NFS directory is
| mounted. The other server is called the Storage System, where the NFS directory is
| exported, and where OnDemand stores objects.

| Archive System – RDR400Y - OnDemand is running here. Instance name is

| QUSROND. NFS directory is mounted.

| Storage System – RDR400X - NFS directory is exported. OnDemand objects are

| stored here.
| “On the Storage System (RDR400X)”
| “On the Archive System (RDR400Y)” on page 25

| On the Storage System (RDR400X)

| In this example, we need to create a user profile on the Storage System with the
| same UID as the instance profile on the Archive System. Objects created on the
| Storage System will be owned by this user profile. On the Archive System,
| QUSROND has a UID of 588. You can use the Create User Profile (CRTUSRPRF)
| command as shown to create the companion user profile on the Storage System.
| Note that we specify the same language parameters as used on the Archive
| System.
| CRTUSRPRF USRPRF(YQUSROND) USRCLS(*PGMR) INLPGM(*NONE) INLMNU(*SIGNOFF)
| LMTCPB(*NO) TEXT('ONDEMAND NFS MOUNT PROFILE') SPCAUT(*IOSYSCFG
| *JOBCTL *SAVSYS) GRPPRF(QRDARS400) LANGID(ENU) CNTRYID(US) CCSID(37)
| CHRIDCTL(*JOBCCSID) SETJOBATR(*CCSID *DATFMT *DATSEP *DECFMT *SRTSEQ *TIMSEP)
| LOCALE('/QSYS.LIB/EN_US.LOCALE') UID(588)

| If the needed UID is already in use, see “Special consideration for UIDs” on page
| 26 for information on changing the UID of an existing user profile.

| We then create the following directories and subdirectories in IFS on the Storage
| System for use with NFS:
| /NFSSTG/YQUSROND/PRIMARY
| /NFSSTG/YQUSROND/BACKUP

| To automatically export the file systems when the NFS server is started, update the
| /etc/EXPORTS file in IFS on the Storage System (which is RDR400X in our
| example).

| The /etc/EXPORTS file for our example would look like the following:
| /NFSSTG/YQUSROND/PRIMARY root=RDR400Y.RTP.RALEIGH.IBM.COM, \
| access=RDR400Y.RTP.RALEIGH.IBM.COM, \
| rw=RDR400Y.RTP.RALEIGH.IBM.COM \
| #HOSTOPT HostName=RDR400Y.RTP.RALEIGH.IBM.COM, \
| NoWaitForWrites
| /NFSSTG/YQUSROND/BACKUP root=RDR400Y.RTP.RALEIGH.IBM.COM, \
| access=RDR400Y.RTP.RALEIGH.IBM.COM, \
| rw=RDR400Y.RTP.RALEIGH.IBM.COM \
| #HOSTOPT HostName=RDR400Y.RTP.RALEIGH.IBM.COM, \
| NoWaitForWrites

24 Common Server Administration Guide

| Start the NFS servers using System i Navigator or with this command:
| STRNFSSVR SERVER(*ALL)

| The job log contains these messages:

| Start of NFS server daemon or daemons of type *RPC was successful.
| Start of NFS server daemon or daemons of type *BIO was successful.
| 2 entries exported, 0 entries not exported.
| Start of NFS server daemon or daemons of type *SVR was successful.
| Start of NFS server daemon or daemons of type *MNT was successful.
| Start of NFS server daemon or daemons of type *NSM was successful.
| Start of NFS server daemon or daemons of type *NLM was successful.
| Start NFS server command completed successfully.

| Notes®:
| v The user starting NFS servers must have input/output (I/O) system
| configuration (*IOSYSCFG) special authority to use this command.
| v The user starting NFS servers must be enrolled in the system distribution
| directory. Use the Add Directory Entry (ADDDIRE) command to enroll the user.

| To determine if an NFS server is running, use the Work with Active Jobs
| (WRKACTJOB) command and look in the subsystem QSYSWRK for existence of
| the following jobs:
| v QNFSRPCD - the RPCBind daemon
| v QNFSBIOD - the block I/O (BIO) daemon
| v QNFSNFSD - the NFS server (SVR) daemon
| v QNFSMNTD - the mount (MNT) daemon
| v QNFSNSMD - the network status monitor (NSM) daemon
| v QNFSNLMD - the network lock manager (NLM) daemon

| If necessary, you can manually export or unexport the directories. To export all
| entries in /etc/EXPORTS:
| EXPORTFS OPTIONS('-A')

| To unexport all entries in /etc/EXPORTS:

| EXPORTFS OPTIONS('-A -U')

| You can also use System i Navigator to export or unexport directories.

| On the Archive System (RDR400Y)

| To setup a primary NFS disk pool to use for OnDemand on the Archive System,
| follow the steps as described in “Setting up an NFS disk pool” on page 23 using
| the values as shown in the example, such as QUSROND for instance name, 7 for
| ASP, and so on.

| Then, create a backup disk pool using the same values as the primary disk pool,
| with the exception of selecting Backup instead of Primary for disk pool type.

| Next, create or update an OnDemand migration policy to use the NFS disk pools.
| Migration policies are also created using System i Navigator. More information on
| migration policies can be found in “Migration Policies” on page 65.

Using a Network File System (NFS) directory for document storage 25

| Typically, the NFS mounts are done automatically, when required by the
| OnDemand Archive Storage Manager (ASM) to migrate or retrieve data. Message
| queue QSYSOPR will contain message CPCA1B0 when the NFS mount is
| performed by ASM. For example:
| File system /NFSSTG/YQUSROND/PRIMARY was successfully mounted over
| directory /QIBM/USERDATA/ONDEMAND/QUSROND/ASMASP07/PRIMARY.

| If you need to manually mount the NFS, use the MOUNT command, for example:
| MOUNT TYPE(*NFS) MFS('rdr400x.rtp.raleigh.ibm.com:/NFSSTG/YQUSROND/PRIMARY')
| MNTOVRDIR('/QIBM/UserData/OnDemand/QUSROND/ASMASP07/PRIMARY')

| If you need to manually unmount the NFS, use the UNMOUNT command, for
| example:
| UNMOUNT TYPE(*NFS)
| MNTOVRDIR('/QIBM/UserData/OnDemand/QUSROND/ASMASP07/PRIMARY')

| To verify that the NFS is mounted, use either of the STATFS or DSPMFSINF
| commands.
| STATFS OBJ('/QIBM/UserData/OnDemand/QUSROND/ASMASP07/PRIMARY')

| Output from the STATFS and DSPMFSINF commands will be similar to the
| following:
| Display Mounted FS Information
| Object . . . . . . . . . . . . : /QIBM/UserData/OnDemand/QUSROND/ASMASP07/PRIMARY
| File system type . . . . . . . : Network File System (NFS)
| (If File system type . . . . . . . : "root" (/) then the NFS is not mounted)
| ...
| Path of mounted file system . : rdr400x.rtp.raleigh.ibm.com:/NFSSTG/YQUSROND/PRIMARY
| Path mounted over . . . . . . : /QIBM/UserData/OnDemand/QUSROND/ASMASP07/PRIMARY
| Protection . . . . . . . . . . : Read-write
| ...

| Note:
| v The NFS servers do not need to be running on the Archive System.
|
| Special consideration for UIDs
| You might discover that you need to change UIDs, even for IBM-supplied user
| profiles, to have compatibility with other systems in your network. When you
| change the UID for a user profile, you also need to change the UID for all the
| objects that the profile owns in either the root directory or the QOpenSrv directory.

| An API is available to make it simpler to change the UID for a user profile. The
| QSYCHGID API automatically changes the UID in both the user profile and all the
| owned objects. Source code examples for a sample program and sample command
| using the QSYCHGID API are provided in the QSAMPLES2 source file in the
| QUSRRDARS library. Source member CHGUID with a Type of CLP contains a
| sample CL program that calls the QSYCHGID API. Source member CHGUID with
| a Type of CMD contains sample command source that runs the CHGUID CL
| program. An example of how to create the CL program or command is included in
| the comments section at the top of each sample source member.

| The source is provided as an example only. It may not completely satisfy your
| specific requirements. For more information on the QSYCHGID API, search on
| ″security-related APIs″ within the i5/OS Information Center.

26 Common Server Administration Guide

|

| Using Tivoli Storage Manager

| By default, Archive Storage Manager (ASM) is the standard (and only) storage
| manager for OnDemand on an IBM i server. You can also use IBM Tivoli Storage
| Manager (TSM) in addition to ASM or in place of ASM, or simply as another
| media choice for use in ASM migration policies. Use the instructions found in
| “Using Tivoli Storage Manager as a separate storage manager” or “Using Tivoli
| Storage Manager as an ASM migration policy level” on page 35 to set up and use
| IBM Tivoli Storage Manager in your OnDemand environment.
| “Using Tivoli Storage Manager as a separate storage manager”
| “Using Tivoli Storage Manager as an ASM migration policy level” on page 35
|
| Using Tivoli Storage Manager as a separate storage manager
| You can use IBM Tivoli Storage Manager (TSM) in addition to ASM or in place of
| ASM using the instructions in this section. Using this configuration, data that is
| already stored into ASM cannot be migrated to Tivoli Storage Manager, nor can
| data in Tivoli Storage Manager be migrated to ASM. A second option is to simply
| use IBM Tivoli Storage Manager as another media choice within a migration policy
| for use with ASM. For information on that configuration, see “Using Tivoli Storage
| Manager as an ASM migration policy level” on page 35.
| “Hardware prerequisites”
| “Software prerequisites”
| “Setting up Tivoli Storage Manager as a separate storage manager”
| “Use instructions” on page 33

| Hardware prerequisites
| IBM Tivoli Storage Manager support requires an external Tivoli Storage Manager
| server to be installed, configured, and fully operational. For details on configuring
| a Tivoli Storage Manager server, see the Tivoli Storage Manager reference
| documentation at http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/
| index.jsp.

| Software prerequisites
| For software requirements to enable IBM Tivoli Storage Manager, see
| http://www.ibm.com/support/docview.wss?rs=152&uid=swg27016180

| Setting up Tivoli Storage Manager as a separate storage

| manager
| About this task

| To install and configure IBM Tivoli Storage Manager as a separate storage

| manager, follow these general steps:
| 1. Install the Tivoli Storage Manager APIs on the IBM i system.
| 2. Update your Content Manager OnDemand ars.cfg file.

© Copyright IBM Corp. 1991, 2010 27

| 3. Create or update your dsm.opt file. IBM recommends that you create a dsm.opt
| file for each instance. This method provides maximum flexibility in configuring
| TSM support.
| 4. Create or update your dsm.sys file.
| 5. Configure Content Manager OnDemand to use Tivoli Storage Manager by
| doing one of the following:
| v Create a storage set and storage node for Tivoli Storage Manager.
| v Update an existing storage set with a new storage node (if you plan to
| change an existing application group from using ASM to Tivoli Storage
| Manager).
| 6. Verify your Tivoli Storage Manager storage set and storage node.
| “Install the Tivoli Storage Manager APIs on your IBM i system”
| “Update your OnDemand ars.cfg file”
| “Create or update your dsm.opt file” on page 29
| “Create or update your dsm.sys file” on page 30
| “Configure OnDemand to use Tivoli Storage Manager” on page 30
| “Verify your Tivoli Storage Manager storage set and storage node” on page 32

| Install the Tivoli Storage Manager APIs on your IBM i system

| About this task

| To install the IBM Tivoli Storage Manager APIs:

| 1. Go to ftp://ftp.software.ibm.com/storage/tivoli-storage-management/
| maintenance/client.
| 2. Open the highest level folder (for example, v6r1 → OS400), and then open the
| folder of the highest release level listed (for example, v610).
| 3. Copy the file 6.1.0.0-TIV-TSMBAC-OS400.exe to your workstation.
| 4. Read and follow the installation instructions in the file named
| 6.1.0.0-TIV-TSMBAC-OS400.README.FTP on the FTP site.

| Update your OnDemand ars.cfg file

| “Add the ARS_STORAGE_MANAGER=TSM entry”
| “Add the DSMI_DIR=, DSMI_CONFIG=, and DSMI_LOG= entries” on page 29

| Add the ARS_STORAGE_MANAGER=TSM entry:

| About this task

| IBM Tivoli Storage Manager support is enabled by adding specific lines to the
| ars.cfg file. The ars.cfg file is located in the IFS on your IBM i server in the
| /QIBM/UserData/OnDemand/instancename directory, where instancename is the name
| of the Content Manager OnDemand instance for which you want to enable Tivoli
| Storage Manager support.
| 1. Modify the ars.cfg file by adding these lines:
| #
| # TIVOLI STORAGE MANAGER (TSM) ENABLEMENT
| ARS_STORAGE_MANAGER=TSM
| 2. Save the file.

28 Common Server Administration Guide

| Results

| When the Content Manager OnDemand server detects this entry, it enables both
| Tivoli Storage Manager and ASM as storage managers for this particular Content
| Manager OnDemand instance.

| Add the DSMI_DIR=, DSMI_CONFIG=, and DSMI_LOG= entries:

| About this task

| When IBM Tivoli Storage Manager is enabled, the server looks for particular
| configuration files.

| To tell Tivoli Storage Manager where these configuration files reside:

| 1. Open the ars.cfg file located in /QIBM/UserData/OnDemand/instance_name,
| where instance_name is the name of the OnDemand instance for which you are
| modifying the ars.cfg file.
| 2. Add the following lines:
| #
| # TIVOLI STORAGE MANAGER (TSM) CONFIGURATION FILE LOCATIONS
| DSMI_DIR=/QIBM/UserData/Tivoli/TSM/Client/API/bin
| DSMI_CONFIG=/QIBM/UserData/OnDemand/QUSROND/dsm.opt
| DSMI_LOG=/QIBM/UserData/OnDemand/QUSROND/TMP

| where QUSROND may need to be replaced by your instance name, if you are
| not using the default QUSROND instance. The DSMI_DIR entry specifies the
| directory that contains the TSM API files. The DSMI_CONFIG entry specifies
| the full path name of the TSM API options file. The DSMI_LOG entry specifies
| the directory in which TSM stores the TSM API error log. You should copy the
| above lines verbatim, with no modifications except for the instance name.

| What to do next

| After you have updated the ars.cfg file, stop and restart your instance for the
| changes to take effect.

| Create or update your dsm.opt file

| To enable IBM Tivoli Storage Manager support, a file named dsm.opt must exist,
| and it must contain the name of a server that is listed in your dsm.sys file. The
| dsm.opt file must exist in IFS on your IBM i server in the /usr/tivoli/tsm/client/
| api/bin directory. This path is specified in the ars.cfg file, as the value of the
| DSMI_CONFIG entry.

| IBM recommends creating a separate dsm.opt file for each instance configured for
| use with TSM. In our example, for instance QUSROND, the dsm.opt file is located
| at /QIBM/UserData/OnDemand/QUSROND. This path is the path specified in
| the DSMI_CONFIG= entry you just added to the ars.cfg file in the previous step.

| The following example shows a dsm.opt file, where the Tivoli Storage Manager
| server name is TSMSERVER. Note that this example can also be found on your
| IBM i server in the /QIBM/UserData/Tivoli/TSM/Client/API/bin directory in the
| file dsm.opt.smp. You can copy the dsm.opt.smp file to a file named dsm.opt in the
| same directory to help ensure the dsm.opt file is correct.
| ***************************************************************************
| * Tivoli Storage Manager *
| * *
| * Client User Options file for OS/400 (dsm.opt) *

Using Tivoli Storage Manager 29

| ***************************************************************************
| * This file contains an option you can use to specify the TSM
| * server to contact if more than one is defined in your client
| * system options file (dsm.sys).
| ***************************************************************************
|
| SErvername TSMSERVER

| Create or update your dsm.sys file

| To enable IBM Tivoli Storage Manager support, a file named dsm.sys must also
| exist, and it must contain a section for each Tivoli Storage Manager server that
| Content Manager OnDemand will communicate with. The server name specified in
| the first line of the section must match the name of a server that is listed in your
| dsm.opt file. The file must exist in IFS on your IBM i server in the directory path
| specified in the DSMI_DIR= entry you added to the ars.cfg file.

| The following example shows a dsm.sys file, in which the Tivoli Storage Manager
| server name is TSMSERVER. Note that this example can also be found on your
| IBM i server in the /QIBM/UserData/Tivoli/TSM/Client/API/bin directory in the
| file dsm.sys.smp. You can copy the sample dsm.sys.smp file to a file named dsm.sys
| (in the same directory) to help ensure the dsm.sys file you create is correct.
| ***************************************************************************
| * Tivoli Storage Manager *
| * *
| * Client System Options file for OS/400 (dsm.sys) *
| ***************************************************************************
| * This file contains the minimum options required to get started
| * using TSM. Copy dsm.sys.smp to dsm.sys. In the dsm.sys file,
| * enter the appropriate values for each option listed below.
| * If your client node communicates with multiple TSM servers, be
| * sure to add a stanza, beginning with the SERVERNAME option, for
| * each additional server.
| ***************************************************************************
|
| Servername TSMSERVER
| COMMMethod TCPip
| TCPPort 1500
| TCPServeraddress tsmserver.company.com
| COMPRESSION OFF
| ENABLEARCHIVERETENTIONPROTECTION YES

| Enter these lines as shown, with no modifications, except for the following:
| TSMSERVER
| Tivoli Storage Manager Server alias. Use this value or replace it with a
| name of your choice. The name does not need to match any particular part
| of your Content Manager OnDemand or Tivoli Storage Manager
| configuration, but it must match the value used in the dsm.opt file.
| tsmserver.company.com
| Replace this with the host name or TCP/IP address of your Tivoli Storage
| Manager server.

| Configure OnDemand to use Tivoli Storage Manager

| Controlling which storage manager an application group uses is determined by the
| storage set (and the corresponding storage nodes) associated with the application
| group. By design, you cannot use the IBM Content Manager OnDemand
| Administrator Client to create or maintain storage sets and storage nodes. This use
| of the administrator client is disabled for IBM i servers, because the storage sets
| and storage nodes needed for ASM are automatically added by the System i

30 Common Server Administration Guide

| Navigator Content Manager OnDemand Archive plug-in when you create a
| migration policy. However, storage sets and storage nodes for use with IBM Tivoli
| Storage Manager must be added or modified by using the Content Manager
| OnDemand ARSXML API running within the QSHELL environment on your i
| server.

| Depending on your requirements, you can choose to create a new storage set and
| corresponding storage node for Tivoli Storage Manager, or you can choose to
| update an existing storage set with a new storage node for Tivoli Storage Manager.
| Only one of the two sets of instructions needs to be performed, although you can
| choose to do both if you have requirements to use both new and existing storage
| sets for Tivoli Storage Manager.
| “Create the OnDemand storage set and storage node”
| “Update an existing storage set with a new storage node”

| Create the OnDemand storage set and storage node:

| Use this procedure if you plan to create a new storage set and storage node to use
| with a new application group.

| This is an example of an XML file (that might be named addtsmstorageset.xml as

| shown in the example ARSXML API call) that could be used as input to the
| ARSXML API to create the new storage set and storage node:
| ************Beginning of data**************
| <?xml version="1.0" encoding="UTF-8" ?>
| <onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
| xsi:noNamespaceSchemaLocation="/QIBM/ProdData/OnDemand/bin/xml/ondemand.xsd">
| <storageSet name="TSMSET" description="Tivoli Storage Manager" >
| <node name="TSMNODE" description="TSM Node" server="*ONDEMAND"
| logon="tsmnode" password="password" loadData="true" accessMethod="TSM" />
| </storageSet>
| </onDemand>
| ************End of Data********************

| This is an example of the ARSXML API call (run within QSHELL on your IBM i
| server) to add a storage set and storage node for IBM Tivoli Storage Manager:
| arsxml add -h QUSROND -i /home/dbryant/addtsmstorageset.xml -v

| This is an example of the messages resulting from the ARSXML API call:
| ondemandTitleStr=[QRDARS/ARSXML add -h QUSROND -i
| /home/dbryant/addtsmstorageset.xml -v ]
| command=[java -Djava.library.path=/qsys.lib/qrdars.lib -cp
| "/QIBM/PRODDATA/ONDEMAND/BIN/xml/ODAdmin.jar:/usr/xerces-2_9_1/xercesI
| mpl.jar:/usr/xerces-2_9_1/xml-apis.jar" com.ibm.cm.od.ArsXMLbat add
| -h QUSROND -i /home/dbryant/addtsmstorageset.xml -v ]
| Starting arsxml. Version: 8.4.0.3
| Command Line: arsxml add -h QUSROND -i /home/dbryant/addtsmstorageset.xml -v
| 10/07/09 14:21:16: Attempting login for userid '' on server 'QUSROND' ...
| 10/07/09 14:21:16: Login successful
| 10/07/09 14:21:19: Adding storageSet, TSMSET
| 10/07/09 14:21:19: Add of storageSet, TSMSET was successful.
| 10/07/09 14:21:19: Adding storageSet-node, TSMSET-TSMNODE
| 10/07/09 14:21:19: Add of storageSet-node, TSMSET-TSMNODE was successful.
| 10/07/09 14:21:19: Finished processing file /home/dbryant/addtsmstorageset.xml.

| For more information about the ARSXML API and invoking Content Manager
| OnDemand APIs within QSHELL, see “API and user exit reference” on page 213.

| Update an existing storage set with a new storage node:

Using Tivoli Storage Manager 31

| Use this procedure if you plan to change an existing application group from using
| ASM to using IBM Tivoli Storage Manager.

| If you have an existing application group that is currently using ASM, and you
| want to change it to use Tivoli Storage Manager, you can update the existing
| storage group (that is named in the application group definition) to add a Tivoli
| Storage Manager storage node, and then change the storage node designated for
| loading data to point to the new Tivoli Storage Manager storage node.

| This is an example of an XML file (that might be named addtsmnode.xml as

| shown in the example ARSXML API call) that could be used as input to the
| ARSXML API to create the storage node for an existing storage set named
| LONGTERM, and to designate the new node to be used for loading data, instead
| of the node also named LONGTERM:
| ************Beginning of data**************
| <?xml version="1.0" encoding="UTF-8" ?>
| <onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
| xsi:noNamespaceSchemaLocation="/QIBM/ProdData/OnDemand/bin/xml/ondemand.xsd">
| <storageSet name="LONGTERM" >
| <node task="update" name="LONGTERM" loadData="false" logon=" " password=" " /
| <node task="add" name="TSMNODE" description="TSM Node" server="*ONDEMAND"
| logon="tsmnode" password="password" loadData="true" accessMethod="TSM" />
| </storageSet>
| </onDemand>
| ************End of Data********************

| This is an example of the ARSXML API call (run within QSHELL on your IBM i
| server) to create the storage node for IBM Tivoli Storage Manager:
| arsxml update -h QUSROND -i /home/dbryant/addtsmnode.xml -v

| This is an example of the messages resulting from the ARSXML API call:
| ondemandTitleStr=[QRDARS/ARSXML update -h QUSROND -e c -i
| /home/dbryant/addtsmnode.xml -v ]
| command=[java -Djava.library.path=/qsys.lib/qrdars.lib -cp
| "/QIBM/PRODDATA/ONDEMAND/BIN/xml/ODAdmin.jar:/usr/xerces-2_9_1/xercesI
| mpl.jar:/usr/xerces-2_9_1/xml-apis.jar" com.ibm.cm.od.ArsXMLbat update
| -h QUSROND -e c -i /home/dbryant/addtsmnode.xml -v ]
| Starting arsxml. Version: 8.4.1.2
| Command Line: arsxml update -h QUSROND -e c -i /home/dbryant/addtsmnode.xml -v
| 10/07/09 14:59:37: Attempting login for userid '' on server 'QUSROND' ...
| 10/07/09 14:59:37: Login successful
| 10/07/09 14:59:39: Updating storageSet, LONGTERM
| 10/07/09 14:59:39: Updating storageSet-node, LONGTERM-LONGTERM
| 10/07/09 14:59:40: Update of storageSet-node, LONGTERM-LONGTERM was successful.
| 10/07/09 14:59:39: Adding storageSet-node, LONGTERM-TSMNODE
| 10/07/09 14:59:40: Add of storageSet-node, LONGTERM-TSMNODE was successful.
| 10/07/09 14:59:40: Update of storageSet, LONGTERM was successful.
| 10/07/09 14:59:40: Finished processing file /home/dbryant/addtsmnode.xml.

| For more information about the ARSXML API and invoking Content Manager
| OnDemand APIs within QSHELL, see “API and user exit reference” on page 213.

| Verify your Tivoli Storage Manager storage set and storage node
| After you have successfully run the ARSXML API, you can use the OnDemand
| Administrator client to confirm the correct setup by viewing the storage set
| definition you are using for IBM Tivoli Storage Manager. In the Storage Nodes list
| box, nodes that are used to load data are marked with an asterisk (*).

32 Common Server Administration Guide

| Use instructions
| IBM Tivoli Storage Manager processing is invoked in one of two ways:
| v When data is loaded into Content Manager OnDemand (if Migrate Data From
| Cache is set to When Data is Loaded on the Advanced panel of the Storage
| Management tab within the application group definition). This process is
| invoked either by issuing the Add Report to OnDemand (ADDRPTOND)
| command, or by issuing the Start Monitor for OnDemand (STRMONOND)
| command.
| v As part of the OnDemand Disk Storage Management (DSM) process (if Migrate
| Data From Cache is set to After x Days in Cache on the Advanced panel of the
| Storage Management tab within the application group definition). This process is
| invoked by issuing the Start Disk Storage Management (STRDSMOND)
| command.

| No special parameters for data loading or the STRDSMOND command are

| required to trigger the Tivoli Storage Manager step. By configuring Tivoli Storage
| Manager support as described earlier, data loading and DSM will automatically
| invoke Tivoli Storage Manager as needed during processing. The Archive Storage
| Management process (ASM, started by the Start Archived Storage Mgmt
| (STRASMOND) command or the RUNASM(*YES) parameter of the STRDSMOND
| command) is not required unless other Content Manager OnDemand data is
| managed by ASM in addition to the Content Manager OnDemand data managed
| by Tivoli Storage Manager.
| “Checking objects in Tivoli Storage Manager”
| “Object naming on the Tivoli Storage Manager server” on page 34
| “Additional information” on page 34

| Checking objects in Tivoli Storage Manager

| After you start storing data, you can use the following commands to check the
| status of objects archived to IBM Tivoli Storage Manager. For more information
| about administering a Tivoli Storage Manager server, see the Tivoli Storage
| Manager documentation at http://publib.boulder.ibm.com/infocenter/tivihelp/
| v1r1/index.jsp.
| “Integrated Solutions Console”
| “Command Line”

| Integrated Solutions Console:

| The IBM Integrated Solutions Console (ISC) with the Tivoli Storage Manager
| Administration Center can be used to check statistics, such as capacity and percent
| utilized. For information on installing and using the Administration Center, see the
| Tivoli Storage Manager documentation at http://publib.boulder.ibm.com/
| infocenter/tivihelp/v1r1/index.jsp.

| Command Line:
| About this task

| You can also use the IBM Tivoli Storage Manager Administrative Client Command
| Line (dsmadmc) to check statistics. To install the Administrative Client Command
| Line files, you must select Custom Setup when installing the Tivoli Storage
| Manager clients. From the Windows Start menu, select All Programs → Tivoli
| Storage Manager → Administrative Command Line. Log onto the Tivoli Storage
| Manager server and enter your commands.

Using Tivoli Storage Manager 33

| Object naming on the Tivoli Storage Manager server
| Objects sent to IBM Tivoli Storage Manager use the following naming convention.
| (Note that objects sent to IBM Tivoli Storage Manager by ASM using a IBM Tivoli
| Storage Manager migration policy level have a different naming convention.)
|| Item Example Comments
| FILESPACE_NAME: /ONDGY/ /instance name/AGID_Name (unless instance is
| CGA QUSROND, then the instance name is omitted)
| HL_NAME: /DOC always /DOC
| LL_NAME: /399FAA1 object name (which is the name created during the
| load process)
|

| Additional information
| v If Migrate Data from Cache is set to When Data is Loaded on the Advanced
| panel of the Storage Management tab in the Application group definition, the
| load will fail if IBM Tivoli Storage Manager is not running, or the
| communication connection cannot be made with the Tivoli Storage Manager
| server. The system log message 88 will contain entries similar to this:
| Connection cannot be established for the >tsmserver.company.com< server
| Unable to store the object >10FAAA<. Object size 40034
| Connection cannot be established for the >tsmserver.company.com< server
| Unable to unload data from OnDemand - LoadId(5048-14-0-10FAAA-11303-11303)
| Rows Deleted (0)
| 05/30/07 13:25:43 -- Unloading of data failed
| v If Migrate Data from Cache is set to Next Cache Migration on the Advanced
| panel of the Storage Management tab in the Application group definition, you
| must run DSM to migrate the data to Tivoli Storage Manager.
| v If the password of the Tivoli Storage Manager node expires, attempting to
| migrate data to Tivoli Storage Manager generates system log message 20 with
| entries similar to this:
| SM Error: ANS1352E (RS52) The session is rejected. Your password has expired.,
| RC=52, Reason=0, File=arssmsms.C, Line=531 Srvr- >ondemand.server.company.com
| 10.44.122.55<-
| v If the Tivoli Storage Manager node name is spelled incorrectly when the storage
| set is created, attempting to migrate data to Tivoli Storage Manager generates
| system log message 20 with entries similar to this:
| SM Error: ANS1352E (RC53) Session rejected: Unknown or incorrect ID entered,
| RC=53, Reason=0, File=arssmsms.C, Line=531, Srvr- >rdr400x.rtp.raleigh.ibm.com
| 9.42.125.55<-
| v After modifying the ars.cfg file to add Tivoli Storage Manager support, if the
| dsm.sys or dsm.opt files can not be found when the instance is started, the
| instance job will end with an OND1002 message in the job log. Message data
| will be similar to this:
| SM Error: ANS1087E (RC106) Access to the specified file or directory
| is denied , RC=106, Reason=0, File=arssmsms.C, Line=1042, Srvr-
| >rdr400x.rtp.raleigh.ibm.com
| v If the server specified in the dsm.opt file on the SErvername entry is not found
| in the dsm.sys file when the instance is started, the instance job will end with an
| OND1002 message in the job log. Message data will be similar to this:
| SM Error: ANS1217E (RC409) Server name not found in System Options
| File , RC=409, Reason=0, File=arssmsms.C, Line=1042, Srvr-
| >rdr400x.rtp.raleigh.ibm.com

34 Common Server Administration Guide

|
| Using Tivoli Storage Manager as an ASM migration policy level
| Follow these instructions to use IBM Tivoli Storage Manager as another media
| choice within a migration policy for use with ASM. Using this configuration, IBM
| Tivoli Storage Manager can be used in new or existing migration policies. Existing
| data can be migrated to IBM Tivoli Storage Manager. Aggregation can also be used
| for IBM Tivoli Storage Manager data. Dual write to two different IBM Tivoli
| Storage Manager storage groups is also supported. The two IBM Tivoli Storage
| Manager storage groups can be located on two physically separated IBM Tivoli
| Storage Manager servers.

| Another alternative is to use IBM Tivoli Storage Manager (TSM) as a separate

| storage manager, in addition to ASM or in place of ASM on your IBM i server. For
| information on that configuration, see “Using Tivoli Storage Manager as a separate
| storage manager” on page 27.
| “Hardware prerequisites”
| “Software prerequisites”
| “Setting up Tivoli Storage Manager as an ASM migration policy level”
| “Use instructions” on page 38

| Hardware prerequisites
| IBM Tivoli Storage Manager support requires an external Tivoli Storage Manager
| server to be installed, configured, and fully operational. For details on configuring
| a Tivoli Storage Manager server, see the Tivoli Storage Manager reference
| documentation at http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/
| index.jsp.

| Software prerequisites
| For software requirements to enable IBM Tivoli Storage Manager, see
| http://www.ibm.com/support/docview.wss?rs=152&uid=swg27016180

| Setting up Tivoli Storage Manager as an ASM migration policy

| level
| About this task

| To install and configure IBM Tivoli Storage Manager as an ASM migration policy
| level, follow these general steps:
| 1. Install the Tivoli Storage Manager APIs on the IBM i system.
| 2. Create or update your dsm.opt file. IBM recommends that you create a dsm.opt
| file for each instance. This method provides maximum flexibility in configuring
| TSM support.
| 3. Create or update your dsm.sys file.
| 4. Create a Tivoli Storage Manager storage group using System i Navigator.
| 5. Create a new, or update an existing, ASM migration policy to use the new
| Tivoli Storage Manager storage group.
| “Install the Tivoli Storage Manager APIs on your IBM i system” on page 36
| “Create or update your dsm.opt file” on page 36
| “Create or update your dsm.sys file” on page 36
| “Create a Tivoli Storage Manager storage group” on page 37
Using Tivoli Storage Manager 35
| “Create a new or update an existing migration policy” on page 37

| Install the Tivoli Storage Manager APIs on your IBM i system

| About this task

| To install the IBM Tivoli Storage Manager APIs:

| 1. Go to ftp://ftp.software.ibm.com/storage/tivoli-storage-management/
| maintenance/client.
| 2. Open the highest level folder (which was v6r1 → OS400 at the time this
| document was created), and open the folder of the highest release level listed
| (v610 at the time this document was created).
| 3. Copy the file 6.1.0.0-TIV-TSMBAC-OS400.exe to your workstation.
| 4. Read and follow the installation instructions in the file named
| 6.1.0.0-TIV-TSMBAC-OS400.README.FTP on the FTP site.

| Create or update your dsm.opt file

| To enable IBM Tivoli Storage Manager support, a file named dsm.opt must exist,
| and it must contain the name of a server that is listed in your dsm.sys file. The
| dsm.opt file must exist in IFS on your IBM i server in the /usr/tivoli/tsm/client/
| api/bin directory. This path is specified in the ars.cfg file, as the value of the
| DSMI_CONFIG entry.

| IBM recommends creating a separate dsm.opt file for each instance configured for
| use with TSM. In our example, for the instance named QUSROND, the dsm.opt file
| is located at /QIBM/UserData/OnDemand/QUSROND (which is the path
| specified as the Options file location in the Tivoli Storage Manager storage group
| you will create in a later step.

| The following example shows a dsm.opt file, where the Tivoli Storage Manager
| server name is TSMSERVER. Note that this example can also be found on your
| IBM i server in the /QIBM/UserData/Tivoli/TSM/Client/API/bin directory in the
| file dsm.opt.smp. You can copy the dsm.opt.smp file to a file named dsm.opt in the
| directory named in the Options file location to help ensure the dsm.opt file is
| correct.
| ***************************************************************************
| * Tivoli Storage Manager *
| * *
| * Client User Options file for OS/400 (dsm.opt) *
| ***************************************************************************
| * This file contains an option you can use to specify the TSM
| * server to contact if more than one is defined in your client
| * system options file (dsm.sys).
| ***************************************************************************
|
| SErvername TSMSERVER

| Create or update your dsm.sys file

| To enable IBM Tivoli Storage Manager support, a file named dsm.sys must also
| exist, and it must contain a section for each Tivoli Storage Manager server that
| Content Manager OnDemand will communicate with. The server name specified in
| the first line of the section must match the name of a server that is listed in your
| dsm.opt file. The file must exist in IFS on your IBM i server in the path specified as
| the Directory code location in the IBM Tivoli Storage Manager storage group you
| will create in a later step.

36 Common Server Administration Guide

| The following example shows a dsm.sys file, in which the Tivoli Storage Manager
| server name is TSMSERVER. Note that this example can also be found on your
| IBM i server in the /QIBM/UserData/Tivoli/TSM/Client/API/bin directory in the
| file dsm.sys.smp. You can copy the sample dsm.sys.smp file to a file named dsm.sys
| (in the Directory code location) to help ensure the dsm.sys file you create is correct.
| ***************************************************************************
| * Tivoli Storage Manager *
| * *
| * Client System Options file for OS/400 (dsm.sys) *
| ***************************************************************************
| * This file contains the minimum options required to get started
| * using TSM. Copy dsm.sys.smp to dsm.sys. In the dsm.sys file,
| * enter the appropriate values for each option listed below.
| * If your client node communicates with multiple TSM servers, be
| * sure to add a stanza, beginning with the SERVERNAME option, for
| * each additional server.
| ***************************************************************************
|
| Servername TSMSERVER
| COMMMethod TCPip
| TCPPort 1500
| TCPServeraddress tsmserver.company.com
| COMPRESSION OFF
| ENABLEARCHIVERETENTIONPROTECTION YES

| It is recommended that you enter these lines as shown, with no modifications,

| except for the following:
| TSMSERVER
| Tivoli Storage Manager Server alias. Use this value or replace it with a
| name of your choice. The name does not need to match any particular part
| of your Content Manager OnDemand or Tivoli Storage Manager
| configuration, but it must match the value used in the dsm.opt file.
| tsmserver.company.com
| Replace this with the host name or TCP/IP address of your Tivoli Storage
| Manager server.

| Create a Tivoli Storage Manager storage group

| Use the TSM Storage Groups option of the OnDemand Archive plug-in of System i
| Navigator to create a Tivoli Storage Manager storage group. Using the OnDemand
| Archive plug-in of System i Navigator, right click TSM Storage Groups and then
| select New OnDemand TSM Storage Group to display the Tivoli Storage Manager
| (TSM) Definition panel. On this panel, you specify the name of the Client node,
| which is the Tivoli Storage Manager node name created for use with OnDemand.
| You also specify the Password, which is the Tivoli Storage Manager node password
| used by the Tivoli Storage Manager APIs to sign on to Tivoli Storage Manager. The
| Options and Log file locations are filled in based on the instance name but can be
| changed if, for example, you want to use one dsm.opt file for all instances (which
| is not recommended).

| Create a new or update an existing migration policy

| After you have created an OnDemand Tivoli Storage Manager storage group, you
| need to create or update an OnDemand migration policy to use it. To do this, use
| the OnDemand Archive plug-in of System i Navigator. Whether you are creating a
| new migration policy or updating an existing one, click the Add Before or Add
| After button in the bottom right section of the first migration policy panel. Select
| TSM for the Primary media type. Then select your new Tivoli Storage Manager
| storage group from the pulldown for Primary storage group.

Using Tivoli Storage Manager 37

| If you add a Tivoli Storage Manager level to an existing migration policy, you can
| use the Change Policy Level Date (CHGPLDOND) command to change the next
| level date for existing archives. Then run ASM to move existing data to Tivoli
| Storage Manager.

| Use instructions
| IBM Tivoli Storage Manager processing is invoked in one of two ways:
| v When data is loaded into Content Manager OnDemand (if Migrate Data From
| Cache is set to When Data is Loaded on the Advanced panel of the Storage
| Management tab within the application group definition). This process is
| invoked either by issuing the Add Report to OnDemand (ADDRPTOND)
| command, or by issuing the Start Monitor for OnDemand (STRMONOND)
| command.
| v As part of the OnDemand Disk Storage Management (DSM) process (if Migrate
| Data From Cache is set to After x Days in Cache on the Advanced panel of the
| Storage Management tab within the application group definition). This process is
| invoked by issuing the Start Disk Storage Management (STRDSMOND)
| command.

| No special parameters for data loading or the STRDSMOND command are

| required to trigger the Tivoli Storage Manager step. By configuring Tivoli Storage
| Manager support as described earlier, data loading and DSM automatically invokes
| Tivoli Storage Manager as needed during processing. The Archive Storage
| Management process (ASM, started by the Start Archived Storage Mgmt
| (STRASMOND) command or the RUNASM(*YES) parameter of the STRDSMOND
| command) is not required unless other Content Manager OnDemand data is
| managed by ASM in addition to the Content Manager OnDemand data managed
| by Tivoli Storage Manager.
| “Testing your Tivoli Storage Manager setup”
| “Object naming on the Tivoli Storage Manager server”

| Testing your Tivoli Storage Manager setup

| To test your Tivoli Storage Manager setup, follow these steps:
| 1. Archive data.
| 2. Run Disk Storage Manager (DSM) if Migrate data is set to ″Next Cache
| Migration.″
| 3. Run ASM. You may need to run ASM more than once if using aggregation.
| 4. Check the objects created, using the information provided in “Object naming on
| the Tivoli Storage Manager server” to identify the objects.

| Object naming on the Tivoli Storage Manager server

| Objects sent to Tivoli Storage Manager when using Tivoli Storage Manager as an
| ASM migration policy level use the following naming convention. Note that objects
| sent to Tivoli Storage Manager when using Tivoli Storage Manager as a separate
| storage manager have a different naming convention.
|| Item Example Comments
| FILESPACE_NAME: /QUSROND/ /instance name/Tivoli Storage Manager
| TSMSTGGRP storage group name

38 Common Server Administration Guide

| Item Example Comments
| HL_NAME: /Primary/20080222 /Tivoli Storage Manager storage group
| type/date object was moved to Tivoli Storage
| Manager
| LL_NAME: /117 object number in ASM
|
|

Using Tivoli Storage Manager 39

40 Common Server Administration Guide
Backup and recovery
It is important to implement a backup plan to protect your data archives in the
event your organization experiences a system failure. You need to have a plan and
prepare so that you can recover.
“Backup considerations”
“Recovery considerations” on page 42
“Reports” on page 42

Backup considerations
Items you need to consider when planning your regular backups include:
v How to recover the optical or tape media itself
You should consider having a copy of the media stored at an offsite location.
v How to recover the data on disk
You should have procedures in place that backup all of the IBM Content
Manager OnDemand data that normally resides on disk, as well as any stored
data that has not yet migrated to optical or tape.

Remember: Disk backups will contain database files that reflect the actual archive
data location and status at the time of backup. DO NOT restore from a backup that
is one week old. Archived data might have migrated to optical or tape, but
database control files identify incorrectly the archived data location as disk. In
order to minimize this situation, you should save your database libraries and save
your Content Manager OnDemand Integrated File System (IFS) directories on the
same schedule to keep them synchronized. Perform the backups at least as
frequently as you run the disk storage management (STRDSMOND) or archive
storage management (STRASMOND) commands. (Possibly even more frequently if
you often manually delete reports that are stored in Content Manager OnDemand.)

The following objects need to be saved by the appropriate IBM i commands:

v The Content Manager OnDemand licensed program (5761-RD1)
v User profiles QRDARS400, QRDARS4001, QRDARS4002, QRDARS4003,
QRDARS4004, QRDARS4005, QONDADM, and QRDARSADM, and one for each
instance that exists (which has the same name as the instance)
v Authorization lists QRDARS400, QONDADM, QRDARSADM, and one for each
instance that exists (which has the same name as the instance)
v All objects in QUSRRDARS library
v All objects in any other libraries that contain data for your OnDemand instances.
For example, the QUSROND library if you are using the default QUSROND
instance, or any other library by the name of any other instance on your system.
v Output queues that are being monitored and any output queues that are being
used as processed queues or error queues for your monitors.
These output queues can contain processed spooled files.
v Integrated File System directories
Each instance that is created in Content Manager OnDemand has an Integrated
File System (IFS) directory that is named the same as the instance. To back up
only the Content Manager OnDemand data on disk, you could back up all items
found in the Integrated File System directory /QIBM/UserData/OnDemand/

© Copyright IBM Corp. 1991, 2010 41

 instance, where instance is the name of your OnDemand instance. Remember
that the name of the default instance is QUSROND.
Content Manager OnDemand Common Server migration policies allow you to
specify a disk pool as one of the possible storage levels (as an alternative to
optical or tape media, for example). If you use disk pools in any of your
migration policy storage levels, the simplest approach to make sure that the data
in the disk pool is saved and restored properly for an instance is to do the
following:
To perform the save:
| 1. End the instance server ENDTCPSVR SERVER(*ONDMD) INSTANCE(QUSROND)
2. Unmount the file system CALL QRDARS/QRLCASMUFS PARM('QUSROND')
3. Save the directory structure /dev/QASP01/ONDEMAND_QUSROND*
4. Save the directory structure /QIBM/UserData/OnDemand/QUSROND
| 5. Restart the instance server STRTCPSVR SERVER(*ONDMD) INSTANCE(QUSROND)
To perform the restore, if necessary:
| 1. End the instance server ENDTCPSVR SERVER(*ONDMD) INSTANCE(QUSROND)
2. Unmount the file system CALL QRDARS/QRLCASMUFS PARM('QUSROND')
3. Restore the directory structure /dev/QASP01/ONDEMAND_QUSROND*
4. Restore the directory structure /QIBM/UserData/OnDemand/QUSROND
| 5. Restart the instance server STRTCPSVR SERVER(*ONDMD) INSTANCE(QUSROND)
Note that the instance name (such as the default QUSROND instance in the
example) and Auxiliary Storage Pool name (such as ASP01 in the example) must
be changed to match your actual environment. Also note that you must name a
specific instance when you call the QRLCASMUFS program. The QRLCASMUFS
program does not support a value of *ALL for the instance name.
v Integrated File System directories for Content Manager OnDemand Web
Enablement Kit (ODWEK)
If you have implemented ODWEK you should also back up all items that are
found in the Integrated File System directory /QIBM/UserData/OnDemand/WWW.
v Symbolic links in IFS directory /usr/bin that start with ARS
v Configuration files
See Chapters 8 and 9 of the IBM Content Manager OnDemand for i Common Server
Planning and Installation Guide for more information and a list of configuration
files.

Recovery considerations
Contact your IBM Content Manager OnDemand support provider for instructions
on recovering your OnDemand archives in the event of a disaster. Many factors
can influence the recovery plan, depending on the frequency and extent of the
backups you have available.

Reports
IBM Content Manager OnDemand can store copies of reports and resources on
disk storage and archive storage:
v The primary purpose of disk storage is short-term, high-speed storage and
retrieval of reports.
v The primary purpose of archive storage is long-term storage and retrieval of
reports. The reports in archive storage can also be used as backup copies in the

42 Common Server Administration Guide

 event that disk storage becomes corrupted or unavailable. Archive storage
consists of optical or tape storage volumes.
Most customers configure the system to copy reports to disk storage and archive
media at the same time, when they load a report into the system.

Content Manager OnDemand can retrieve a copy of a report from archive storage
after the report has been deleted from disk storage or if the copy on disk storage is
unavailable. However, you must configure the system to maintain multiple copies
of reports. You configure Content Manager OnDemand to use archive storage by
defining migration policies and storage sets that identify archive storage, assigning
application groups to the storage sets, and configuring other storage management
parameters in application groups.

Tip: If you do not plan to copy reports to archive storage, then take regular
backups of the data on disk. However, if a media failure occurs or disk storage
becomes corrupted, users cannot retrieve reports until the backups are restored.

Backup and recovery 43

44 Common Server Administration Guide
 Installing the administrative client
“Hardware”
“Software”
“Memory”
“Disk space” on page 46
“Installing the System i Navigator interface to OnDemand” on page 46
“Installing the administrative client” on page 46

Hardware
The administrative client requires the following hardware:
v Pentium® or Pentium compatible 800 MHz or faster processor
v A super-VGA display and adapter with a minimum resolution of 1024x768
v Physical connection to the network, such as a Token Ring or Ethernet network
adapter
v A CD-ROM drive for installation (optional, if you plan to install the
administrative client from a network file server)

Software
| The OnDemand Administrator client must be at the same (or higher) version as the
| OnDemand server you are running. See the “Summary of changes” on page xi for
| information regarding the server version for this version of Content Manager
| OnDemand for i.

To install or use the administrative client, you must be running Windows XP SP2
or later, or Windows Vista on your computer. To install the administrative client
from a CD-ROM, the CD-ROM drivers must be installed on your computer. To
install the administrative client from a network file server, the appropriate network
software must be running on your computer. To connect to an IBM Content
Manager OnDemand server, the standard TCP/IP support for the Windows
operating system must be running on your computer.

To use the System i Navigator interface to the Content Manager OnDemand

Administrator and for additional Content Manager OnDemand administrative
functions, you must install the System i Navigator Content Manager OnDemand
Administrative Functions component within IBM i Access for Windows. You
should apply the most current service pack for IBM i Access for Windows, if one is
available.

Memory
The administrative client requires a PC with at least 256 MB of memory (RAM).
Your PC may need more memory if you run more than one application at the same
time.

© Copyright IBM Corp. 1991, 2010 45

 Disk space
About this task

To install IBM Content Manager OnDemand clients, disk space requirements

depend on the features that you select.

You need at least 100 MB of free disk space to install all of the Content Manager
OnDemand features. To install only the software required for the administrative
client in a single language, you need at least 50 MB of available disk space.

For more information on disk space requirements for each Content Manager
OnDemand feature, follow these steps:
1. Run the Setup program for the Content Manager OnDemand client software.
2. Read and accept the license agreement.
3. Select the Custom setup type.
4. The summary information lists the disk space requirements for the features that
you selected.

Installing the System i Navigator interface to OnDemand

To use the IBM Content Manager OnDemand Archive component (also known as
plug-in) of System i Navigator, you must install IBM i Access for Windows Version
7 Release 1 on your Windows workstation. Refer to the IBM i Access for Windows
installation documentation for detailed information on installing IBM i Access for
Windows and System i Navigator.

| The OnDemand Archive plug-in of System i Navigator is required to work with:

| v Migration Policies
| v Output Queue Monitors
| v Directory Monitors
| v Tape Devices
| v Tape Volumes
| v Optical Storage Groups
| v Optical Volumes
| v Disk Pool Storage Groups (ASPs)
| v NFS (Network File System) Storage Groups
| v TSM (Tivoli Storage Manager) Storage Groups

Installing the administrative client

The Setup program installs the IBM Content Manager OnDemand client software
on the PC.

To download the Content Manager OnDemand Clients, go to the internet FTP web
site at ftp://service.software.ibm.com/software/ondemand/fixes/.

You can install all of the Content Manager OnDemand features at once, or
individual features as you need them.
“Running Setup” on page 47
“To install on a PC” on page 47
46 Common Server Administration Guide
 “To install on a network file server”
“To use automated install”
“To uninstall” on page 48

Running Setup
When you run the Setup program, the Setup screens show the names of the IBM
Content Manager OnDemand directories so you know where the files are being
placed.

Information about network installations is available in the IBM Content Manager

OnDemand: Windows Client Customization Guide.

To install on a PC
About this task
To install from the CD-ROM or to install from a network file server, follow these
instructions:
1. Insert the CD-ROM in the appropriate drive or obtain the drive letter of the
network drive on which the IBM Content Manager OnDemand software is
located on the network file server.
2. From the Windows taskbar, click Start, and then choose Run.
3. Type x:\client\win32\setup (where x is the letter of your CD-ROM drive or
the network drive).
4. Click OK.
5. After the Setup program starts, click Next to continue.
6. Read and accept the license agreement, and then click Next to continue.
7. Click Next to accept the destination drive and directory, or specify a
destination and then click Next.
8. Select the Custom setup type and then click Next to continue.
9. Select OnDemand Administrator and select your language. (You can also
select other components that you want to install on the PC at this time.)
10. Click Next to continue. Follow the instructions on the screen to complete the
installation.

To install on a network file server

Information about network installations is available in the IBM Content Manager
OnDemand: Windows Client Customization Guide.

To use automated install

Automated install allows administrators to standardize the IBM Content Manager
OnDemand installation for all users in an organization. It also allows
administrators to install Content Manager OnDemand clients without the presence
of users at their PCs. To read more about automated install, see the IBM Content
Manager OnDemand: Windows Client Customization Guide.

Installing the administrative client 47

 To uninstall
You can use Add/Remove Programs in Control Panel to remove the IBM Content
Manager OnDemand client from your PC. Add/Remove Programs removes the
directories for Content Manager OnDemand and any references to Content
Manager OnDemand in system files.
“To run the uninstall”

To run the uninstall

1. From the Windows taskbar, click Start. Choose Settings, and then choose
Control Panel.
2. Double-click Add/Remove Programs.
3. From the list, select OnDemand32.
4. Click Add/Remove.
5. Click OK.

48 Common Server Administration Guide

About the administrative client
The administrative functions in IBM Content Manager OnDemand are set up using
System i Navigator and the Content Manager OnDemand Administrator, and
include:
v Defining reports to the system
v Adding and maintaining Content Manager OnDemand users and groups
v Adding and maintaining server printers
v Maintaining storage sets and migration policies
v Creating summaries about users, groups, applications, application groups,
storage sets, folders, and printers
v Adding and maintaining servers
v Setting system parameters for Content Manager OnDemand servers and client
programs
v Copying items from one Content Manager OnDemand server to another
v Tracking changes made to the system. When you use the System i Navigator to
add or update the database, Content Manager OnDemand places a document in
the system log which shows the changes that you made.

The following is a list of the administrative items that are maintained directly
through System i Navigator:
v Tape devices
v Tape volumes
v Optical storage groups
v Optical volumes
v Disk pool storage groups
v Monitor definitions
v Migration policies

The items that are maintained through the Content Manager OnDemand
Administrator are:
v Users
v Groups
v Applications
v Application groups
v Storage sets
v Folders
v Printers

The Content Manager OnDemand Administrator is launched by right-clicking on

Common Server Administration within the Content Manager OnDemand Archive
section of System i Navigator. From the resulting pop-up menu, click Client
Administrative Functions to open the Content Manager OnDemand Administrator.
“Getting started” on page 50
“System parameters” on page 52
“Adding items to a server” on page 58

© Copyright IBM Corp. 1991, 2010 49

 “Report Wizard” on page 60

Getting started
v You can collapse and expand areas in the navigator pane (on the left) to make it
easier to see. A plus sign next to an area means there are items inside.
v When you click on an area in the navigator pane, the items appear in the list
pane (on the right).
v To make the panes narrower or wider, point to the vertical bar between the two
panes of the window until the pointer turns into a two-headed arrow. Then click
and hold the left mouse button and drag it in either direction.
v Use buttons on the toolbar to switch between the different ways to look at items:
large or small icons, a list, or details.
v To query the server for a new list of items, press the F5 key or select Refresh
List from the View menu.
v After you log on to a server, the status bar shows the OnDemand user ID and
the name and version number of the IBM Content Manager OnDemand server.
“Using online help”
“Adding a server”
“Logging on a server” on page 51
“Changing passwords” on page 51

Using online help

Online help provides information to assist you with completing tasks. The
administrative client online help contains information about the options, fields, and
commands on the windows, dialog boxes, and property sheets that you see when
using the program.

To display the online help, press the F1 key any time that the administrative client
is active in Windows. Help is available for dialog box commands and options. The
main help topic for each dialog box usually contains information about the kinds
of tasks you can perform. For example, the online help about Logical Views lets
you learn how to create public and private logical views. The online help provides
brief procedures rather than lengthy descriptions.

Adding a server
About this task

You can use the New Server command to add a server.

1. In the IBM Content Manager OnDemand section of System i Navigator, right
click Common Server Administration. In the resulting context menu, click
Client Administrative Functions, then logon.
2. Click once on OnDemand Servers at the top of the list of servers in the left
panel of the OnDemand Administrator.
3. From the File menu, select New Server to open the Add a Server dialog box.
4. Type the name of the server in the Server field. The server name identifies the
server in the navigator pane of the administrator window. You can use an
alias, the actual computer or network name of the server, or any other
identifier you choose. By default, the administrative client copies what you
type to the Host Name field.

50 Common Server Administration Guide

 5. Verify the value of the Host Name field. (By default, the Host Name field
contains the same value as the Server field.) The host name can be a host
name alias, fully-qualified host name, or IP address of the server.
6. Verify the Protocol. Choose from TCP/IP or Local:
v TCP/IP. Use TCP/IP (Transmission Control Protocol/Internet Protocol) as
the network protocol. To use TCP/IP, the server and the client must include
TCP/IP in the protocol stack.
v Local. Use the local file system manager to communicate with the server.
This is most often used when your archived data is on a CD-ROM.
7. For TCP/IP, verify the Port Number that the server monitors for client
program requests.
The default value, 0 (zero), means that the server monitors the port number of
the Content Manager OnDemand TCP/IP service. By default, the server
monitors port number 1445. If you plan to use a port number other than 1445,
then you must enter a valid port number. If you have more than one instance
defined to Content Manager OnDemand, then you would have separate
server definitions for every instance with unique port numbers for each
instance. The value range is from 0 to 65535. To see what ports are currently
in use on your system, enter the Work with TCP/IP Network Status
(WRKTCPSTS) command with OPTION(*CNN).
8. If your logon panel includes the Attempt Unified Logon checkbox, confirm
that it is not checked. (Unified Logon is used only for Windows servers.)
9. If you are adding a Local server, specify a Directory and select an Operating
System and a Database. See the online help for assistance.
10. Click OK to add the server.

Logging on a server
About this task
1. Point to the server and double-click the left mouse button to open the Logon
dialog box.
2. Enter your OnDemand user ID and password in the spaces provided and click
OK. For a Local server, the built-in user ID is admin; no password is assigned to
the admin user ID.

Changing passwords
This section applies only if you are using IBM Content Manager OnDemand user
IDs and passwords rather than IBM i user IDs and passwords. See the IBM Content
Manager OnDemand for i Common Server Planning and Installation Guide section titled
″OnDemand user relationship to IBM i user profiles″ for important information
about passwords.
“Changing a password”
“Changing an expired password” on page 52

Changing a password
About this task

To change a user’s password:

1. Select and expand the library server.
2. Select Users.
3. In the User ID list, point to the user ID and click the right mouse button.

About the administrative client 51

 4. From the pop-up menu, select Update to open the Update a User dialog box.
5. Type the new password in the Password field.

Important: When creating a password, the value that you specify can be a
maximum of 20 characters. However, the password authentication that is built
into IBM Content Manager OnDemand verifies only the first eight characters
that are entered by the user. The additional characters are provided for
customers that choose to implement their own password security by using the
logon user exit.
6. Verify the new password by retyping it into the Verify Password field.
7. Click OK. Content Manager OnDemand updates the database and returns to
the main window.

Changing an expired password

IBM Content Manager OnDemand provides password expiration processing to
help you manage security on the system. You can set a value that represents the
time in days that passwords assigned to users remain valid. After a user’s
password reaches the value that you specify, the user must change the password.
See “System parameters” for information about how Content Manager OnDemand
expires passwords.

After a password reaches the expiration value, the next time the user ID is used to
log on to a server, Content Manager OnDemand prompts the user to enter a new
password.

The user must enter the current password for the user ID, a new password, and
verify the new password by retyping the new password

System parameters
IBM Content Manager OnDemand system parameters allow you to establish the
following operational settings for client programs and servers.
“Maximum Password Age”
“Minimum Password Length” on page 53
“Inactivity Time Out” on page 53
“System Logging” on page 54
“User Exit Logging” on page 54
“Login Processing” on page 54
| “Annotations” on page 55
| “System Log Comments” on page 56
| “LDAP Authentication” on page 56
“Setting system parameters” on page 56
“Setting trace parameters” on page 58

Maximum Password Age

Sets a time limit for passwords and determines when IBM Content Manager
OnDemand prompts users to change passwords. The default setting is Password
Never Expires, meaning that passwords do not expire and Content Manager
OnDemand never prompts users to change passwords. If you select Password
Always Expires, then users must change to new passwords each time that they log

52 Common Server Administration Guide

 on to a server. To set a specific time limit for passwords, select Expires In __ Days
and enter the number of days that passwords are valid in the space provided. The
value can be from 1 (one) to 365.

If you are linking your Content Manager OnDemand user IDs to IBM i user
profiles, then Maximum Password Age should be set to Password Never Expires.
If you specify a value for Maximum Password Age, then Content Manager
OnDemand may force a user to change their password before it is required by i.

Minimum Password Length

Determines whether passwords are required. If passwords are required, also
determines the fewest number of characters that passwords can contain. The
default value is At Least 8 Characters.

If you select Permit Blank Password, meaning that passwords are not required,
then the valid password length is 0 (zero) to 20 characters.

If you are linking your IBM Content Manager OnDemand user IDs to IBM i user
profiles, then Minimum Password Length should be set to Allow Blank
Password. This prevents Content Manager OnDemand from trying to impose its
own rules on the length of a password and allows i to use its own rules.

To set a specific minimum password length, select At Least __ Characters and

enter a number in the space provided. The value can be from 1 (one) to 20
characters.

Important: When creating a password, the value that you specify can be a
maximum of 20 characters. However, the password authentication that is built into
Content Manager OnDemand verifies only the first eight characters that are
entered by the user. The additional characters are provided for customers that
choose to implement their own password security by using the logon user exit.
Contact the IBM support center for more information about the logon user exit.

Inactivity Time Out

Determines when IBM Content Manager OnDemand terminates sessions between
inactive clients and the server. The default setting is Time Out in 60 Minutes. The
value can be from 1 (one) to 1440 (24 hours).

The period of inactivity is measured between requests to a server. For example,

when a user enters a query, Content Manager OnDemand searches the database
and builds the document list. This completes a request to the server. If the user
does not work with the items in the document list, open another folder, or invoke
another query before the inactivity time out occurs, Content Manager OnDemand
automatically terminates the session with the client.

Use caution when you set the inactivity time out. For example, assume that you set
the inactivity time out to 10 (ten). You log on to Content Manager OnDemand to
add an application group. Creating the application group takes you 15 minutes to
complete. After entering all of the information about the application group, you
click OK to create the application group. Content Manager OnDemand issues a
message that shows a time out has occurred. You must logoff the server, and you
cannot save the information you entered about the application group.

About the administrative client 53

 System Logging
Determines the messages that IBM Content Manager OnDemand saves in the
system log. Content Manager OnDemand provides the system log to help you
track activity and monitor the system. Content Manager OnDemand saves
messages that are generated by the various commands, such as the ADDRPTOND
command. Content Manager OnDemand can save a message in the system log
when the following events occur:
v A user logs on to the system
v A user logs off the system
v A user logon fails
v Application group data is queried, retrieved, loaded, updated, deleted, or
maintained

User Exit Logging

IBM Content Manager OnDemand provides a user exit at each of the four system
log event points. These exits allow you to filter the messages that Content Manager
OnDemand saves in the system log and take action when a particular event occurs.
For example, you can provide a user exit program that sends a message to a
security administrator when someone attempts and fails to log on to the system.
You can also use a user exit to determine what information appears in the system
log.

If you plan to migrate index data to archive storage, then we recommend that you
configure the system to save application group messages in the system log and
send them to a system log user exit program. You should design a system log user
exit program to notify an administrator when a query for migrated data occurs.
Before a query for migrated data can be completed, an administrator must import
a copy of the table or tables that are required from archive storage to the database.

See the IBM Content Manager OnDemand for i Common Server Planning and
Installation Guide for help with configuring the system log user exit.

Login Processing
The login processing system parameters allow you to specify whether user IDs and
passwords are case sensitive.

Before continuing with this section, please refer to the OnDemand user ID
relationship to IBM i user profiles section in the IBM Content Manager OnDemand
for i Common Server Planning and Installation Guide for a detailed explanation of the
significance of choosing to relate your Content Manager OnDemand users to
existing i user profiles. It is important that you understand that concept before you
make your choices for Login processing.

Now that you understand the relationship between Content Manager OnDemand
users and your i users, you should note the following:
v If your Content Manager OnDemand user IDs are linked to your i user profiles
(which is the default when Content Manager OnDemand is installed), and if
your i security level is set to 0 or 1, you SHOULD NOT check the Password
Case Sensitive checkbox.
v If your Content Manager OnDemand user IDs are linked to your i user profiles
(which is the default), and if your i security level is set to 2 or 3, you SHOULD
check the Password Case Sensitive checkbox.

54 Common Server Administration Guide

 v Regardless of your system security level, you should NEVER check the user ID
Case Sensitive checkbox if your Content Manager OnDemand users are linked to
your i user profiles.
v If you are using Content Manager OnDemand user IDs and passwords that are
not linked to i user profiles (which is not the default), then you can set the two
Login processing checkboxes as you choose.

By default, user IDs and passwords are case insensitive. When you add a user,
Content Manager OnDemand converts lowercase letters in the user ID to
uppercase. A person can type letters in a user ID in uppercase, lowercase, or mixed
case letters. For example, if you add the user ID LaGuarde, a person can enter
LAGUARDE, laguarde, or LaGuarde to log on to the server.

If you select UserID Case Sensitive, then a user must type the user ID exactly as it
was entered when the user was added. For example, if you add the user ID
LaGuarde, then the user must enter LaGuarde to log on to the server.

If you select Password Case Sensitive, then a user must type the password exactly
as it was entered when the user was added. For example, if you set the password
to Spring2Far, then the user must enter Spring2Far to log on to the system.

We strongly encourage you to decide whether you want user IDs and passwords
to be case sensitive when you install the system, change the defaults if necessary,
and do not change the settings again. Otherwise:
v If user IDs are initially case insensitive and you later choose UserID Case
Sensitive, then user IDs that were added before you changed the parameter
must be entered in uppercase. The same is true for passwords.
v If user IDs are initially case sensitive and you later clear UserID Case Sensitive,
then the user IDs that were added before you changed the parameter that
contain mixed or lowercase letters will no longer be valid. The same is true for
passwords.

| Annotations
| This section specifies which types of annotations (referred to as ″notes″ in the
| OnDemand client) can be added by a user. This selection applies to all users with
| authority to add annotations in the system.

| There are three types of annotations that a user can add:

| Allow Public
| Allows the user to add public annotations. Public annotations to a
| document can be viewed by anyone who opens that document.
| Allow Private to User
| Allows the user to add private annotations to a document, and those
| annotations can be viewed only by the user that created the note,
| application group administrators, and system administrators.
| Allow Private to Group
| Allows the user to add annotations to a document, and those annotations
| can be viewed only by a specific group of users.

| The Default Annotation Type section specifies the annotation that is selected as the
| default.

About the administrative client 55

| System Log Comments
| The system log comments specify whether the administrative client displays the
| System Log Comments window when you perform an add, update, or delete
| operation.
| Enable comments
| Select this option to display the System Log Comments window when you
| perform an add, update, or delete operation.
| Require comments
| This option requires the user to enter one or more characters in the
| Comments field.

| LDAP Authentication
| Specify whether you want to use LDAP (Lightweight Directory Access Protocol)
| authentication in your OnDemand server.

| Select the Enable check box to use LDAP authentication. After LDAP
| authentication is enabled, OnDemand server makes an authentication request to
| the LDAP server every time it receives a login request from the client, and
| processes the client request only after the user information is verified by the LDAP
| server.

| Clear the Enable check box to disable LDAP authentication.

Setting system parameters

About this task

To set the system parameters for a IBM Content Manager OnDemand server:
1. Log on to the server.
2. Point to the server and click the right mouse button.
3. From the pop-up menu, select System Parameters to open the System
Parameters dialog box. The following figure shows an example of the System
Parameters dialog box.

56 Common Server Administration Guide

Figure 1. System Parameters

4. To change the Minimum Password Age, select the appropriate option. If you
select Expires In, enter the number of days in the space provided.
5. To change the Minimum Password Length, select the appropriate option. If
you select At Least, enter the number of characters in the space provided.
6. To change the Inactivity Time Out, select the appropriate option. If you select
Time Out In, enter the number of minutes in the space provided.
7. To choose a System Logging, User Exit Logging, or Login Processing option,
select the check box next to the item.
8. Specify which types of annotations can be used by a user. In the Default
Annotation Type section, specify the annotation that is selected as the default
type.

Important: This section applies to all users with authority to add annotations
to the system.
There are three types of annotations available:

Option Description
Allow Public Allows the user to add public annotations.
Public annotations to a document can be
viewed by anyone who opens that
document.
Allow Private to User Allows the user to add private annotations
to a document, and those annotations can be
viewed only by the user who created the
note, application group administrators, and
system administrators.
Allow Private to Group Allows the user to add annotations to a
document, and those annotations can be
viewed only by a specific group of users.

About the administrative client 57

 9. Specify whether the administrative client displays the System Log Comments
window when you perform an add, update, or delete operation.
| 10. Specify whether you want to use LDAP (Lightweight Directory Access
| Protocol) authentication in your Content Manager OnDemand server.
11. To generate a summary of the system parameters and display the information
in a window where it can be viewed and printed, click Summary.
12. When you have finished making changes to the system parameters, click
Update. (Click Cancel to close the System Parameters dialog box without
saving your changes.) Content Manager OnDemand stores the changes in the
database and returns to the administrator window.

Setting trace parameters

About this task

The levels of trace reporting are defined as:

v Error: Returns error messages
v Warning: Returns warning messages
v Information: Returns informational messages
v Flow: Documents entering and exiting of functions

You can set different trace levels for each component. For example, you can set
your database to return informational messages, and your server to return error
messages.

To set the trace parameters on a IBM Content Manager OnDemand server:

1. From the OnDemand Administrator client, log onto the Content Manager
OnDemand server for which you want to set trace parameters.
2. In the left panel, right-click the name of the server to which you just logged on.
3. Select Trace Parameters.
4. In the System Trace Settings dialog box select the Activate System Trace
checkbox.
5. Select the Trace Level Reporting options you want. (You can select multiple
options.) Refer to the online help for more information on each of the options.

Important: You must select the Active System Trace, at least one component,
and one option for tracing information to actually be logged.
6. Click Update to save your selections.

Adding items to a server

This section explains how to add items to a server. You can use commands or a
drag-and-drop operation to add items to a server.

When you use the administrative client to add or update the database, IBM
Content Manager OnDemand adds a record to the system log that shows the
changes you made.
“New command” on page 59
“Copy command” on page 59
“Export command” on page 59
“Drag and drop operation” on page 59

58 Common Server Administration Guide

New command
About this task

After logging on to a server, select the area, for example, Users. From the File
menu, select the New command to open the Add dialog box.

Copy command
About this task

After logging on to a server, select the area. In the list pane, point to the item that
you want to copy and click the right mouse button. From the pop-up menu, select
Copy to open the Add dialog box. The fields in the Add dialog box contain
information copied from the item you selected. Before you can add the item, you
must change the item name. Depending on the item you want to add, you may
need to change other fields.

Export command
About this task

The Export command is like the Copy command, except IBM Content Manager
OnDemand adds the item to a different server. You can use the Export command
to export items from the source server, and add (Import) them to the destination
server.

After logging on to the server that contains the item you want to export, select the
area. In the list pane, point to the item that you want to export and click the right
mouse button. From the pop-up menu, select Export to open the Export dialog
box. Verify the destination server. Then click Export to add the item to the server.

If the item already exists on the destination server, the export fails.

When exporting or importing a Content Manager OnDemand application

definition from one hardware platform to another (for example, from OnDemand
for i to OnDemand for Multiplatforms or the reverse), you must update the
Content Manager OnDemand application definition after the export, to ensure that
the correct indexer is named. An application definition being exported from an
IBM i server might have ″OS400″ selected for the Indexer value on the Indexer
Information tab, which is not valid for any platform other than IBM i. Similarly, an
application definition being imported to an IBM i server from Content Manager
OnDemand for Multiplatforms might have ″ACIF″ selected as the indexer, which is
not valid on IBM i.

Drag and drop operation

About this task

You can copy and export items using a drag-and-drop operation. For example, to
export items from one server and add them to another, select one or more items
from the list pane and, while holding the left mouse button down, point to the
destination server. Then release the mouse button. If you are logged on to the
destination server, then IBM Content Manager OnDemand opens the Export dialog
box. If you are not logged on to the destination server, then Content Manager
OnDemand opens the Logon dialog box. After verifying options in the Export
dialog box, click Export to copy the items to the server.

About the administrative client 59

 If the item exists on the destination server, the export fails.

You can also use a drag-and-drop operation to copy an item. For example, to copy
a user, select the user ID from the User ID list and, while holding the left mouse
button down, point to the same server on which the user is listed. Then release the
mouse button to open the Add dialog box.

Report Wizard
IBM Content Manager OnDemand provides user assistance and easy-to-use tools
to help you administer Content Manager OnDemand. The Report Wizard helps
you add a report to Content Manager OnDemand by asking questions, which
allows you to progress in an organized manner toward completing an application
group, application, and folder. Here are a few things to remember about the Report
Wizard:
v You move through the Report Wizard by answering questions that appear on the
screen.
v You can return to the previous screen at any time by clicking Previous.
v You can advance to the next screen at any time by clicking Next.
v You can advance to the final screen by clicking Finish. By choosing Finish, you
permit the Report Wizard to make all remaining decisions for you.
v You can obtain online help for a screen at any time by clicking Help or pressing
F1.

Important: The Report Wizard processes your own input files. You must select a
sample input file to proceed. Then, the graphical indexer is invoked to allow you
to mark the data to define your indexing parameters. The graphical indexer that is
invoked through the Report Wizard is the same graphical tool that is invoked
directly by selecting Sample Data and then clicking on the Modify button from
the indexer information tab of a Content Manager OnDemand application
definition.

You can use the Report Wizard to add an application group, application, and
folder for a selected report. These actions include defining indexing information,
defining database and folder fields, configuring data and storage management,
specifying whether the application group can contain more than one application,
and naming the application group, application, and folder.

You can also use the Report Wizard to add an application to an existing
application group. This action includes defining indexing information, specifying
storage information, and identifying the application within the application group.
To add an application to an application group, the application group must have a
database field to hold the values that uniquely identify an application within the
application group. The field must contain at least one unassigned application
identifier. See the Field Information page in application groups for detailed
information about application identifiers.
“Starting the Report Wizard”
“Using the Report Wizard” on page 61

Starting the Report Wizard

About this task

From the administrative client, log on to the server to which you want to add the
report.

60 Common Server Administration Guide

 1. To define a new application group, application, and folder, click the Report
Wizard icon on the toolbar.
2. To add an application to an existing application group:
a. Under the server, select Application Groups
b. Select the name of the application group to which you want to add the
application
c. Click the Report Wizard icon on the toolbar
3. Follow the on-screen instructions to add the report.

Using the Report Wizard

The screens in the Report Wizard are described in the following. On most screens,
standard options will already be selected for you. Unless you have a clear reason
not to, accept the defaults.

Note: Depending on how you use the Report Wizard, you may not see all of the
screens described below.

Introduction screen

Provides a brief explanation of the Report Wizard (See the following figure. First
choose the data type of the report you are defining. Click Select Sample Data
button to select a file that contains a sample of the actual report data. The Report
Wizard lets you select a spooled file on the server (search by user profile or by
output queue) and copies that sample data to your workstation for you to use for
indexing.

Figure 2. Report Wizard

When you click OK, the Report Wizard reads the data into the Report window.

About the administrative client 61

 Report window

Displays the sample data file and provides easy-to-use tools to help you define
indexing information, database fields, and folder fields. Press F1 to display the
online help for options and commands available from the Report window. Use the
online help to learn how to define triggers, fields, and indexes, database fields, and
folder fields.

Important: When you have finished defining the indexing, database, and folder
information, be sure to save your changes when prompted.

Managing data screen

When you load a report into the system, you can specify that you want report data
to be stored in Large Objects. You also need to specify how you want IBM Content
Manager OnDemand to manage annotations that users attach to pages of the
report.

Application identifier screen

When you use the Report Wizard to add an application to an existing application
group, you must specify the name of the application and select a value that
uniquely identifies the application within the application group.

Storage management screen

Determines where the storage manager maintains copies of reports, and how and
when Content Manager OnDemand deletes report data from the system.

Applications in the application group screen

If the report that you are defining is one of several that will be stored in the same
application group, you can use the Report Wizard to define an application ID field.
An application ID field is a database field that contains values that identify an
application within the application group. IBM recommends that you always define
an application ID field. See the figure for an example. You may not think that you
need an application ID field at the time that you create your application group, if
you are adding an application group that will hold only one application at the
current time. However, if you decide later to add other applications to the
application group (or if you want to maintain multiple versions of your application
definitions) and you then need to define an application ID field for the application
group, you will not be able to do so because an application ID field cannot be
added after the application group is created. (All fields must be added during the
original application group definition.) Also note that the application ID field can be
hidden from users that do not require it to search for documents. See the online
help for more information about the application ID field.

Name screen

Specify the names of the application group, application, and folder. After you enter
the names, Content Manager OnDemand queries the server to make sure that the
names are valid and unique.

62 Common Server Administration Guide

Wizard complete screen

Confirms the selections you made for the report. Click Display to view details
about the application group, application, and folder. From the detail report
window, choose the Print icon from the toolbar to print a copy of the detail report.

Note: When you are satisfied with the selections you made for the report, click
Finish to complete defining the report. Content Manager OnDemand adds the
application group, application, and folder to the library server, closes the Report
Wizard, and returns to the administrator window.

About the administrative client 63

64 Common Server Administration Guide
Concepts
You can use System i Navigator to setup and maintain IBM Content Manager
OnDemand tape devices, tape volumes, optical storage groups, optical volumes,
disk pool storage groups, output queue monitors, and migration policies.

You can use the Content Manager OnDemand Administrator within System i
Navigator to maintain Content Manager OnDemand users, groups, printers,
storage groups, application groups, applications, and folders. To use this tool, right
click on Common Server Administration within the Content Manager OnDemand
Archive section of System i Navigator. Select Client Administrative Functions
from the resulting menu. This will open the Content Manager OnDemand
Administrator.
“Migration Policies”
“Monitor Definitions” on page 66
“Tape devices” on page 67
“Tape volumes” on page 67
“Optical storage groups” on page 68
“Optical volumes” on page 68
“Disk pool storage groups” on page 68
“Users” on page 68
“Groups” on page 71
“Printers” on page 71
“Storage sets” on page 72
“Application groups” on page 72
“Applications” on page 73
“Folders” on page 73
“About application groups, applications, and folders” on page 74
“OnDemand permissions” on page 75
“Hints and tips” on page 80

Migration Policies
Migration policies contain migration and storage media characteristics for data
archived using IBM Content Manager OnDemand. The information is used by the
archive storage management process (ASM), also referred to as the migration
process, to determine if and when archived data should be moved as it ages
through a hierarchy of storage media having different performance and capacity
characteristics. Examples of these media types include disk, optical, and tape
storage. Each step in the movement of data through this storage hierarchy is
referred to as a migration policy storage level, or simply, a storage level. Each
policy must contain at least one storage level. Additional levels can be defined to
meet your storage and retrieval requirements. The STRASMOND command is the
command used to force the data to move to the next storage level in the migration
policy. A report is produced when ASM is run and has a spooled file name of
QPRLCASM1. The report provides of list of actions that the ASM process
performed. This report should be checked each time ASM is run to ensure that

© Copyright IBM Corp. 1991, 2010 65

 processing of the data completed successfully. If you find a failure, you should
check the job log for the STRASMOND job to determine the cause of the failure.

The migration policy also specifies:

v If separate archived files are to be aggregated, or combined, with other archived
files having similar retention and migration characteristics. Enabling aggregation
is usually recommended because it can improve performance by allowing
Content Manager OnDemand to manage a smaller number of larger objects
rather than a large number of small objects. However, it is important to
understand that an aggregate must reach its maximum size or exceed its time
period before the aggregated object can flow to the first level of the Migration
Policy. Because of this, you should be cautious of large aggregate sizes. If you
are aggregating many small objects, it is possible for the aggregate not to be
migrated to the first level of the Migration Policy for many months. For this
reason, you may prefer to aggregate after a specified time period rather than by
size.
v If two copies of archived data are to be kept at some or all levels in the
migration sequence.
| v If a one-time tape backup is performed.

The migration policy name can be up to 60 characters long and must not be a
duplicate of another policy within the same instance. If the Enable aggregation is
selected, the archive storage management process combines individual archived
objects on disk into larger objects to provide efficient processing. This process
occurs prior to migration of the object from disk to the first storage level. The
aggregation process appends to the same file (aggregate) until the aggregate is
’closed.’ The aggregate is closed when it either reaches a specified maximum size
or a specified number of days. Storage levels can be added before or after a
pre-existing storage level. Existing storage levels within a migration policy can also
be changed or removed, however these changes will not affect migrated data
already residing at this level. If you need to change the dates for migrated data
already residing at a particular level, use the Change Policy Level Data
(CHGPLDOND) command. If a one-time tape backup is requested, a tape media
type must be specified.

Monitor Definitions
Monitor definitions are used to specify what output queue will be monitored for
spooled files to be processed. If defining more than one monitor job, specify a
unique job name for each monitor. IBM Content Manager OnDemand will only
process spooled files that are in a ready (RDY) state. When the monitor job selects
a spooled file from the selected output queue for archiving (also known as
loading), it needs to determine which application group and application to
associate with the spooled file so that the file can be archived correctly. Since the
only data available to the monitor are the attributes of the selected spooled file, the
application group name and application name must be derived from the contents
of one of these attributes. Not all attributes are suitable for this purpose. Content
Manager OnDemand will examine the contents of up to three of the following nine
attributes, in the order specified in the Check first, Check next, Check last
selections:
v Spooled file name
v Form type
v User data
v Job name

66 Common Server Administration Guide

 v User-defined options 1 through 4
v User-defined data

The attribute selected from the Check first pulldown list is examined first. If the
value of this attribute does not match the name of an existing application group,
Content Manager OnDemand examines the attribute selected from the Check next
pulldown list, if specified. If the value of this attribute does not match an
application group name, the attribute selected from the Check last pulldown list, if
specified, is checked. If a valid application group is not determined using the
above method, the spooled file is moved to another output queue designated as an
’error’ queue which is defined in this monitor definition. If the spooled file is
successfully archived, it can be moved to a ’processed’ queue or deleted according
to the specifications in the monitor definition. The same process is followed to find
a valid application name, unless you specify that the application name is the same
as the application group name.

The monitor can be started manually, by a job scheduler, or started when the
subsystem starts. The monitor can be ended manually, after a specified time
period, after all queue entries are processed, or it can be specified when the
monitor is started.

The first time you start a monitor for a particular output queue, it is best to do it
when there are no spooled files in the output queue. When a monitor is started for
the first time, an empty data queue with the same name as the output queue is
created, which will receive entries for all spooled files that appear in the output
queue in Ready status. Once the output queue monitor has been started (and
therefore the data queue has been created), you can then begin moving the spooled
files that you wish to capture into the output queue. The data queue entries that
get created will trigger the monitor to process each spooled file.

Tape devices
When a tape backup is requested, or if you will use tape as an archive media, you
must defined a tape device to IBM Content Manager OnDemand. The tape device
name you specify must match the name of an existing IBM i tape device
description. A media type must be specified from the list of supported media types
for either read or write operations. If the tape device being defined has an
automatic cartridge loader (ACL), the number of cartridges can be specified. A
value of zero specifies that this device does not have an ACL. Content Manager
OnDemand can be used with an automated tape library; if a tape library will be
used, the name must be specified. If a tape manager other than Content Manager
OnDemand (such as BRMS) is used, a media library does not need to be specified.

Tape volumes
Tape volumes that can be used by IBM Content Manager OnDemand must be
defined. The name of the volume specified must match the name that was used
when the tape volume was initialized. The instance to which the tape volume
belongs must be specified, along with the capacity and media type of the volume.
The media type tells Content Manager OnDemand which tape device to use. A
media device library can be specified if an automated tape library is used. Leave
this field blank if a tape manager other than Content Manager OnDemand (such as
BRMS) is used. A tape volume can be marked full, preventing Content Manager
OnDemand from writing any additional data to the volume. Content Manager
OnDemand will automatically mark the volume full when it detects that the tape
is full.
Concepts 67
 Optical storage groups
Optical storage groups are used by IBM Content Manager OnDemand to group
sets of optical volumes together to store related data. A storage group lets you
group together reports that have similar storage requirements such as days on disk
or expiration days. By referring to a specific storage group in your migration
policy, you can control which reports are stored on a particular set of optical
volumes. If optical volumes are defined as rewritable, the space can be reused on
the volume by defining a free space threshold percent and volume full reset. If the
volume full reset is not defined, once the volume is marked full it remains full
unless manually changed. The optical storage group can also be defined as the
primary or backup storage group.

Optical volumes
Optical volumes that can be used by IBM Content Manager OnDemand must be
defined. The name of the volume specified must match the name that was used
when the optical volume was initialized. The OnDemand instance and optical
storage group to which the volume belongs must be specified. The capacity and
volume type (primary or backup) of the volume is also required. An optical
volume can be marked full, preventing Content Manager OnDemand from writing
any additional data to the volume. Content Manager OnDemand will automatically
mark the volume full when it detects that it is full.

Disk pool storage groups

The disk pool storage group is used to identify an IBM i auxiliary storage pool
(ASP) that the archive storage management process may use as storage media
when migrating archived data. You must specify a pool number ranging from 1 to
32 which corresponds to an existing ASP. The type of data, primary or backup, that
will be stored to the defined ASP must also be specified.

| You can also use a mounted Network File System (NFS) exported directory as a
| disk pool. See “Using a Network File System (NFS) directory for document
| storage” on page 23 for detailed setup instructions.

Users
When you define an IBM Content Manager OnDemand user, you create a user ID
with which a person in your organization logs on to the Content Manager
OnDemand server. You can optionally add the user ID to folders and application
groups permissions, which is one way to let the user open folders and access data.

Each person in your organization logs on to the server using a Content Manager
OnDemand user ID. Content Manager OnDemand authenticates the user ID and
determines the usage and administrative authority available to that person, based
on the user ID. It is important that you understand the details in the OnDemand
user ID relationship to IBM i user profiles topic in the IBM Content Manager
OnDemand for i: Common Server Planning and Installation Guide before you continue
with this section.

An Content Manager OnDemand user ID does not necessarily have to identify an

individual by name. However, for accounting purposes, most customers assign a
Content Manager OnDemand user ID to each person that will use the system.
When you initialize the system, Content Manager OnDemand automatically creates
the QONDADM user ID. The QONDADM user ID has system administrator

68 Common Server Administration Guide

 authority. A system administrator can perform the basic user functions, such as
logging on the system and opening folders, and administrative functions, such as
defining users and groups to Content Manager OnDemand, and creating,
updating, and deleting application groups, applications, folders, migration policies
and storage sets, and printers.

Remember: The QONDADM user ID has an initial password of QONDADM1.

Because the QONDADM user ID has system authority, we force you to change the
password the first time you sign on.

When naming Content Manager OnDemand users, the name that you specify:
v Can contain one to 10 or 128 characters (bytes) depending on whether you are
linking i user profiles to your Content Manager OnDemand users. If you are
linking the two, then the user names should match your i user profile names.
v Cannot include the ’ (apostrophe), * (asterisk), % (percent), + (plus), _
(underscore), [ (left bracket), ] (right bracket), ″ (double quote), or blank
character
v Must be unique to the server
You can specify a user ID in mixed case. By default, Content Manager OnDemand
ignores the case (for example, LaGuarde is the same as laguarde). Content Manager
OnDemand converts lowercase letters in a user name to uppercase (LaGuarde is
stored as LAGUARDE). However, depending on how you configure the Login
Processing system parameters, user ID processing on your system may be different
(the case may be significant). See “System parameters” on page 52 for more
information.
“User types”
“Authority” on page 70

User types
When you add a user to IBM Content Manager OnDemand, you specify the User
Type. The User Type and the Authority determines the types of tasks that the user
can do when logged on to the system. You can choose from the following User
Types:
User Users can log on to Content Manager OnDemand, open folders that they
are authorized to access, and search for and retrieve data from application
groups that they are authorized to access. Users can be given authority to
do other things on the system.
User Administrator
A user that can also add, update, and delete users and user administrators.
A user administrator can be given authority to do other things on the
system.
Application Group/Folder Administrator
A user that can also add, update, and delete application groups,
applications, and folders. An application group/folder administrator is
automatically given Logical Views permission to all application groups. An
application group/folder administrator can be given authority to do other
things on the system.
System Administrator
A user that can also add, update, and delete any user, group, application
group, application, or folder on the system. A system administrator is

Concepts 69
 automatically given Logical Views permission to all application groups. A
system administrator is also the only user that can maintain storage sets
and printers.

Restriction: When adding or updating a user, you are not permitted to set the
User Type or Authority to a level that exceeds your own. For example, a user with
Create Users and Create Groups authority cannot create a user with Create Folders
authority.

By default, only the user, the user that created the user, user administrators, and
system administrators can view or maintain the user. See the User Permissions
page for more information.

Only a system administrator, an application group/folder administrator, a user

with administrator authority for an application group, or a user with add
document permission can store data in an application group.

Only a system administrator, an application group/folder administrator, or a user

with delete document permission can delete data from an application group.

Users who need to run server commands such as those listed in “Command
reference” on page 197 or server APIs from QSHELL such as those listed in “API
and user exit reference” on page 213 need to have QRDARSADM as the group
profile (or a supplemental group) in their IBM i user profile.

Authority
The Authority options allow the user to do other things in IBM Content Manager
OnDemand. For example, A User Type of User can be permitted to create users.
The authority options that you can select depend on the User Type. For example, if
the User Type is Application Group/Folder Administrator, then by definition, the
user can create application groups and folders. Therefore, the only additional
authorities that the user can be given are Create Users and Create Groups. Choose
from the following:

Create Users

An optional authority for users and application group/folder administrators:

v If the User Type is User, lets the user create users with a User Type of User.
v If the User Type is Application Group/Folder Administrator, lets the user create
users with a User Type of User or a User Type of Application Group/Folder
Administrator.

Tip: Users with Create Users authority can maintain the users that they create, so
long as they remain an administrator of the user.

Create Groups

An optional authority for users, user administrators, and application group/folder

administrators. Lets the user create groups. Users with Create Groups authority
can maintain the groups they create, so long as they remain a group owner.

Remember: These group definitions are not the same as IBM i group profiles,
although the names may match if you find that easier to maintain.

70 Common Server Administration Guide

 Create Application Groups

An optional authority for users and user administrators. Lets the user create
application groups. Users with Create Application Groups authority can maintain
the application groups that they create, so long as they remain an application
group administrator.

Create Folders

An optional authority for users and user administrators. Lets the user create
folders. Users with Create Folders authority can maintain the folders that they
create, so long as they remain a folder administrator.

Restriction: When adding or updating a user, you are not permitted to set the
User Type or Authority to a level that exceeds your own. For example, a user with
Create Users and Create Groups authority cannot create a user with Create Folders
authority.

Groups
IBM Content Manager OnDemand groups are a means to organize users of the
system by function, authorization, or any other purpose that you might require.
You do not have to assign a user to a group, however doing so can simplify
administration of users with similar requirements and capabilities.

When you define a group, you can add users to the group and specify folder and
application group permissions that are common to all of the users that belong to
the group. The permissions determine the types of actions users assigned to the
group can perform on the system.

When naming groups, the name that you specify:

v Can contain one to 128 characters (bytes)
v Cannot include the ’ (apostrophe), * (asterisk), % (percent), + (plus), _
(underscore), [ (left bracket), ] (right bracket), ″ (double quote), or blank
character
v Can be mixed case. However, the case does not create a unique name (LaGuarde
is the same as laguarde)
v Must be unique to the server

You can assign a group owner. The group owner can add users to and remove
users from the group. To maintain a group’s application group and folder
permissions, the group owner must have administrator authority for the
application groups and folders or be an application group/folder administrator or
a system administrator. If you do not assign a group owner, only a system
administrator user can maintain the group.

Remember: These group definitions are not the same as IBM i group profiles,
although the names may match if you find that easier to maintain.

Printers
IBM Content Manager OnDemand supports two types of server print devices: a
fax machine and a physical printer. A server print device always has an output
queue on the server and is defined using the System i Navigator administrative
client.

Concepts 71
 PSF/400 is required for formatting Advanced Function Presentation (AFP) print
output from Content Manager OnDemand. (PSF/400 may also be required by
some fax software as well.) PSF/400 allows you to use electronic forms, images,
graphics, and typographical fonts in the documents that you print. PSF/400
accepts input data streams, such as AFP and line data and prepares the data for
the destination print device.

When a user selects an item and chooses server print, Content Manager
OnDemand retrieves a copy of the item and places it on the output queue
associated with the server printer.

Storage sets
Storage sets are defined for application groups with similar storage management
characteristics, such as the length of time that files are maintained in the
application group and the type of media on which the files are stored. A storage
set is created automatically when you create a migration policy, and the names are
identical. You do not have to manually create a storage set.

If you plan to maintain application group data in archive storage, then you must
specify a storage set name in the application group definition that matches the
migration policy to be used. For more information on migrating and expiring
documents, and recommendations for storage management criteria defined in your
application groups, storage sets, and migration policies, see “Defining document
storage management” on page 13.

Application groups
An application group represents the data that you store in IBM Content Manager
OnDemand and the documents that users query, view, print, and fax using Content
Manager OnDemand client programs. For example, the data can be reports
generated by an application program, index data, and annotations created by users.

When you define an application group, you specify properties of the application
group, such as the organization of the database and the storage characteristics for
the files that are to be stored in the application group. You also define the database
fields that will hold index data extracted from the reports that you store in the
application group.

Content Manager OnDemand extracts index data from the reports that you load
into an application group and places the data in the database fields that you
define. Content Manager OnDemand uses the index values to identify the
documents that meet the search criteria entered by a user.

When you define an application group, you can also select the types of application
group messages that Content Manager OnDemand saves in the system log.

When you define an application group, you specify permissions that let users
access and maintain the application group and application group data. You can
identify the groups and users that can access data stored in the application group
with Content Manager OnDemand client programs. You can specify the types of
functions that users can perform, such as viewing, printing, and annotating
reports. You can assign administrator authority to a user or a group. Administrator
authority allows a user to update the application group, for example, to authorize
other users to access data stored in the application group.

72 Common Server Administration Guide

 Content Manager OnDemand organizes information about an application group
into tabs: General, Message Logging, Storage Management, Permissions, Field
Definition, and Field Information. Each tab contains options, fields for you to enter
information about the application group, and command buttons.

Applications
You typically define an application for each different type of report or source of
data that you plan to store in IBM Content Manager OnDemand.

When you define an application, you assign the application to an application

group and specify the physical and logical characteristics of the report. The
physical characteristics of a report include the code page, the type of data found in
the input file, and information about carriage control characters. The logical
characteristics of a report include the different ways that you want to present the
information contained in the report to your users.

The Content Manager OnDemand data indexing, loading, and viewing programs
use the information that you provide to process the report. For example, you can
specify the parameters that the Content Manager OnDemand indexing program
uses to locate and extract index data from the report. You can create logical views
for the application. Logical views represent different ways to display pages of the
report. You can set up printing options, such as defining a default printer for users
and printing options for AFP and line data documents.

Content Manager OnDemand organizes information about an application into tabs:

General, View Information, Indexer Information, Load Information, Logical View
Fields, Logical Views, and Print Options. Each tab contains options, fields for you
to enter information about the application, and command buttons.

Folders
A folder provides users the means to access the reports that you store in IBM
Content Manager OnDemand. A user opens a folder, constructs a query, and
retrieves documents from the application groups that can be searched from the
folder. The user can use the folder to view, print, annotate, fax, and email
documents.

When you define a folder, you specify the properties of the folder, such as the
name and description of the folder, create the search and display fields that appear
when the user opens the folder, and map the folder fields to application group
database fields.

You can also specify the groups and users that can open the folder with Content
Manager OnDemand client programs and other folder permissions. For example,
you can authorize a user to be the folder administrator. The folder administrator
can authorize other users to open the folder and make changes to the folder fields.

Content Manager OnDemand organizes information about a folder into tabs:

General, Permissions, Field Definition, Field Information, and Field Mapping. Each
tab contains options, fields for you to enter information about the folder, and
command buttons.

Concepts 73
About application groups, applications, and folders
Before you can store a report into IBM Content Manager OnDemand, you must
create an application group and an application. Before users can search for and
retrieve data, you must create a folder.
v Users open a folder to search for reports that you load into OnDemand. You
define one or more search fields for the folder. A folder search field is mapped
to an application group database field.
v Each database field that you define represents a category of information in the
report, such as a customer name, invoice number, or balance. When you add an
application group, Content Manager OnDemand creates a database table. The
database fields that you define are columns in the table.
v You define an application for each report that you plan to store in Content
Manager OnDemand. When you add an application to the system, you define
information that the Content Manager OnDemand viewing, indexing, and
loading programs use. When you define indexing information, you identify the
name, location, and length of each category of index information that you want
to extract from the report. When you define loading information, you map index
fields in the report to application group database fields.
v When you load a report into the system, Content Manager OnDemand stores the
index values extracted from the report into database fields in records that are
added to an application group table.
v Content Manager OnDemand uses the index values to identify the documents
that meet the search criteria that the user entered into the folder search fields.

When you want to define a report to Content Manager OnDemand, your first task
is to identify the application group from which Content Manager OnDemand
obtains information about the index fields and how documents are to be
maintained on the system. When you define an application group, you specify how
you want Content Manager OnDemand to structure information in the database
and define the database fields. When you define an application group, you also
specify how you want Content Manager OnDemand to maintain data on the
system. For example, you might specify that report data should be maintained on
disk storage for 60 days and in archive storage for five years. Content Manager
OnDemand maintains all of the data stored in the application group the same way.
Content Manager OnDemand maintains each report that you store in the
application group for the same length of time.
v You can store the report in an existing application group. However, you must be
able to index the report by using the database fields that are already defined in
the application group. The storage management information for the application
group must support the length of time that you want Content Manager
OnDemand to maintain the report on the system and how and where that you
want Content Manager OnDemand to store and maintain the report data.
You can verify information about an existing application group with the
Properties command. The General tab shows the database organization for the
application group. The Storage Management tab shows the data migration
information. The Field Definition tab shows the application group database
fields.
v If there are no application groups defined to Content Manager OnDemand or
there are no application groups that support the database and storage
management requirements of the report, then you must add an application
group to the system.

74 Common Server Administration Guide

 After you add an application group, you must define an application for the report.
Most customers create a Content Manager OnDemand application for each
different type of report or source of data that they plan to store in Content
Manager OnDemand. When you create an application, you must assign it to an
application group. The application group determines where Content Manager
OnDemand will store the report data. When you create an application, you also
specify information that the Content Manager OnDemand client programs use to
view and print pages of the report and you specify instructions for the data
indexing and loading programs.

The last step in the process of adding a report to Content Manager OnDemand is
to create a folder. Users open the folder to search for, display, and print reports.
When you define a folder, you select the application group that contains the data
that you want users to search when they open the folder. By creating folders that
can search specific application groups, you can determine the reports that are
available to users when they open a folder.

When you define a folder, you define search and display fields. You specify
characteristics of the folder fields, such as default search operators and whether
Content Manager OnDemand displays default search values for the fields when a
user opens the folder. You also map the folder fields to application group database
fields.

OnDemand permissions
Permissions are the means by which IBM Content Manager OnDemand determines
who can open folders and search for documents stored in application groups.
Content Manager OnDemand also uses permissions to determine who can
maintain folders and application groups with the administrative client.

By default, only an application group/folder administrator, a system administrator,

or the person who adds the folder can open and maintain the folder. By default,
only an application group/folder administrator, a system administrator or the
person who adds the application group can access data stored in the application
group or maintain the application group.

Content Manager OnDemand provides several ways for you to specify

permissions. You can specify permissions when you add or update a folder or an
application group. You can also add, remove, or update a user’s or group’s folder
or application group permissions when you add or update the user or group.

As both a convenience and security measure, you can assign a user to a group.
Content Manager OnDemand groups allow you to organize users by function,
authorization, or any other logical grouping that you might require. When you
assign a user to a group, the user obtains the permissions that are in effect for the
group. For example, suppose that you create a group and authorize the group to
open the Student Information folder. Any user that you assign to the group
automatically obtains permission to open the Student Information folder. If you
assign a user to more than one group, the user normally obtains the permissions of
all of the groups. However, there are exceptions. See “Specifying permissions” on
page 76 for details.

Remember: These group definitions are not the same as IBM i group profiles,
although the names may match if you find that easier to maintain.

Concepts 75
 You can specify a default set of permissions for folders and application groups.
Content Manager OnDemand uses the default permissions when users and groups
do not have specific permissions for the folder or application group. If you specify
permissions for a group, then the group permissions take precedence over the
default permissions. If you specify permissions for a user, then the user
permissions take precedence, regardless of any group that the user may belong to
or the default permissions that you specified.
“Folder permissions”
“Application group permissions”
“Specifying permissions”

Folder permissions
You can specify default (*PUBLIC) folder permissions and folder permissions for
specific groups and users. The default permissions provide every user and group
defined to the server with the permissions that you specify. Permissions for a
group provide the users that you add to the group with the permissions that you
specify for the group. Permissions for a user provide the user with the permissions
that you specify. By default, only an application group/folder administrator, a
system administrator or the person who adds the folder can open and maintain the
folder.

Refer to online help for details about setting folder permissions.

Application group permissions

You can specify default (*PUBLIC) application group permissions and application
group permissions for specific groups and users. The default permissions provide
every user and group defined to the server with the permissions that you specify.
Permissions for a group provide the users that you add to the group with the
permissions that you specify for the group. Permissions for a user provide the user
with the permissions that you specify. By default, only an application group/folder
administrator, a system administrator or the person who adds the application
group can access data stored in the application group and maintain the application
group.

Refer to online help for details about setting application group permissions.

Specifying permissions
To ease the administration of IBM Content Manager OnDemand, most customers
organize their users into groups, add the groups to folders and application groups,
and specify permissions for the groups. You should plan your groups before you
begin creating them. After you start using the system, you may find it difficult to
change the organization of your groups.

Remember: These group definitions are not the same as IBM i group profiles,
although the names may match if you find that easier to maintain.

When you add a user to a group, the user automatically obtains the permissions
that were specified for the group. When you add a user to more than one group,
the user normally obtains the permissions of all of the groups. For example, using
the group properties listed in the table, a user that belongs to both groups can
open the Student Bills and Student Transcripts folders.

76 Common Server Administration Guide

Table 2. Group permissions
Group GID Folders Permission
Admissions 1080100 Student Transcripts Access
Accounting 1080101 Student Bills Access

Most situations involve adding a group to a folder, specifying permissions for the
group, and then adding users to the group. However, there may be situations
when you need to deny a group of users access to a folder. When you use groups
to deny access to a folder, you must understand how Content Manager OnDemand
determines folder permissions for a group (and users assigned to the group). For
example, consider the group properties listed in the following table.
Table 3. Group permissions
Group GID Folders Permission
Admissions 1080100 Student Bills None
Admissions 1080100 Student Transcripts Access
Accounting 1080101 Student Bills Access
Accounting 1080101 Student Transcripts Access

A user that belongs to both groups can not open the Student Bills folder.

When a user belongs to more than one group, Content Manager OnDemand uses
the group identifier (GID) to determine the user’s permissions. When two (or
more) groups provide permissions for the same folder, the user obtains the
permissions of the group with the lowest GID.

It is important to note that you cannot change a GID after a group has been
created. You can, however, modify the value that is presented as the suggested
GID when the group is created.

In the example depicted in the second table, both groups have been added to the
Student Bills folder. Since the Admissions group has a lower GID than the
Accounting group, Content Manager OnDemand uses the permissions specified for
the Admissions group to determine the permissions of a user that is assigned to
both groups. Consequently, users assigned to both groups cannot access the
Student Bills folder.

You’re probably asking yourself, Why would I assign a user to more than one
group? or Why would I create a group with no access to a folder? Perhaps some
examples will help answer these questions (and clarify the Content Manager
OnDemand permission hierarchy). As you review the examples, please remember
the following rules:
v By default, only an application group/folder administrator, a system
administrator, or the person who created the folder can access the folder
v You can use the *PUBLIC name to specify default permissions for all other users
v You can specify permissions for specific groups and users:
– All of the users that belong to a group that you add to a folder will obtain
the permissions that you specify for the group
– A user that belongs to two (or more) groups that have been added to the
same folder will obtain the permissions of the group that has the lowest GID

Concepts 77
 – The permissions that you specify for a user override all other permissions,
including any default permissions (*PUBLIC) and any groups to which the
user belongs and that are added to the folder
“Examples”

Examples
The examples that follow show how to add groups to folders and specify folder
permissions. The same considerations hold true for adding groups to application
groups and specifying application group permissions.
“Providing a group of users access to a folder”
“Denying a group of users access to a folder”
“Providing one group of users access and denying another group of users
access to the same folder”
“Denying one user in a group access to a folder” on page 79
“Providing one user in a group administrator authority” on page 79
“Specifying default permissions” on page 80

Providing a group of users access to a folder:

About this task

Let’s say that you want to provide a single group of users access to a folder.
Complete the following steps:
1. With *PUBLIC selected, clear all of the permissions check boxes (this is the
default).
2. Add the group to the folder.
3. Select the Access check box.

Results

Users assigned to the group automatically obtain permission to open the folder.

Denying a group of users access to a folder:

About this task

Let’s say that you want to prohibit a single group of users from accessing a folder,
while allowing all other users defined to the server to open the folder. Complete
the following steps:
1. With *PUBLIC selected, select the Access check box (this lets all users open the
folder).
2. Add the group to the folder.
3. Clear all the permissions check boxes.

Results

Users assigned to the group cannot open the folder.

Providing one group of users access and denying another group of users access
to the same folder:
About this task

Let’s say that you want to allow a group of users to access a folder. However, you
need to prohibit certain users in the group from accessing the folder. You could

78 Common Server Administration Guide

exclude the users from the group that can access the folder. However, there may be
other folders that you want the users to access as part of the group. To solve this,
create two groups, one without access to the folder and the other with access to
the folder, and assign the users to the respective groups. For example:
1. Create the ″no access″ group. This group must have a lower GID than the
″access″ group. Add users to the group.
2. Create the ″access″ group. Add users to the group.
3. With *PUBLIC selected, clear all of the permissions check boxes (this is the
default).
4. Add the ″access″ group to the folder.
5. Select the Access check box.
6. Add the ″no access″ group to the folder.
7. Clear all of the permissions check boxes.

Results

If you later need to deny other users access to the folder, simply add the users to
the ″no access″ group. You can also move users from one group to the other.

Denying one user in a group access to a folder:

About this task

Let’s say that you want to prohibit one user in a group from accessing a folder.
After adding the group to the folder and specifying the access permission, all users
assigned to the group can open the folder. To override the group permissions, we
can add an individual user to the folder and set permissions at the user level.
Complete the following steps.
1. With *PUBLIC selected, clear all of the permissions check boxes (this is the
default).
2. Add the group to the folder.
3. Select the Access check box.
4. Add the user to the folder.
5. Clear all the permissions check boxes.

Results

Even though the user belongs to the group, the user cannot open the folder.

Providing one user in a group administrator authority:

About this task

Let’s say that you want to provide one user in a group the ability to administer the
folder. Complete the following steps.
1. With *PUBLIC selected, clear all of the permissions check boxes (this is the
default).
2. Add the group to the folder.
3. Select the Access check box.
4. Add the user to the folder.
5. Select the Administrator check box.

Concepts 79
 Results

Only the user that you added can administer the folder; the other users in the
group can open the folder.

Specifying default permissions:

The default (*PUBLIC) permissions that you specify for an application group or a
folder will apply to every user or group defined to the server who is not provided
with specific permissions.

For example, suppose that you specify Access as the default permission for an
application group. Every user and group that is not provided with specific
permissions can access the data that is stored in the application group. Then, you
specify Access as the default permission for a folder. Every user and group that is
not provided with specific permissions can open the folder. Later, you add a user,
without specifying application group or folder permissions. The user can open the
folder and access the data stored in the application group.

While default permissions do provide flexibility to maintain your system, you

must make sure that using the default permissions does not circumvent your
security strategy. Rather than specifying default permissions for application groups
and folders, you may want to use groups as a means to implement your security
strategy. For example, you can clear all of the permissions under *PUBLIC and
then add groups to a folder and specify the appropriate permissions for each
group. When you add a user to the system, you can assign the user to a group.
The user automatically obtains the permissions of the group. If the group does not
have access to a particular application group or folder, then neither does the user.
With this strategy, until you assign the user to a group, or provide the user with
specific permissions, the user cannot access the folder.

Hints and tips

1. To simplify the task of providing access to application groups and folders, give
access to a group rather than a user. When a new user needs access, add the
user to the group.
2. To allow an Application Group/Folder Administrator to see groups in the
permissions list, add the Application Group/Folder Administrator to the
groups that require access to application groups and folders.
3. To allow multiple users to administer the same groups, create a group of users
and make that group the group owner for any groups that need to be
administered by multiple users.
4. The Create Groups authority is most effectively used if it is combined with the
Create Users authority or added to a User Administrator. Because the purpose
of a group is to give a set of users permissions to another object, it is not very
useful if the user that creates the group does not have access to any users.
Otherwise, the user that creates a group must be given access to each user that
needs to be added to the group.
5. If you need to reset the IBM Content Manager OnDemand information related
to your optical volumes, issue the following program call (with no parameters):
CALL PGM(QRDARS/QRLCASMROV)

Running this program updates the Optical Volume Capacity, recalculates the
Optical Bytes Used, and sets the Optical Volume Full Flag to Y if it is currently
set to N and the optical volume has less than 1 MB of space available. This

80 Common Server Administration Guide

program can only be run by a user profile with QONDADM group or
supplemental group profile in their user profile.
You should not run this program while the Archive Storage Manager (ASM) or
the Disk Storage Manager (DSM) with ASM(*YES) are running. The program
may cause some or all optical volumes that are known to Content Manager
OnDemand to be mounted to check for space.

Concepts 81
82 Common Server Administration Guide
|

| LDAP (Lightweight Directory Access Protocol) authentication

| support
| The Lightweight Directory Access Protocol (LDAP) is an open industry standard
| that has evolved to share information between distributed applications on the same
| network, organize information in a clear and consistent manner, and prevent
| unauthorized modification or disclosure of private information. In recent years,
| LDAP has gained wide acceptance as the directory access method of the Internet,
| and becomes strategic within corporate intranets.

| You can use LDAP to manage basic login authentication directly on the server.

| Requirements
| An LDAP Version 2 or Version 3 server

| How OnDemand works with LDAP

| The following diagram illustrates how OnDemand works with LDAP:

|
|
OnDemand
client

OnDemand Version 2 or
Version 3
LDAP server

HTTP
Browser ODWEK
client HTTP server/Application server
|
| Figure 3. How OnDemand works with LDAP
|
| When an OnDemand client makes a login request to the server, if you enabled
| LDAP authentication in the server, the OnDemand server makes an authentication
| request to the LDAP through either an anonymous or credentialed bind.

| This initial call accesses the LDAP server, searches for the user’s credentials and
| finds the user’s distinguished name (DN). If the user’s DN is found, the Content
| Manager OnDemand server makes another call to the LDAP server using that DN
| to confirm that the password that was given by the user is correct. If the password
| is correct, the LDAP server returns a mapped attribute in LDAP, which is the
| OnDemand user ID. The OnDemand server takes the attribute, and proceeds with
| its login.

| Enabling LDAP authentication

| To enable LDAP authentication, using the OnDemand Administrator client,

| right-click your OnDemand server, and select System Parameters. In the System
| Parameters window, under LDAP Authentication, select the Enable LDAP check

© Copyright IBM Corp. 1991, 2010 83

| box. You should also select the Password Case Sensitive check box under Login
| Processing if your LDAP server permits mixed case passwords.

| You must also add information about the LDAP server and the LDAP attributes
| that are used for authentication to the ars.cfg file for the instance.

| The following lines from the ars.cfg file show sample attributes to anonymously
| connect to the LDAP server called myserver.mycompany.com and to use the
| mapped attribute primaryuserid as the OnDemand user ID.
| # LDAP ENABLEMENT
| ARS_LDAP_SERVER=myserver.mycompany.com
| ARS_LDAP_PORT=
| ARS_LDAP_BASE_DN=ou=myserver,o=mycompany.com
| ARS_LDAP_BIND_DN=
| ARS_LDAP_BIND_DN_PWD=
| ARS_LDAP_BIND_ATTRIBUTE=mail
| ARS_LDAP_MAPPED_ATTRIBUTE=primaryuserid
| ARS_LDAP_ALLOW_ANONYMOUS=TRUE

| After enabling LDAP support, you must stop and restart the OnDemand server for
| the changes to take effect.

| Other considerations
| v OS400 security integration is not supported when you are using LDAP. When
| LDAP is enabled, you should disable OS400 security integration by editing the
| ars.ini file. For the instance that is using LDAP, change
| SRVR_FLAGS_SECURITY_EXIT=1 to SRVR_FLAGS_SECURITY_EXIT=0.
| v After you disable OS400 security integration, the password for the
| administrative user QONDADM is blank. It is recommended that you
| immediately change the password for QONDADM. Do not delete QONDADM
| from the instance.
| v After you disable OS400 security integration, it is recommended that you change
| the system parameters of the instance to set a minimum password length. To do
| this, log on to the OnDemand Administrator client, right-click the instance with
| LDAP enabled, select System Parameters, and then set the Minimum Password
| Length.
| v After you disable OS400 security integration, you must specify a password when
| you add a user to OnDemand.
| v If you enable LDAP on an existing instance, all existing users will have a blank
| password. Use the OnDemand Administrator client to set a password for each
| user.
| v Even when you are using LDAP, you must still add your users to the
| OnDemand instance. The OnDemand user ID must match the value that is
| returned by the LDAP server in the field that is mapped to
| ARS_LDAP_MAPPED_ATTRIBUTE in your ars.cfg file.
| v If the LDAP authentication fails, OnDemand will attempt its normal logon
| process by using the user ID and password that was entered. This permits users
| that are not in the LDAP directory to access OnDemand.
|

84 Common Server Administration Guide

Examples
The examples that follow demonstrate how to use the IBM Content Manager
OnDemand System i Navigator component to:
v Create tape devices that are available for use by Content Manager OnDemand if
tape archival is selected.
v Add tape volumes which are available for use by Content Manager OnDemand
v Create optical storage groups which are used to group sets of optical volumes
together to store related data.
v Add optical volumes which are available for use by Content Manager
OnDemand.
v Create a disk pool storage group definition to identify an OS/400® i Auxiliary
Storage Pool (ASP) that the archive storage management (ASM) process may use
as storage media when migrating archived data.
v Create monitor definitions which contain information about the output queue to
be monitored, the handling of the spooled files being archived, and information
about starting and ending the monitor job.
v Create migration policies which provide migration and storage media
characteristics for data archived using Content Manager OnDemand.

The examples that follow also demonstrate how to use the Content Manager
OnDemand Administrator to:
v Add users and groups to the system. Users on the system obtain permission to
open folders and access application group data from a group.
v Define a server printer that can be used as the default printer for an application.
v Define a migration policy and storage set.
v Add a report to the system. To add a report, create an application group, an
application, and a folder.
“System configuration” on page 86
“Adding tape devices” on page 86
“Adding tape volumes” on page 87
“Creating optical storage groups” on page 89
“Adding optical volumes” on page 90
“Creating disk pool storage groups” on page 91
“Creating monitor definitions” on page 92
“Creating migration policies” on page 95
“Adding users” on page 97
“Adding groups” on page 105
“Adding server printers” on page 110
“Adding storage sets” on page 112
“Adding a report” on page 112
“Adding a new field to an existing application group/application/folder” on
page 142
“Local server setup for offline administration” on page 142

© Copyright IBM Corp. 1991, 2010 85

System configuration
The example assumes that an external customer (Customer XYZ) accesses the
system by using the OnDemand Web Enablement Kit (ODWEK) feature. However,
for purposes of demonstrating how the system works and how to use the
administrative client to implement the requirements, these users could easily
represent another department within the company.

Here are the assumptions about the system:

v Two groups of users: the customer service department and users at Customer
XYZ.
v A sample telephone bill report. The telephone report is generated by an
application program running on an IBM i system with IBM Content Manager
OnDemand installed.
v Disk storage. When a report is loaded into the system, Content Manager
OnDemand stores a copy on disk and maintains the report on disk for 60 days.
v Archive storage. When a report is loaded into the system, Content Manager
OnDemand stores a copy of the report in archive storage. The archive storage
manager maintains the report on optical storage for five years.

Adding tape devices

About this task

To add a tape device to IBM Content Manager OnDemand:

1. Left click on the plus sign in front of Common Server Administration from the
Content Manager OnDemand Archive plug-in of System i Navigator, right click
on Tape Devices and select New Tape Device.
2. First, the name of the tape device you want to add to Content Manager
OnDemand must be specified. The name must match the name of an existing
IBM i tape device description. In this example, the name of the tape device is
TAP01. You may also provide a brief description for your tape device.
3. From the list of supported media types, select the media type for this tape
device. In this example, the media type is 8MM.
4. Once you select the media type, the Add button for the Read and Write
operations is no longer grayed out. Click on the Add button to add the 8MM
media type to the Read and Write operations. If the device you are using has
an automatic cartridge loader, you can specify the number of cartridges the
loader holds. In the example, leave this at 0. Leave the media library blank. If
you are using a media library such as the IBM 3494 tape library with Content
Manager OnDemand, specify the library name here.
5. Click on OK to create the tape device. See the following figure.

Example

The following figure shows the Tape device.

86 Common Server Administration Guide

Figure 4. Tape device

Adding tape volumes

About this task

To add tape volumes to IBM Content Manager OnDemand:

1. Left click on the plus sign in front of Common Server Administration from the
Content Manager OnDemand Archive plug-in of System i Navigator, right click
on Tape Volumes and select New Tape Volume.
2. First, specify the name of the tape volume that you want to make available to
Content Manager OnDemand. The volume name must match the name you
used when you initialized the tape volume on your IBM i server. For the
example, the name of the volume is OND001.
3. Next, specify the total capacity of the tape volume in megabytes. For the
example, specify a capacity of 2300 MB.

Examples 87
 4. For media type, use the pull down to select the correct type. For the example,
select 8MM.
5. For this example, leave media device library blank. Also, make sure Tape is full
is not checked.
6. The migration policy, which will be created later, will request a tape backup.
So, for this example, make the volume type Backup. If, instead, the plan was to
use this tape volume for the primary archive media for some of the Content
Manager OnDemand data, you would leave the volume type set to Primary as
shown in the following figure. For this example, however, set the volume type
to Backup.
7. Then click OK to create the volume. See the following figure..

Example

88 Common Server Administration Guide

Figure 5. Tape volume

Creating optical storage groups

About this task

To create an optical storage group in IBM Content Manager OnDemand:

1. Left click on the plus sign in front of Common Server Administration from the
Content Manager OnDemand Archive plug-in of System i Navigator, right click
on Optical Storage Groups and select New Storage Group.
2. The optical storage group is used to group sets of optical volumes together for
use by Content Manager OnDemand. For the example, call the optical storage
group OPTSTG. You may also provide a brief description.

Examples 89
 3. The optical volumes are rewritable and support the dynamic reuse of space
without re-initializing the entire volume. So for this example, check the Volume
full reset box and set the Free space threshold percent at 40 by clicking on the
up arrow. This indicates when the volume full flag is reset. In the example,
when there is 40 percent free space available on the volume, the full flag is
reset and the volume can again be used for newly migrated data.
4. This optical storage group will contain primary volumes; mark the type as
Primary.
5. Leave the instance as the default QUSROND and click OK to create the optical
storage group. See the following figure.

Example

Figure 6. Optical storage group

Adding optical volumes

About this task

To add optical volumes to IBM Content Manager OnDemand:

1. Left click on the plus sign in front of Common Server Administration from the
Content Manager OnDemand Archive plug-in of System i Navigator, right click
on Optical Volumes and select New Common Server Optical Volume.
2. The volume name specified must match the name used when the volume was
initialized in the optical library. A single disk has two sides which are
considered volumes. As you will see in a later step, the opposite side volume
name must be specified. The name for this volume is OND00001.
3. Remember that the optical storage group was Primary, which means that all
the volumes assigned to that storage group must also be of type Primary.
Therefore, mark this volume as Primary.
4. Leave the instance as the default of QUSROND.

90 Common Server Administration Guide

 5. For this example, use a 2.6 GB optical disk. The capacity is for one side of the
disk (one volume), so for the example, specify 1300 MB.
6. The volume being defined is a rewritable volume. To select the Optical media
family, use the pull down and select REWT. . You can also use the pull down
for the Optical storage group and select the storage group that was created
earlier, OPTSTG. The volume is defined as REWT, so it is not necessary to
specify the Optical library. (See the online help for more information.) You may
specify the library for documentation purposes if you like. In the example, this
field will be left blank
7. Leave the volume marked as not full. This flag will automatically be set to full
when the optical volume has reached its capacity. Remember when the storage
group was created, the free space threshold was set to 40%. When this volume
has 40% free space available, the full flag will be unchecked and Content
Manager OnDemand can again write to this volume.
8. Specify the name of the opposite side of this volume as OND00002. Click OK
to create the volumes. . See the following figure.

Results

Figure 7. Optical volume

Creating disk pool storage groups

About this task

To create a Disk pool storage group to IBM Content Manager OnDemand:

1. Left click on the plus sign in front of Common Server Administration from the
Content Manager OnDemand Archive plug-in of System i Navigator, right click
on Disk Pool Storage Groups and select New OnDemand Disk Pool.

Examples 91
| 2. Identify an IBM i Auxiliary Storage Pool (ASP) or a mounted Network File
| System (NFS) directory that the archive storage management (ASM) process
| may use as storage media when migrating archived data. For the example,
specify the ASP as 3. You may also provide a brief description for the disk pool
storage group.
3. The type for the disk pool is Primary and the instance is the default
QUSROND. Click OK to create the disk pool storage group. See the following
figure.

Example

Figure 8. Disk Pool

Creating monitor definitions

About this task

To create a monitor definition:

1. Left click on the plus sign in front of Common Server Administration from the
Content Manager OnDemand Archive plug-in of System i Navigator, right click
on Monitor Definitions and select New Monitor.
2. When the New Monitor window opens up, the general page will be displayed.
Specify the name and library of the output queue to monitor. For this example,
specify the output queue as MONITORQ in library QRDARS. (However, your
monitored output queues should not be placed in QRDARS library, since that
library can be replaced during a software upgrade.) The job name is
automatically filled in with the same name as the monitored output queue you
specified. This can be changed, but for the example leave it as MONITORQ.
You may also provide a brief description for the monitor definition.

92 Common Server Administration Guide

 When the monitor job selects a spooled file from the specified output queue for
processing, it needs to determine which application group to associate with the
spooled file so that the file can be archived correctly. The only data available to
the monitor are the attributes of the selected spooled file. The application group
name must be derived from the contents of one of these attributes.
3. Use the pull down to select the attribute that the monitor should use for
comparing to find the application group with the matching name. For the
example, use Spooled file name. You can also specify what the monitor should
check next and last if it does not find a match on check first. In this example,
leave check next and last blank.
4. You can check the box to have the monitor job determine the application name
used or you can specify what the monitor should check for comparing to find
the application name. In this example, check the box and let the monitor job
determine the application name.
5. You may also specify the job description, library and instance to be used for
this monitor job. Leave these values as the default for this example.
6. Once the general page has been completed you can click on the Start and End
Methods tab. There are several options for starting and ending the monitor job.
Accept the defaults for this example which are to start and end the monitor
manually. However you can specify whether the monitor will be started from a
job scheduler or when a subsystem starts. You can also specify to have the
monitor job end at a specific time of day, after a certain period of time, after all
entries have been processed from the output queue, or you can specify the end
time as a parameter when the monitor is started.

Tip: The first time you start a monitor for a particular output queue, it is best
to do it when there are no spooled files in the output queue. When a monitor is
started for the first time, an empty data queue with the same name as the
output queue is created, which will receive entries for all spooled files that
appear in the output queue in Ready status. Once the output queue monitor
has been started (and therefore the data queue has been created), you can then
begin moving the spooled files that you wish to capture into the output queue.
The data queue entries that get created will trigger the monitor to process each
spooled file.
7. Next click on the Actions Taken on Spooled Files tab. This specifies what
Content Manager OnDemand should do with a spooled file once it has been
successfully processed. The options are to have it deleted from the system or
moved to an output queue you specify. In the example, the spooled file will be
moved to a processed output queue called PROCESSED in library
QUSRRDARS. You must also specify where you want the spooled files to be
sent should they fail to process. In the example, specify ERROR in library
QUSRRDARS as the error queue.
8. Click on OK to create the monitor definition.

Example

The following figures show the General, Start and End Methods, and Actions
Taken on Spooled Files tabs in the New Monitor dialog box.

Examples 93
Figure 9. Monitor — General tab

94 Common Server Administration Guide

Figure 10. Monitor — Start and End Methods tab

Figure 11. Monitor — Actions Taken on Spooled Files tab

Creating migration policies

About this task

To create a new migration policy:

Examples 95
 1. Left click on the plus sign in front of Common Server Administration from the
IBM Content Manager OnDemand Archive plug-in of System i Navigator, right
click on Migration Policies and select New policy.
2. First you must specify the name of your migration policy. The name can be up
to 60 characters long, but must not duplicate the name of another policy within
the same instance. For this example, choose POLICY1 as the new policy name.
You may also provide a brief description of the migration policy you are
creating.
3. You can choose whether or not you want to enable aggregation. If aggregation
is enabled, you must select whether you want to close the aggregate only when
the maximum size is reached or after a specified time period is reached. Accept
the default to enable aggregation and close the aggregate after the maximum
size if reached. However, change the maximum size, by clicking on the up
arrow, to 10,000 kilobytes. (See “Migration Policies” on page 65 for more
information on migration policies and aggregation.)
4. You may also specify if a tape backup is requested. Request a tape backup and
select the Media type by clicking on the pull down and selecting 8MM.
5. The instance is the logical server environment that will contain the archive data
to which this migration policy will relate. For this example, leave the instance
as the default of QUSROND.
6. In this example, when a report is archived into Content Manager OnDemand,
a copy is stored on disk for 60 days. A copy is also maintained in optical
storage for 5 years. This information will be used to set up the storage levels
within the migration policy.
a. For the first level, click on Add After. This opens the New Policy Level
window.
b. Assign a level identifier and this identifier must be unique within this
policy. For this example use 0010 as the level identifier. You may also
provide a brief description of this level.
c. For the media, select Disk pool and the duration at this level should be 60
days.
d. For the primary storage group, click on the pull down to see a list of
available disk pool storage groups.
e. Select the one created earlier called ASP01, then click OK. This will add the
storage level in the storage levels window within the policy.
f. To add the next level, select the level that was just added and then click on
Add After.
g. Specify the level identifier as 0020 with a brief description. The media is
Optical and the number of days is 1825 (5 years).
h. Choose the optical storage group that was created earlier, OPTSTG, as the
primary storage group.
i. Click OK, and you should now see both storage levels listed for the
migration policy. In both storage levels, the Create backup copy option was
not selected. However, you can select this option and specify a backup
storage group causing the migration process to create a duplicate copy of the
archived data when it is moved to this level.
j.
7. Click on OK to create the migration policy. Clicking OK will also create a
Content Manager OnDemand storage set of the exact same name. When you
define an application group to Content Manager OnDemand, you can select the

96 Common Server Administration Guide

 storage set name that matches this migration policy, which will cause Content
Manager OnDemand to archive that application group data as defined here. See
the following figure.

Example

Figure 12. Migration policy

Adding users
“The basics”
“Examples” on page 101

The basics
In general, here is how you work in the administrative client to add a user:
1. In the IBM Content Manager OnDemand Archive section of System i Navigator,
right click Common Server Administration. In the resulting context menu,
click Client Administrative Functions, then logon.
2. Choose a server and select Users.
3. Pick one of two ways to add a user.
4. Define the properties of the user by completing fields in the Add a User dialog
box.
5. Optionally add the user to groups. See the online help for more details.

Examples 97
 6. Optionally add the user to application groups and set application group
permissions.
7. Optionally add the group to folders and set folder permissions.
8. When finished, add the user by clicking OK in the Add a User dialog box.

Note:
1. To add a user, the logon user ID must be a user with create users authority, a
user administrator, or a system administrator.
2. To make problem determination easier, IBM recommends that each user profile
that will be used to load reports (ADDRPTOND, STRMONOND, arsload,
arsdoc add) have a home directory in IFS on the IBM i server. If a home
directory exists for a user profile running one of the load commands, any
output files and temporary files will be placed in that user profile’s home
directory rather than ″lost″ within the entire root directory on the IBM i system.
To create a home directory for a user profile, issue the following command:
MD ’/home/usrprf/’ where usrprf is the name of the user profile that will be
used to load reports.

The following table shows the minimum authority requirements are needed to
perform the specified actions.

For starting the monitors and loading documents, it is assumed that the user
performing these functions has proper authority to the output queue being
monitored or the document being loaded using the Add Report to OnDemand
(ADDRPTOND) command. Providing proper authority to the output queue can be
done by granting specific authority to the output queue or giving *SPLCTL to the
user profile. Be aware that *SPLCTL means that the user will be able to view any
spooled file in any output queue on the system.
| Table 4. Authority Requirements
| Action Minimum authority requirements
| Creating an instance The user profile used to create an instance must have all
| the special authorities of a *SECOFR User Class.
| Starting the servers To start the servers using the Start TCP/IP Server
| (STRTCPSVR) command and specifying *ONDMD for the
| SERVER parameter, you must have QONDADM user
| profile specified as a group or supplemental group profile
| in your user profile and you must have *USE authority to
| the STRTCPSVR command (and End TCP/IP Server
| (ENDTCPSVR) command to end the servers).

| To start the servers using the QRDARS/QRLMCTL

| program, you must have QONDADM user profile specified
| as a group or supplemental group profile in your user
| profile.
| Using the Content Manager To use the Content Manager OnDemand Archive plug-in of
| OnDemand Archive plug-in the System i Navigator (part of IBM i Access for Windows)
| of System i Navigator for to perform all administrative functions except Migration
| administrative functions Policies, you must have QRDARS400 and QONDADM user
| profiles specified as a group or supplemental group profile
| in your user profile. To work with Migration Policies, you
| must also have your Content Manager OnDemand user ID
| defined as a System Administrator in the OnDemand
| Administrator Client.

98 Common Server Administration Guide

| Table 4. Authority Requirements (continued)
| Action Minimum authority requirements
| Starting the monitors to To start the Content Manager OnDemand monitor(s) for a
| archive spooled files specific output queue using the Start Monitor for
| OnDemand (STRMONOND) command, you must have
| QONDADM user profile specified as a group or
| supplemental group profile in your user profile. The user
| issuing the STRMONOND command must also be defined
| as an Administrator on the Permissions tab for every
| Application Group to which a spooled file in the monitored
| output queue might be archived to, or have your Content
| Manager OnDemand user ID defined as an Application
| Group/Folder/Cabinet Administrator in the OnDemand
| Administrator Client. If you would like to add the
| STRMONOND command to the IBM i job scheduler, the
| profile specified in the USER parameter of the Add Job
| Schedule Entry (ADDJOBSCDE) command should have
| QONDADM user profile specified as a group or
| supplemental group profile and must also be defined as an
| Administrator on the Permissions tab for every Application
| Group to which a spooled file in the monitored output
| queue might be archived to, or have your Content Manager
| OnDemand user ID defined as an Application
| Group/Folder Administrator in the OnDemand
| Administrator Client.
| Storing spooled files Using the Add Report to OnDemand (ADDRPTOND)
| manually command to store spooled files manually requires the same
| minimum authority as the user profile used to run the
| Content Manager OnDemand monitors (as described
| above).
| Manually removing a To manually remove a document from Content Manager
| document from Content OnDemand using the Remove Report from OnDemand
| Manager OnDemand (RMVRPTOND) command, you must have QRDARS400
| and QONDADM user profiles specified as a group or
| supplemental group profile in your user profile. The user
| issuing the RMVRPTOND command must also be defined
| as an Application Group/Folder/Cabinet Administrator, or
| have Delete authority on the Permissions tab for the
| Application Group (in the OnDemand Administrator
| Client) from which the document is being removed.
| Using the Start Disk Storage To run the Start Disk Storage Management (STRDSMOND)
| Management (STRDSMOND) and the Start Archived Storage Management
| and the Start Archived (STRASMOND) commands, you must have QONDADM
| Storage Management user profile specified as a group or supplemental group
| (STRASMOND) commands profile in your user profile. If you want to add these
| commands to the i job scheduler, the profile specified in the
| USER parameter of the Add Job Schedule Entry
| (ADDJOBSCDE) command must have QONDADM user
| profile specified as a group or supplemental group profile.
| Alternately, you might use the instance user profile (the
| user profile with a name that matches the instance name)
| for the USER parameter.

Examples 99
| Table 4. Authority Requirements (continued)
| Action Minimum authority requirements
| Combining spooled files prior To use the Merge Spooled FIles (MGRSPLFOND) command
| to loading into Content to merge multiple, smaller spooled files into one large file
| Manager OnDemand prior to loading into Content Manager OnDemand, you
| must have QONDADM user profile specified as a group or
| supplemental group profile in your user profile. To use the
| ARCHIVE parameter of the MGRSPLFOND command, you
| must also be defined as an Administrator on the
| Permissions tab for every Application Group to which a
| spooled file in the monitored output queue might be
| archived to, or have your Content Manager OnDemand
| user ID defined as an Application Group/Folder/Cabinet
| Administrator in the OnDemand Administrator Client.
| Using the Change Policy To use the Change Policy Level Date (CHGPLDOND)
| Level Date (CHGPLDOND) command to change the migration policy next level date for
| command objects to force movement to a new level in the migration
| policy sooner, you must have QONDADM and
| QRDARS400 user profiles specified as a group or
| supplemental group profile in your user profile.
| Using the Migrate Media To use the Migrate Media (MGRMEDRDAR) command to
| (MGRMEDRDAR) command migrate Spool File Archive data from optical back to disk,
| or from disk to the Common Server archived storage
| manager (ASM), for example, you must have QONDADM
| and QRDARS400 user profiles specified as a group or
| supplemental group profile in your user profile.
| Using the graphical mark up To use the graphical mark up tool in the OnDemand
| tool in the OnDemand Administrator Client to create a new application or alter the
| Administrator Client to create indexer parameters of an existing application, you must
| a new application or alter the have QONDADM user profile specified as a group or
| indexer parameters of an supplemental group profile in your user profile. For AFP
| existing application data, a temporary file is created in /tmp IFS directory,
| which must exist prior to using the mark up tool.
| Printing or faxing on the To print or fax a document from the Content Manager
| server OnDemand end user client to a server printer or fax, you
| must have Access permission and Print or Fax permission
| for the Folder and Access permission for the Application
| Group that the document is archived to. To use the Print
| Report from OnDemand (PRTRPTOND) command to
| reprint a document using a 5250 session, you must have
| Access and Print permission for the Folder and Access
| permission for the Application Group that the document is
| archived to and you must have QRDARS400 and
| QONDADM user profiles specified as a group or
| supplemental group profile in your user profile.
|
“Choose a server”
“Two ways to add a user” on page 101
“Adding the user” on page 101

Choose a server
1. On the left side of the administrator window, click the name of the server to
which you want to add the user.
2. Expand the areas of the server. Double click the server name or click the +
(plus) to the left of the server name.
3. Select Users.

100 Common Server Administration Guide

 Two ways to add a user
This section explains how to add a user by using the New User command. You can
also add a user by copying an existing user definition.

New User command

From the File menu, select New User to open the Add a User dialog box.

Copy command

You can use the Copy command to add a user. In the User ID list, point to the user
that you want to copy and click the right mouse button. Select Copy from the
pop-up menu to open the Add a User dialog box. The fields in the dialog box
contain information copied from the user you selected. At a minimum, you need to
change the User ID (user IDs must be unique to the server).

Adding the user

About this task

In the Add a User dialog box, click OK. The administrative client adds the user to
the database and returns to the main window.

Examples
First, review the requirements of the users that need to access the telephone bill
reports.
v One set of user IDs for the customer service department. Identify one user as a
user administrator. The user administrator can add other users.
v One user ID for Customer XYZ.

On the example system, users obtain permissions from groups. This means that the
users are not added to application groups and folders. When groups are defined,
users are added to the groups.

Important: The steps that follow do not show how to add all of the sample users
to the system. Two users will be added; you can repeat the steps to add the others.
“Adding the customer service users”

Adding the customer service users

About this task

Use the New User command to add a user.

1. First, point to Users and click the right mouse button. From the pop-up menu,
select New User to open the Add a User Dialog box.
2. In the User ID field, enter the name of the user: CSR1. If your IBM Content
Manager OnDemand user IDs are linked to your IBM i user profiles, then this
user ID must also exist as an i user profile.
3. Accept the UID generated by Content Manager OnDemand.
4. Set the user’s initial password to the user ID. In the Password field, enter:
CSR1. If your Content Manager OnDemand user IDs are linked to your i user
profiles, then this password will be ignored.
5. In Verify Password field, enter: CSR1
6. In the Description field, enter: Customer Service Representative
Examples 101
 7. Under User Type, select User Administrator. The user will be able to
maintain user IDs on the system.
8. Click the User Information tab.
9. Complete the fields on the User Information page, such as the Name,
Department, and Phone Number.
10. Click the General tab.
The user will obtain application group and folder permissions from a group.
Add the user to the group when the group is added to the system. Therefore,
do not add the user to application groups, folders, or groups at this time.
11. At this point, the properties of the user meet the requirements. Click OK to
add the user.

Example

The following figure shows the Add a User dialog box with the basic information
completed.

102 Common Server Administration Guide

Figure 13. Add a User dialog box - basic information

“Adding another user”

Adding another user:

About this task

Use the Copy command to add another user.

1. Point to CSR1 and click the right mouse button. From the pop-up menu,
select Copy to open the Add a User dialog box.
2. In the User ID field, replace CSR1 with CSR2. If your IBM Content Manager
OnDemand user IDs are linked to your IBM i user profiles, then this user ID
must also exist as an i user profile.
3. Accept the UID generated by .

Examples 103
 4. Set the user’s initial password to the Content Manager OnDemand user ID. In
the Password field, enter: CSR2. If your Content Manager OnDemand user IDs
are linked to your i user profiles, then this password will be ignored.
5. In the Verify Password field, enter: CSR2
6. Under User Type, select User.
7. Click the User Information tab.
8. Replace the information in the fields on the User Information page.
9. Click the General tab.
10. At this point, the properties of the user meet the requirements. Click OK to
add the user.

Example

The following figure shows the Add a User dialog box with the basic information
completed.

104 Common Server Administration Guide

Figure 14. Add a User dialog box - basic information

Adding groups
About this task

Important: To add a group, the logon user ID must be a user with create groups
authority or a system administrator.

In general, here is how you work in the administrative client to add a group:
1. Choose a server and select Groups.
2. Pick one of two ways to add a group.

Examples 105
 3. Define the properties of the group by completing fields in the Add a Group
dialog box.
4. Optional: Assign a group owner.
5. Optional: Add users to the group.
6. Optional: Add the group to application groups and set application group
permissions.
7. Optional: Add the group to folders and set folder permissions.
8. When finished, add the group by clicking OK in the Add a Group dialog box.
“Choose a server”
“Two ways to add a group”
“Adding users”
“Adding the group” on page 107
“Examples” on page 107

Choose a server
1. On the left side of the window, click the name of the server to which you want
to add the group.
2. Expand the areas of the server. Double click the server name or click the +
(plus) to the left of the server name.
3. Select Groups.

Two ways to add a group

This section explains how to add a group by using the New Group command. You
can also add a group by copying an existing group definition.

New Group command

From the File menu, select New Group to open the Add a Group dialog box.

Copy command

You can use the Copy command to add a group. In the Name list, point to the
group that you want to copy and click the right mouse button. Select Copy from
the pop-up menu to open the Add a Group dialog box. The fields in the dialog
box contain information copied from the group you selected. At a minimum, you
need to change the group name (group names must be unique to the server).

Remember: These are not the same as group profiles in IBM i. However, the
names may match if you find that easier to maintain.

Adding users
About this task

You can add one or more users to the group. Complete the following steps to add
a user to a group.
1. From the List of Users list, select the user.
2. Click Add. The administrative client moves the user to the Users in the Group
list.
3. To remove a user from the group, select the user in the Users in the Group list
and click Remove.

106 Common Server Administration Guide

Adding the group
About this task

In the Add a Group dialog box, click OK. The administrative client adds the group
to the database and returns to the main window.

Examples
Review the requirements of the groups that need to access the sample telephone
bill reports.
v Customer service group. Users that belong to the group can open the telephone
bill report folder and query documents stored in the telephone bill report
application group. When the report is added to the system, the group will be
added to the application group and the folder. Identify a group owner. The
group owner can add new customer service users to the group and remove
users from the group.
v Customer XYZ group. Users that belong to the group can also open the
telephone bill report folder and query documents stored in the telephone bill
report application group. However, you can limit access to documents that
contain a specific customer name and account number. When the report is added
to the system, add the group to the application group and the folder and specify
the necessary restrictions.
v Users. Add the users that were defined in “Adding users” on page 97 to the
groups.
“Adding the customer service group”
“Adding the Customer XYZ group” on page 108

Adding the customer service group

About this task

Use the New Group command to add the group.

1. First, point to Groups and click the right mouse button. From the pop-up
menu, select New Group to open the Add a Group Dialog box.
2. In the Name field, enter the name of the group: CustomerService
3. Accept the GID generated by IBM Content Manager OnDemand.
4. From the Group Owner list, select the user that can add users to and remove
users from the group: CSR1

Important: The user that you select does not obtain permissions from the
group unless you add the user to the group (see step 6). However, a group
owner can add their user ID to the group at any time.
5. In the Description field, enter: Access to Telephone Bill Reports; call
Leonard Little, x90565, for more information
6. From the List of Users list, select and add users to the groups: CSR1, CSR2,
CSR3, CSR4, and CSR5
7. At this point, the properties of the group meet the requirements. Click OK to
add the group.

Examples 107
 Example

The following figure shows the Add a Group dialog box with the basic
information completed.

Figure 15. Add a Group dialog box

Adding the Customer XYZ group

About this task

Use the Copy command to add the group.

1. Point to Customer Service and click the right mouse button. From the pop-up
menu, select Copy to open the Add a Group dialog box.
2. In the Name field, replace CustomerService with CustomerXYZ
3. Accept the GID generated by IBM Content Manager OnDemand.

108 Common Server Administration Guide

 4. Use a system administrator to maintain the group. Therefore, do not assign a
group owner. In the Group Owner list, replace CSR1 with *NONE.
5. Replace the contents of the Description field with: Access to Telephone Bill
Reports by Customer XYZ
6. From the Users in the Group list, remove CSR1, CSR2, CSR3, CSR4, and CSR5.
7. From the List of Users list, add XYZ1.
8. Click OK to add the group.

Example

The following figure shows the Add a Group dialog box with the basic
information completed.

Figure 16. Add a Group dialog box

Examples 109
Adding server printers
Before you begin
1. To add a server printer, the logon user ID must be a system administrator.
2. Server print is supported for spooled file data types of SCS, SCS-extended,
AFPDS, and LINE.

About this task

In general, here is how you work in the administrative client to add a server
printer:
1. Choose a server and select Printers.
2. Pick one of two ways to add a server printer.
3. Define the properties of the server printer by completing fields in the Add a
Printer dialog box. Search for printer,adding in the online help for more details.
4. When finished, add the server printer by clicking OK in the Add a Printer
dialog box.
“Choose a server”
“Two ways to add a server printer”
“Adding the server printer” on page 111
“Examples” on page 111

Choose a server
1. On the left side of the main window, click the name of the server to which you
want to add the server printer.
2. Expand the areas of the server. Double click the server name or click the +
(plus) to the left of the server name.
3. Select Printers.

Two ways to add a server printer

This section explains how to add a server printer by using the New Printer
command. You can also add a server printer by copying an existing server printer
definition.

New Printer command

From the File menu, select New Printer to open the Add a Printer dialog box. The
figure in “Adding server printers” shows an example of the Add a Printer dialog
box.

Copy command

You can use the Copy command to add a server printer. In the Name list, point to
the server printer that you want to copy and click the right mouse button. Select
Copy from the pop-up menu to open the Add a Printer dialog box. The fields in
the dialog box contain information copied from the server printer you selected. At
a minimum, you need to change the name (printer names must be unique to the
server).

110 Common Server Administration Guide

 Adding the server printer
About this task

In the Add a Printer dialog box, click OK. The administrative client adds the
server printer to the database and returns to the main window.

Examples
Add a server printer that can be selected as the default server printer for the
application (added in “Adding a report” on page 112). The physical printer resides
in the customer service department. By default, when users of the telephone bill
report application select a document and choose the server printer command, IBM
Content Manager OnDemand sends the document to this print device.
“Adding the server printer”

Adding the server printer

About this task

Use the New Printer command to add the server printer.

1. First, point to Printers and click the right mouse button. From the pop-up
menu, select New Printer to open the Add a Printer dialog box.
2. In the Name field, type the name of the server printer: Customer Service
printer
3. In the Description field, type: Customer Service printer for the telephone
bill report application
4. In the Server Queue Name, type: ip60cs If no library name is entered (as in
the example), Content Manager OnDemand assumes *LIBL; otherwise, enter a
value such as QUSRSYS/PRT04 to identify both the library name and the output
queue name.
5. Accept the default Printer Type of Printer
6. At this point, the properties of the server printer meet the requirements. Click
OK to add the server printer.

Example

The following figure shows the completed Add a Printer dialog box.

Figure 17. Add a Printer dialog box

Examples 111
Adding storage sets
A storage set is automatically added each time you create a migration policy. The
name of the storage set that is created is an exact match of the name of the
migration policy. See “Creating migration policies” on page 95 for details on
migration policies.

Adding a report
About this task

When you define a report to the system, you typically add an application group,
an application, and a folder.
v The application group identifies database and storage management information.
v The application identifies viewing, indexing, loading, and printing information.
v The folder provides users the ability to search for, retrieve, view, and print
report data.

In general, here is how you work in the administrative client to define a report to
the system:
1. Choose a server. On the left side of the main window, click the name of the
server on which you want to define the report.
2. Select the area.
a. First expand the areas of the server.
b. Double click the server name or click the + (plus) to the left of the server
name.
c. Then select the area.
3. Pick one of two ways to add an application group, an application, and a folder.
For example, use one of the following methods to add an application group:
v Add a new application group. From the File menu, select New Application
Group to open the Add an Application Group dialog box.
v Copy an existing application group. In the Name list, point to the application
group that you want to copy and click the right mouse button. Select Copy
from the pop-up menu to open the Add an Application Group dialog box.
The fields in the dialog box contain information copied from the application
group you selected. At a minimum, you need to change the Name
(application group names must be unique to the server).

Important:
v To add an application group, the logon user ID must be a system
administrator, an application group/folder administrator, or a user with
create application groups authority.
v To add an application, the logon user ID must be a system administrator, an
application group/folder administrator, or a user with create application
groups authority.
v To add a folder, the logon user ID must be a system administrator, an
application group/folder administrator, or a user with create folders
authority.
4. Define the properties of the application group, application, and folder.
5. When finished, add the application group, application, and folder by clicking
OK in the add dialog box.

112 Common Server Administration Guide

 “An example”

An example
This section describes how to define a sample telephone bill report to the system.
“About the report”
“About the application group”
“Adding the application group” on page 114
“About the application” on page 124
“Adding the application” on page 125
“About the folder” on page 134
“Adding the folder” on page 135
“Summary” on page 141

About the report

A telephone bill report typically contains hundreds of pages of line data. The
report is logically segmented into statements. Users search for statements using a
date and any combination of account number and customer name.

Most queries about a statement occur in the first 60 days after it is mailed to the
customer. Little or no activity occurs a year after a statement is generated. For legal
reasons, a statement must be maintained on the system for five years. The system
should maintain index information in the most efficient way possible.

Two groups of users need to access the telephone bill reports. The customer service
department is responsible for handling queries from customers. They answer
questions about the statements, attach annotations to statements, and reprint and
fax a replica of original statements. As part of a customer service initiative,
Customer XYZ is permitted to access the system and retrieve and view their
statements.

About the application group

Before adding the application group, review the database and storage management
requirements.

Database requirements

Database requirements can be grouped in two categories: database tables and the
database fields.

Database tables
v A database table contains index data from one or more reports
v An annotation field is not required in the database
v The date field is the segment field for the application group

Database fields
v Three database fields: account number, customer name, and report date
v Account number is the index, data type string, 16 bytes. However, only 13 bytes
should be stored in the database, removing the - (dash) characters from the
account number string.
v Customer name is a filter, data type string, 30 bytes

Examples 113
 v Report date is a filter, data type date

Storage management requirements

The storage management requirements determine where, how, and how long IBM
Content Manager OnDemand maintains the report and index data.
v Maintain a report for five years
v Copy documents to disk and maintain them for 60 days
v Copy documents to archive storage when the report is loaded into the system
v Delete a table of index data at a time

Adding the application group

About this task

Use the New Application Group command to add the application group.
1. First, point to Application Groups and click the right mouse button. From the
pop-up menu, select New Application Group. The administrative client opens
the Add an Application Group dialog box.
The pages of the Add an Application Group dialog box organize information
about the application group into sections. The tabs show which page you are
on: General, Message Logging, Storage Management, Permissions, Field
Definition, and Field Information.
2. Start by completing the General page. In the Name field, type the name of the
application group.
3. In the Description field, type up to 120 characters of descriptive information
about the application group.
4. Based on the database requirements, accept the recommended defaults for the
rest of the fields on the General page. (You can click Advanced to see the
default options.)
The following figure shows the completed General page.

114 Common Server Administration Guide

Figure 18. General page

5. Select the Message Logging tab to specify the types of application group
messages that Content Manager OnDemand should save in the system log.
6. Select Retrieval, Database Queries, and Server Printing. Clear all of the other
check boxes
The following figure shows the completed Message Logging page.

Examples 115
Figure 19. Message Logging page

7. Select the Storage Management tab to provide information that Content

Manager OnDemand uses to manage data stored in the application group.
8. From the Storage Set Name list, select the name of the storage set that Content
Manager OnDemand will use to maintain the report on disk storage and in
archive storage. Select the storage set and migration policy that was defined in
“Adding storage sets” on page 112.
9. Under Cache Data, select Cache Data for __ Days and enter 60 in the space
provided. Content Manager OnDemand should maintain the report on disk
storage for 60 days. After that time, when a user views or prints the report,
Content Manager OnDemand retrieves the report from archive storage.
10. Under Life of Data and Indexes, select Expire in ____ Days and enter 1825 in
the space provided. This is the number of days (1825, or five years) that
Content Manager OnDemand should maintain index data, documents, and
resources related to the report. After that number of days, Content Manager
OnDemand can delete the report from the system. Note that the value for Life
of Data and Indexes can be changed even after you have loaded data into

116 Common Server Administration Guide

 Content Manager OnDemand for this application group. If you change this
value after you have already loaded data, the change will affect the existing
data that is already loaded (if the Expiration Type is set to Load in the
application group definition), as well as any new data you load after the
change is made.
11. Because Content Manager OnDemand should delete a table of index data at a
time, from the Expiration Type list, select Segment
The following figure shows the completed Storage Management page. (You
can click Advanced to see other, default options.)

Figure 20. Storage Management page

12. Select the Permissions tab to specify the types of report and application group
functions that users can perform. For example, you can let users query report
data, create logical views, print and fax pages of the report, and maintain the
application group. You can specify default permissions and permissions for
specific groups and users. Unless you specify otherwise, the person that
creates the application group is given all application group permissions; no
other users can access report data or maintain the application group. For the
Examples 117
 example system, other users obtain permissions from a group. The groups
were added in “Adding the customer service group” on page 107 and
“Adding the Customer XYZ group” on page 108.
13. First, add the customer service group. From the User/Groups list, select
+CustomerService.
14. Select the Access check box.
15. Click Add.
16. Next, add the Customer XYZ group. From the User/Groups list, select
+CustomerXYZ.
17. In the Annotation area, clear the View check box. Content Manager
OnDemand also clears the Add check box. Customer XYZ users can view,
print, fax, and copy documents but do not have permission to use the
annotation tools provided by Content Manager OnDemand.
18. Click Add.
The following figure shows the completed Permissions page.

118 Common Server Administration Guide

Figure 21. Permissions page

19. Select the Field Definition tab to define the database fields.
20. For the telephone bill report, define the three database fields: Account
number, Customer name, and Report Date
21. To define a database field, type the name of the field in the Database Field
Name field and click Add.
The following figure shows the completed Field Definition page.

Examples 119
Figure 22. Field Definition page

22. Select the Field Information tab to define the attributes of the database fields.
23. First, define field information for the Account number field.
a. From the Type list, select Index
b. Type the string length: 13
The following figure shows the Field Information page for the account
number field.

120 Common Server Administration Guide

Figure 23. Field Information page

Important:

IBM recommends that you always define an Application ID field for the
application group. An Application ID field is a database field that contains
values that identify an application within the application group.

You may not think that you need an application ID field at the time that you
create your application group, if you are adding an application group that will
hold only one application at the current time. However, if you decide later to
add other applications to the application group (or if you want to maintain
multiple versions of your application definitions) and you then need to define
an Application ID field for the application group, you will not be able to do
so because an Application ID field cannot be added after the application
group is created. (All fields must be added during the original application
group definition.) Also note that the application ID field can be hidden from
users that do not require it to search for documents. See the online help for
more information about the application ID field.

Examples 121
 The following figure shows an example of an Application ID field.

Figure 24. Field Information page for application ID field

24. Next, define field information for the Customer name field.
a. From the Name list, select custname
b. From the Type list, select Variable
c. In the Length field, type 30
The following figure shows the Field Information page for the customer name
field.

122 Common Server Administration Guide

Figure 25. Field Information page

25. Next, define field information for the Report date field.
a. From the Name list, select rdate
b. From the Data Type list, select Date
c. Select the Segment check box
The following figure shows the Field Information page for the report date
field.

Examples 123
Figure 26. Field Information page

26. At this point, the properties of the application group meet the requirements.
Click OK in the Add an Application Group window. The administrative client
adds the application group to the database and returns to the main window.

About the application

Before adding the application, review the viewing, indexing, and loading
requirements.

Viewing requirements
v Source data stored in IBM Content Manager OnDemand as AFP data
v Format data into pages and enhance the appearance with images and fonts
v Retrieve statements of one or more pages
v Define a default printer for the application. The default printer is where Content
Manager OnDemand sends documents when users select the server print
command.

124 Common Server Administration Guide

Indexing requirements
v Source data is EBCDIC, code page 500
v Segment report into groups of pages, one statement in each group
v Identify the beginning of a statement using:
Skip-to-channel one (X’F1’)
PAGE 1 (X’D7C1C7C5404040F1’)
v Generate three indexes for each statement: statement date, account number, and
customer name
v Collect resources

Loading requirements
v Compress and store data in the most efficient method possible
v Application group database field names and index names match
v Date format is Mth d, yyyy
v Remove embedded - (dash) character from account number before storing value
in the database

Adding the application

About this task

Use the New Application command to add the application.

1. First, point to Applications and click the right mouse button. From the
pop-up menu, select New Application to open the Add an Application dialog
box.
The pages of the Add an Application dialog box organize information about
the application into sections. The tabs show which page you are on: General,
View Information, Indexer Information, Load Information, Logical View
Fields, Logical Views, and Miscellaneous Options.
2. Start by completing the General page. In the Name field, type the name of the
application.
3. In the Description field, type information about the application.
4. Click Select to open the Application Groups dialog box.
5. From the Names list, select Telephone Bill Reports.
6. Click OK.
The following figure shows the completed General page.

Examples 125
Figure 27. General page

7. Select the View Information tab to specify information needed by Content

Manager OnDemand client programs to display the telephone bill report. This
information is also used by the indexing program.
8. From the Data Type list, select Line. Note that although this example shows
Line data type, most IBM i spooled files will be either SCS or AFP.
9. Enter the correct Code Page. For Line, SCS, and SCS-Extended data types, this
field determines the code page used by the Content Manager OnDemand
client to display the data. For Line, the default value is 500. For SCS and
SCS-Extended, the default value is the code page of the server.
10. In the RECFM area, select Fixed. The report contains fixed length records, 133
bytes in length.
The following figure shows the View Information page.

126 Common Server Administration Guide

Figure 28. View Information page

11. Select the Indexer Information tab.

12. From the indexer list, select OS/400 Indexer.
13. Process a sample report using the graphical indexer. In the Parameters Source
area, select Sample Data.
14. Click Modify to open the Open dialog box to select a file that contains a
sample of the actual report data.
15. Select OS/400 Spooled File to work with spooled files on the server. Identify
how to find your spooled file by entering a user profile or output queue
name, and then click Retrieve List to generate a list of spooled files to choose
from. Once you select a specific spooled file, Content Manager OnDemand
copies that sample data to your workstation for you to use for indexing.
The following figure shows the Report window.

Examples 127
Figure 29. Report window

16. Define trigger number one.

a. First, select any blank column in the first record.
b. Click the Add a Trigger icon to open the Add a Trigger dialog box. (See
online help for a description of trigger fields.)
17. In the Columns to Search area, select Carriage Control.
The following figure shows the completed Add a Trigger dialog box for
Trigger1.

128 Common Server Administration Guide

Figure 30. Add a Trigger dialog box

18. Click OK to add the trigger.

19. Define trigger number two.
a. First, select the string PAGE 1.
b. Click the right mouse button.
c. From the pop-up menu, select Trigger to open the Add a Trigger dialog
box.
20. Click OK to add the trigger.
21. Define field number one.
a. First, select the string Customer XYZ and enough blank characters to the
right of the string to reserve enough space to hold the largest index value
(30 characters) the field can contain. (The selected string length guide,
which appears above the field, displays the number of selected characters.)
b. Then click the right mouse button.
c. From the pop-up menu, select Field to open the Add a Field dialog box.
22. From the Trigger list, select Trigger2.
The following figure shows the completed Add a Field dialog box for Field1.

Examples 129
Figure 31. Add a Field dialog box

23. Click OK to add the field.

24. Define field number two.
a. First, select the string May 11, 1996.
b. Then click the right mouse button.
c. From the pop-up menu, select Field to open the Add a Field dialog box.
25. From the Trigger list, select Trigger2.
26. Click OK to add the field.
27. Define field number three.
a. First, select the string 303-555-1212-95B.
b. Then click the right mouse button.
c. From the pop-up menu, select Field to open the Add a Field dialog box.
28. From the Trigger list, select Trigger2.
29. Click OK to add the field.
30. Define the indexes.
a. First, clear any selected areas of the report.
b. To define the first index, click the Add an Index icon to open the Add an
Index dialog box.
31. From the Attribute list, select custname.
32. In the Break area, select No.
33. In the Fields list, double-click Field1.
The following figure shows the Add an Index dialog box for Index1.

130 Common Server Administration Guide

Figure 32. Add an Index dialog box

34. Now define the second index. From the Attribute list, select rdate
35. In the Break area, select No.
36. In the Fields list, double-click Field2.
37. Now define the third index. From the Attribute list, select acct.
38. In the Fields list, double-click Field3. Leave the Break setting set to Yes for
this index. This will cause Content Manager OnDemand to watch for a change
in the value of the acct index by using the change to indicate an end to one
document and the beginning of the next when breaking up the input file into
separate documents. For more information about this Break setting, see the
IBM Content Manager OnDemand for i Common Server Indexing Reference.
39. Click Done to close the Add an Index dialog box.
40. Close the Report window, saving the changes.
41. Select the Load Information tab to specify information that Content Manager
OnDemand uses to process the index data before storing it in the database.
42. In the Application Group DB Name list, select rdate.
43. From the Format list, select %Y.
If you need to specify a default value for rdate, you can specify it here in the
Default Value field, or you can specify it using the DEFAULT keyword in the
indexer parameters for this application. See the IBM Content Manager
OnDemand for i Common Server Indexing Reference for important information
about setting default values.
The following figure shows the Load Information for the report date field.

Examples 131
Figure 33. Load Information page

44. In the Application Group DB Name list, select acct. To conserve space in the
database, Content Manager OnDemand should remove the - (dash) character
from index values before storing the values in the database. Also, it is best to
define your numeric index fields (including date fields) so that leading,
trailing, and embedded blanks, dashes, currency symbols, thousands
separators, etc. are removed by Content Manager OnDemand prior to being
stored. Edits on these fields are sometimes strict and can cause a load to fail if
non-numeric characters are found within the fields being defined.
45. In the Embedded field, type the - (dash) character.
The following figure shows the Load Information for the account number
field.

132 Common Server Administration Guide

Figure 34. Load Information page

46. If you require a postprocessor program to further process the index data that
is extracted from the print page, enter the name of the symbolic link that
points to your custom-written postprocessor in the Postprocessor Parameters
field. For more information about writing a postprocessor program, see the
IBM Content Manager OnDemand for i Common Server Indexing Reference.
47. Select the Miscellaneous Options tab to provide information that Content
Manager OnDemand uses to print the report.
48. From the Default Server Printer list, select Customer Service printer. This is
the printer that was added in “Adding server printers” on page 110.
The following figure shows the completed Miscellaneous Options page.

Examples 133
Figure 35. Miscellaneous Options page

49. At this point, the properties of the application meet the requirements. Click
OK in the Add an Application window. The Content Manager OnDemand
Administrator adds the application to the database and returns to the main
window. If, however, you need to use an IBM i printer file to further define
some of the server print parameters, see “Server printing and faxing” on page
209 for details.

About the folder

Before adding the folder, review the data access requirements, the types of
permissions to specify, and the search and display fields to define.

Data access requirements

The folder allows users to access the telephone bill report application group and
the telephone bill report application.

Permissions

Who needs access to the folder and what types of permissions do the users need?
v Users in the customer service department can open the folder to search for and
retrieve statements.
v Users at Customer XYZ can open the folder to search for and retrieve statements
that contain their account number and customer name.
v Define a set of folder fields for the Customer XYZ users. The folder fields will
limit access to specific statements.

Search and display fields

Define two sets of folder fields:

134 Common Server Administration Guide

 v One set at the folder level. These folder fields allow users in the customer
service department to access any statement in the database.
v One set for the CustomerXYZ group. These folder fields allow users at Customer
XYZ to access specific statements.

Adding the folder

About this task

Use the New Folder command to add the folder.

1. First, point to Folders and click the right mouse button. From the pop-up
menu, select New Folder to open the Add a Folder dialog box.
The pages of the Add a Folder dialog box organize information about the
folder into sections. The tabs show which page you are on: General,
Permissions, Field Definition, Field Information, and Field Mapping.
2. Start by completing the General page. In the Name field, type the name of the
folder.
3. In the Description field, type up to 120 characters of descriptive information
about the folder.
4. Select the Display Document Location check box. This provides users with a
visual clue about the type of media on which a statement is stored.
5. In the Application Groups list, select Telephone Bill Reports.
The following figure shows the completed General page.

Figure 36. General page

6. Select the Permissions tab to specify the types of folder functions that users
can perform. For example, you can let users open the folder, create private
named queries, and maintain folder fields. You can specify default
permissions and permissions for specific groups and users. Unless you specify
otherwise, the person that creates the folder is given all folder permissions; no
other users can open or maintain the folder. On the example system, other
users obtain permissions from a group. Add two groups to the folder. The
groups were added in “Adding the customer service group” on page 107 and
“Adding the Customer XYZ group” on page 108.
7. From the Users and Group list, select +CustomerService.
8. Select the Access check box

Examples 135
 9. Click Add, to add the Customer Service group to the folder.
10. From the Users and Group list, select +CustomerXYZ.
11. Click Add, to add the CustomerXYZ group to the folder.
The following figure shows the Permissions page.

Figure 37. Permissions page

12. Select the Field Definition tab to define the folder fields. Define four folder
fields to allow users to search for statements:
v Account Number, a string field
v Customer Name, a string field

136 Common Server Administration Guide

 v Report Date, a date field
v Other Information, a text search field
13. Complete the following steps to define a folder field:
a. In the Name field, type the name of the folder field.
b. In the Description field, type up to 120 characters of descriptive
information about the folder field.
c. From the Field Type list, select the data type of the field.
d. For the other Information field, select a data type of text search.
e. Select the Mapping Type. All of the fields in this example use the Single
mapping type.
f. Click Add.
The following figure shows the completed Field Definition page.

Figure 38. Field Definition page

14. Select the Field Information tab to specify the properties of the folder fields.
Using the *PUBLIC identifier, you can specify field information that is used by
all users that can open the folder. You can also specify field information for
specific users and groups. The public field information will be used unless it
is overridden by field information for a specific user or group. For the
example folder, do the following:
a. Specify public field information. For the Account Number, Customer
Name, and Other Information fields, accept the default values. For the
Report Date field, specify field information.
b. Specify field information for the CustomerXYZ group. For the Other
Information and Report Date fields, accept the default values. For the
Account Number and Customer Name fields, specify field information.
15. First, specify the public field information for the Report Date field. See online
help for date format or time format values for the Display Fmt and Defaults
Fmt fields.
a. From the Name list, select Report Date
b. From the ID list, select *PUBLIC
c. Select the Default check box
d. From the Display Fmt list, select %Y
e. From the Defaults Fmt list, select %Y
Examples 137
 f. In the Interval area, select Last, type a 3 (three) in the entry field and select
Months
The following figure shows the Field Information page for the Report Date
field.

Figure 39. Field Information page

16. Next, specify the field information for the CustomerXYZ group. First, make a
copy of the folder fields. Click the Permissions tab.
17. From the Selected List, select +CustomerXYZ.
18. In the User/Group Fields area, click Yes.
The following figure shows the completed Permissions page.

138 Common Server Administration Guide

Figure 40. Permissions page

19. Click the Field Information tab.

20. Specify the Customer XYZ field information for the Account Number field:
a. From the Name list, select Account Number
b. From the ID list, select +CustomerXYZ
c. From the Default list, select Equal
d. Clear the Like check box
e. Select the Default check box
f. Select the Fixed check box
g. In the first Defaults entry field, type 1234567890123

Examples 139
 h. Clear the Append check box
The following shows the Field Information page for the Account Number
field.

Figure 41. Field Information page

21. Specify the Customer XYZ field information for the Customer Name field:
a. From the Name list, select Customer Name
b. From the Default list, select Equal
c. Clear the Like check box
d. Select the Default check box
e. Select the Fixed check box
f. In the first Defaults entry field, type Customer XYZ
g. Clear the Append check box
The following shows the Field Information page for the Customer Name field.

Figure 42. Field Information page

140 Common Server Administration Guide

 22. Select the Field Mapping tab to map the folder fields to application group
database fields. IBM Content Manager OnDemand uses the values that users
type in folder fields to construct SQL queries. An SQL query uses the database
field name.
23. Map the following folder fields to their corresponding application group
fields:
a. Account Number to acct
b. Customer Name to custname
c. Report Date to rdate
The following figure shows the completed Field Mapping page.

Figure 43. Field Mapping page

24. At this point, the properties of the folder meet the requirements. Click OK in
the Add a Folder window. The administrative client adds the folder to the
database and returns to the main window.

Summary
The example shows the basic requirements for adding a report to the system.
Hopefully the scenario that was described and developed is similar to how you
plan to use IBM Content Manager OnDemand at your company. The example
should have enough variations to show the flexibility of Content Manager
OnDemand to meet a range of business and operational requirements. Of course,
there are several tasks that were not shown. For example, logical views of the
report were not created. The system log user exit was not explored. And all of the
ways to complete a given task or implement a specific requirement were not
shown. As with most administrative software, there is more than one way to
accomplish a task. Hopefully, the example showed you the most straightforward
way to get things done with the administrative client.

You can use reference information provided with the product and the online help
to find out more about how to use Content Manager OnDemand. If you have
questions and cannot find the answers, contact the IBM support center. IBM also
offers classes that further explore how to administer the system. Finally, you can
let IBM know how well the information in this book was presented and if you
found the book helpful. The section titled How to Send Your Comments explains
how to let IBM know.

Examples 141
Adding a new field to an existing application group/application/folder
About this task

To consume the least amount of disk space for index data, IBM Content Manager
OnDemand creates a unique index database file for each Content Manager
OnDemand application group, based on the index fields that are defined in the
application group. The index database file is created the first time that data is
stored for that application group. Because of this, it is not possible to simply add
another index field later, because the database file was already created. However, if
you need to add an additional index field after some of your data is already
stored, here is one technique you can use to accomplish that same result:
1. Rename the application group, application, and folder. You might just add an X
(for example) to the end of the name.
2. Copy the application group to a new application group, giving it the original
name (so the output queue monitor can still look for this name). In the copy
process, you can add a new database field.
3. Copy the application to a new application, giving it the original name, adding
the field and index by using the graphical indexer.
4. Copy the folder to a new folder with the original name. In the copy process,
add a new folder field and add the new application group to the folder. Map
the folder fields to the new application group fields. Now, you have a single
folder that points to two application groups, one with the old set of index fields
and one with the new field added.

Results

The new index field will only be searchable for the new application group. But the
folder will also show all the old data, just without the new index field.

Local server setup for offline administration

IBM Content Manager OnDemand supports two types of servers. The first type of
server uses TCP/IP to communicate between the client programs and the server
programs. The server programs can run on operating systems, such as AIX®,
HP-UX, IBM i, OS/400, Sun Solaris, Windows , z/OS® and OS/390®. Depending
on the server operating system, the databases supported by the server can be
DB2®, Oracle (AIX, HP-UX, Sun Solaris, Windows platforms only), and Microsoft®
SQL server (Windows platform only). Definitions of users, groups, applications, for
example, are stored in the database as well as the index values for the report data
that is loaded into the system.

The second type of server is a local server. The local server is self-contained (no
TCP/IP communication) and is defined using files contained in a directory located
on a PC rather than in a server database. The files represent the system tables that
define the various objects such as users, groups, and applications.

One of the uses of a local server is to enable Content Manager OnDemand

administrators to work offline on administrative tasks. Another is to provide the
ability to export definitions from a non-local server to a local server so the
definitions can then be imported to a different non-local server. This is especially
beneficial when a TCP/IP connection does not exist between two non-local servers.
In either case, one of the limitations of exporting definitions from a non-local

142 Common Server Administration Guide

server to a local server is that the local server does not support any of the
operating system-specific or database-specific parameters that are defined when
using the administrative client.

When a Content Manager OnDemand administrator logs on to a server, the

Content Manager OnDemand Administrator client determines whether the user
has logged on to a local server or a non-local server. If the server is a non-local
server, the operating system and the database types are determined. Based on the
type of server, the operating system, and the database, default settings are
established, entry fields are hidden or displayed, and values are added to or
removed from selection lists. For definitions that have been exported from a
non-local server to a local server, updating or viewing the definitions may not have
the desired results because of the operating system differences between local and
non-local servers. For example, when an application group and application are
exported from an i server to a local server, the OS/400 Indexer that is specified in
the application is not supported on a local server. When the application is viewed
on the local server, the indexer field on the Indexer Information page will not have
a value and the OS/400 Indexer will not be listed as a choice of indexers.

To correctly display the operating system- and database-specific parameters on a

local server from parameters that have been exported from a non-local server,
support has been added to the Content Manager OnDemand Administrator client
at version 7.1.0.8 and higher. Pulldowns for Operating System and Database
appear on the Add a Server dialog box when you create a server with the Protocol
parameter set to Local. Then, in the case of the application group and application
that were exported from the i server, the OS/400 Indexer will now be selected
when the application is updated or viewed from the local server.

Restriction: Although a local server can resemble a non-local server, the following
are system limitations for a local server:
v The user ID of a user that is defined on a local server cannot be updated.
v User and group permissions for users are not supported from the User
Permissions page on Users dialog box.
v The Find function is not supported.
v Server Printers are not supported.
v Data Distribution Files and Groups are not supported.

For a local server, the default administrative user ID is admin. There is no initial
password set for the admin user ID on a local server.

Examples 143
144 Common Server Administration Guide
Loading spooled file data
This section provides an overview of the data loading process - the process of
adding the index data to the database and loading the report data and resources
into IBM Content Manager OnDemand. When a load process completes, you can
view the messages that were saved in the system log. To complete the data loading
process, you should backup the Content Manager OnDemand data on a regular
basis.
“Overview”
“Preparing to load reports” on page 146
“Loading reports” on page 147
“Processing the input data” on page 149
“Loading index data” on page 150
“Loading storage objects” on page 150
“Verifying processing” on page 151
“Backing up databases” on page 152

Overview
You can archive the print output of your existing application programs in IBM
Content Manager OnDemand without changing the print data stream or writing
programs to process the data. In Content Manager OnDemand, the print output of
an application program is called a report. Content Manager OnDemand provides
programs that can index the reports, add the index data to the database, divide the
input data into indexed groups of pages (documents), compress the documents,
and copy the compressed documents into Content Manager OnDemand. After you
archive a report in Content Manager OnDemand, your users can query, retrieve,
and view or print pages of the report using the Content Manager OnDemand
client program.

The Content Manager OnDemand data indexing and loading programs process
input files that reside on the Content Manager OnDemand server. If you generate
your reports on another system, then you would typically transfer the reports to
the Content Manager OnDemand server and use the data indexing and loading
programs to process them. When you index a report that contains AFP data, you
must make sure that the data indexing program can access the resources required
by the report. Resources include page segments and fonts. If the resources are not
already on the server, you must transfer them before loading the report.

You can create up to 32 index fields for each type of report that you define to
Content Manager OnDemand, providing many ways for users to query
information contained in a report. The number of index fields that you define
depends on the organization of the data in the report. For example, when you
index a report that contains logical items, such as policies and statements, you
might define index fields for the date, customer name, customer number, balance
due, transaction number, and amount. When you index a report that contains
transaction data, such as a general ledger, you might define index fields for the
date and transaction number. After you determine what index fields you need and

© Copyright IBM Corp. 1991, 2010 145

 define them to the system, Content Manager OnDemand extracts the index values
from a report during the load process and stores them in records that are added to
the database.

Content Manager OnDemand compresses report data into storage objects, using
information that you specify in the application. Depending on how you configure
storage management for your application groups, Content Manager OnDemand
can automatically copy the report to disk and archive storage.

The load process saves messages in the system log each time that you load an
input file into the system. You can open the System Log folder and view the
messages for information such as the name of the input file, the indexing
information, and the number of rows that were added to the database.

Preparing to load reports

There are a number of things to consider when preparing to load reports.
“Storage space”
“Defining the application group”
“Defining the application” on page 147

Storage space
When you initially configure an IBM Content Manager OnDemand system, you
calculate the total amount of disk, optical, and tape storage required to hold the
Content Manager OnDemand database, database log files and reports. You also
need to plan for the temporary space needed by Content Manager OnDemand
programs. The amount of storage space that you need on your system is usually a
factor of how much data that you plan to store in Content Manager OnDemand,
how long you need Content Manager OnDemand to maintain the data, the
compression ratio that you can expect to achieve on the report data, and the
number of copies of reports that you need the system to maintain. If you plan to
index your reports on the Content Manager OnDemand server, then you must
allocate temporary space for the data indexing program. Temporary space is also
required for the data loading program.

The IBM Content Manager OnDemand for i Common Server: Planning and Installation
Guide provides information that can help you calculate your storage requirements.

Defining the application group

When you archive reports in IBM Content Manager OnDemand, the ADDRPTOND
command adds index data to the database and compresses report data into storage
objects and copies the storage objects into Content Manager OnDemand. The index
data and the storage objects are associated with an application group. As part of
defining a report to Content Manager OnDemand, you must specify the
application group that Content Manager OnDemand uses to maintain the data. The
application group specifies the database fields that hold the index data and the
storage management information that determines where Content Manager
OnDemand maintains the report data and how long it maintains the index data
and the report data. You can use the Content Manager OnDemand administrative
client to define an application group. See the online help for the administrative
client for more information about defining database fields and specifying storage
management information for application groups.

146 Common Server Administration Guide

 If you plan to maintain a copy of your reports in archive storage, then the
application group must specify a migration policy and storage set that identify
your storage management requirements.

Defining the application

Most customers define an application for each different report (or source of data)
that they plan to archive in IBM Content Manager OnDemand. When you create
an application, you specify information about the report, such as:
v The application group in which you want to store the report
v Physical information about the report, including the type of data found in the
report
v The indexing parameters
v The processing that Content Manager OnDemand should do to the index data
before adding it to the database
You can use the Content Manager OnDemand administrative client to define an
application. See the online help for the administrative client for more information
about defining applications.

Loading reports
You can load reports into IBM Content Manager OnDemand in a number of
different ways, depending on your application requirements.
“Running the ADDRPTOND command”
“Using an output queue monitor”
“Indexing reports” on page 149

Running the ADDRPTOND command

The ADDRPTOND command is the primary IBM Content Manager OnDemand
data indexing and loading command. The ADDRPTOND command determines if
the input data needs to be indexed, and if it does, calls the indexing program. The
ADDRPTOND command then processes the index data, adding it to the database,
optionally compresses the report data into storage objects, and copies the storage
objects to storage volumes.

You run the ADDRPTOND command each time that you want to load a report or
set of reports into the system. You can either run the command from the command
line or use the Content Manager OnDemand output queue monitor to periodically
check for input data to process. See “Using an output queue monitor” for more
detail.

Important: The Content Manager OnDemand server job must be running,

otherwise the ADDRPTOND command will fail.

Using an output queue monitor

You can use the Start Monitor for OnDemand (STRMONOND) command to start a
monitor program for any output queue to receive spooled files for processing. The
monitor continuously checks an output queue for spooled files, and allows IBM
Content Manager OnDemand to capture the spooled files as they arrive.

Important: IBM recommends using the monitors in a batch environment only.

Loading spooled file data 147

 You generally define and then manually store reports with the ADDRPTOND
command during testing. Then, when the report is ready for production, you can
automate storage with the Content Manager OnDemand monitor—if you use the
*SPLFNAME, *FORMTYPE, *USERDATA, *JOBNAME, or *USRDFNxxxx spooled
file attribute of the report to match the application group and application names
you defined to Content Manager OnDemand.

The spooled files must be in ready status (RDY) on the output queue that you are
monitoring. The first time a Monitor is started for an output queue, Content
Manager OnDemand will create a data queue and attach it to the output queue
being monitored. If there are spooled files already in that queue, the monitor will
not detect them. If this happens, place these spooled files on hold, then release
them. The Monitor should then detect and process them. This should only be
necessary the first time a Monitor job is started for a particular output queue.

To begin capturing reports automatically when a spooled file arrives in a particular

output queue, you can issue the STRMONOND command. The monitor runs
continuously until the End time or Number of hours occurs. You can also use the
End Monitor for OnDemand (ENDMONOND) command to stop processing.

The default job name for the monitor job is MONOUTQ. After the job has ended,
the job log can be found with the User data (USRDTA) spooled file attribute set to
MONOUTQ. For every spooled file that the monitor has processed, there will
either be a successful load (message number 87) or a failure (message number 88)
indicated in the System Log.

The monitor processes any spooled files that arrive in the named output queue in
RDY (Ready) status. Spooled files with any other status are not affected by the
monitor, and remain in the output queue until they are deleted or moved.

When a Common Server monitor job is active, the job status displayed by the
Work with Active Jobs (WRKACTJOB) command changes a number of times
during processing. The monitor job has a status of RUN when it is preparing to
process a document (such as determining parameter values or running an exit
program). It then spawns several jobs and goes to a status of TIMW while those
jobs do the actual archiving. When the processing is complete, the status changes
back to RUN while the monitor checks what needs to be done next. If there are no
additional documents that are ready to be archived the monitor job goes into a
DEQW status until the next document is ready to be archived or a request to end
the monitor job is received.

You may wish to add the STRMONOND command to your system startup
program so the monitor(s) start each time you IPL the system.

When starting a Content Manager OnDemand output queue monitor (using the
STRMONOND command) from a job scheduler, you may be unsure of what job
description to use. In most cases, STRMONOND will work best using the
QOND400 job description. You may have special system needs that require the use
of your own job description, but these two IBM-supplied job descriptions will
work successfully for many customers.

See the online help for more information about these commands and their
parameters.

Important: The Content Manager OnDemand server job must be running,

otherwise the spooled files will fail to load.

148 Common Server Administration Guide

 Indexing reports
You must generate index data for a report before you load the report into IBM
Content Manager OnDemand. If the report contains AFP data, then you need to
store the AFP resources in Content Manager OnDemand. The resources are
required to display and reprint pages of a report that contains AFP data. There are
several programs provided with Content Manager OnDemand to help you
generate index data for your reports:
v Content Manager OnDemand OS/400 Indexer - You can use the OS/400 Indexer
to specify indexing parameters for SCS, SCS-Extended, Advanced Function
Presentation (AFP), and Line spooled files.
v Content Manager OnDemand PDF Indexer - You can use the PDF Indexer to
specify indexing parameters for Adobe® PDF input files.
v Content Manager OnDemand Generic Indexer - You can use the Generic Indexer
to specify index data for a wide variety other types of input files.

For details about indexing data, including how to use other indexers, see the IBM
Content Manager OnDemand for i Common Server: Indexing Reference.

Processing the input data

After a report has been indexed, the ADDRPTOND command can process the
index file to prepare the index data for loading into the database and prepare the
report data and resource group files for the storage managers to load on storage
volumes.
“Processing index data”
“Processing reports and resources” on page 150

Processing index data

The index data is processed by the ADDRPTOND command before the index data
is added to the database. The ADDRPTOND command extracts information from
the application group and the application and performs the following processing:
v Determines the database field information from the application group.
v Determines the preprocessing information from the application, if needed.
v After preprocessing the index file, the ADDRPTOND command creates the
database rows:
– One row for every group of indexed pages in a report that contains a sorted
transaction value
– One row for every indexed item in a report that contains logical items, such
as policies and statements
v Determines the postprocessing information from the Postprocessor Parameters
specified on the Load Information tab of the application. For example, the
ADDRPTOND command may need to drop duplicate index records. You specify
exactly what processing you want the command to do when you define the
application.
v Passes the index rows to the database manager. The rows consist of fields that
contain the index values that the indexing program extracted from the report
and other fields generated by IBM Content Manager OnDemand. An index row
contains:
– One column for each field defined in the application group
– One or more columns of Content Manager OnDemand control information

Loading spooled file data 149

 Processing reports and resources
The ADDRPTOND command divides the input data into indexed groups of pages
(documents) and compresses the documents into storage objects. Dividing a report
into groups of pages improves the efficiency of queries and can improve the time
required to retrieve and display the report. Compression improves the efficiency of
the storage manager. In this step, the ADDRPTOND command:
v Determines the compression information from the application.
v Determines the storage management information from the application group.
The storage management information determines the storage locations, such as
disk storage and archive storage.
v Locates the AFP resources called for in the input data. If the resources are not
available, the load will fail and the System Log will be updated with message
number 88, indicating the failure. An ADDRPT job log will contain error
messages.
v Compresses the documents into storage objects. IBM Content Manager
OnDemand compresses report data into approximately 100 KB blocks (a default
value) and places the blocks into a storage object. Content Manager OnDemand
uses a 10 MB storage object (a default value) to improve storage efficiency and
performance. Compressed data does not span storage objects. Content Manager
OnDemand assigns unique file names to the storage objects and sequentially
numbers them within an application group.

Loading index data

The ADDRPTOND command works with the database manager to add the index
data to the database. Depending on the database organization that you specified
when you defined the application group, IBM Content Manager OnDemand either
creates a new table each time that you load a report or adds the index data to an
existing database table.

Content Manager OnDemand uses a segment table as a high level index to the index
data for an application group. Each row in the segment table identifies a specific
table of application group index data. The fields in the segment table identify the
application group and the dates found in a table. The dates represent the earliest
and latest dates that can be found in that segment of application group index data.
Content Manager OnDemand can use the segment table to limit a query to a
specific table of application group index data.

The database manager updates the segment table if the beginning date in the
report is earlier than a date already stored in the table.

Content Manager OnDemand limits the size of a table to improve performance and
storage management. The number of rows in a table can be specified when you
define the application group. The default size of a table is ten million rows. The
database manager automatically closes a table and opens a new table when this
threshold is reached. When closing a table, the database manager updates the
segment table with the latest ending date found in the table.

Loading storage objects

The ADDRPTOND command calls the storage manager to copy storage objects to
disk and archive storage. The storage manager extracts information from the
application group to determine where and when to copy the storage objects.

150 Common Server Administration Guide

 IBM Content Manager OnDemand uses an object called a storage set to determine
the locations that can hold report data. A storage set and its associated migration
policy (of the exact same name) point to one or more storage locations. A storage
set can write data to one and only one storage location at a time (the active storage
level).
“Disk storage”
“Archive storage”
“Resources”

Disk storage
The primary purpose of disk storage is for short-term, high-speed retrieval of
report data.

If you configure your application groups to copy data to disk storage, then the
disk storage manager copies the storage object to disk. The Cache Data for xx
Days setting on the Storage Management page determines whether IBM Content
Manager OnDemand copies documents to disk storage.

Archive storage
A storage set can identify an archive storage media such as optical or tape. IBM
Content Manager OnDemand uses its archive storage manager to maintain storage
objects in archive storage for long-term storage and for backup copies of reports.

The storage manager can copy the storage object to archive storage when the
report is initially loaded into the system or at a later time, depending on how you
configure your application groups. Most customers configure the system to copy
report data to disk and archive storage at the same time.

Resources
IBM Content Manager OnDemand always stores resources (such as AFP overlays
or page segments) on disk, to provide fast retrieval when a user selects an item for
viewing. Content Manager OnDemand saves only one copy of a resource on the
system, even if several reports use the same resource. When processing a resource
group file, the ADDRPTOND command checks the resource identifier to determine
if the resource is already present on the system.

Verifying processing
When you add a report into the system, the ADDRPTOND command saves a copy
of the messages generated during the load process in the system log. After a load
| process completes, you can open the System Log folder and view the messages.
| Message number 87 indicates a successful load; message number 88 indicates a
| failure. A failed load will produce a job log that contains additional error messages.
| The user data of the job log will be ADDRPT. The System Log message reference
the load program named ARSLOAD and include the date and time that the load
process started and completed, the name of the input file, and the number of rows
that were added to the database. For example:
arsload: Processing file
>/QIBM/USERDATA/ONDEMAND/QUSROND/TMP/SP_INVNEW1_DSP02_...
arsload: 01/26/09 12:29:40 -- Indexing started,
--UNKNOWN-- bytes to process
arsload: 01/26/09 12:29:41 Indexing completed
arsload: 01/26/09 12:29:41 -- Load started,
23306 bytes to process

Loading spooled file data 151

 Resource ./SP_INVNEW1_DSP02_DBRYANT_431445_000001_RDR400X_1090126_122921.res
will be added as resource >3-16-0<. Compression Type(OD77)
Original Size(10498) Compressed Size(5201)
OnDemand Load ID = >5429-16-0-4FAA-14271-14271<
Loaded 4 rows into the database
arsload: 01/26/09 12:30:37 Loading completed
arsload: Processing successful for file >/QIBM/USERDATA/ONDEMAND/QUSRO...

You can verify the number of rows that IBM Content Manager OnDemand added
to the database:
v For a report that contains transaction data that you have divided into indexed
groups of pages, the number of pages in the report divided by the number of
pages in an indexed group of pages should equal the number of rows added to
the database. For example, if a report contains 150,010 pages and there are 100
pages in an indexed group of pages, then Content Manager OnDemand should
have added 1,501 rows to the database.
v For a report that contains logical items, such as statements and policies, the
number of rows added to the database should equal the number of indexed
items in the report. For example, if a report contains 1,000 statements, Content
Manager OnDemand should have added 1,000 rows to the database.

The OnDemand Load ID represents the data that the ADDRPTOND command
stored in the system during a load process. The Load ID can be used to identify a
specific load process. For example, you can run the RMVRPTOND command and
specify the Load ID to delete the index data and documents that were created
when the ADDRPTOND command processed an input file. The following table
shows an example of the fields in a Load ID.
| Table 5. Example of an OnDemand Load ID
| Example Load ID field value Meaning
| 6850 Application group identifier
| 25 Primary node identifier
| 0 Secondary node identifier (always set to 0)
| 15FAA The load identifier within the application group
| 14271 The earliest date in the report (relative to 1/1/1970; can be
| converted to a readable date format using ARSDATE API)
| 14271 The latest date in the report (relative to 1/1/1970; can be
| converted to a readable date format using ARSDATE API)
|

Backing up databases
After you load reports into IBM Content Manager OnDemand, we recommend that
you create a backup copy of the Content Manager OnDemand data.
v When you backup the Content Manager OnDemand database, you protect
control information and index data that Content Manager OnDemand and the
database manager need to support the system.
v When you backup the Content Manager OnDemand data in IFS, you protect
your data that resides on disk that may not have been copied to archive media
yet.

IBM recommends that you backup the data at least once a week, and more often if
you load reports every day.

152 Common Server Administration Guide

See “Backup and recovery” on page 41 for details about Content Manager
OnDemand backup and recovery.

Loading spooled file data 153

154 Common Server Administration Guide
Loading image files
“Overview”
“Defining the application group”
“Defining the application” on page 157
“Defining the folder” on page 158
“Accessing the image files” on page 159
“Creating index data” on page 159
“Configuring the ARSLOAD program” on page 160
“Processing the input data” on page 161

Overview
IBM Content Manager OnDemand provides support for storing and retrieving
letters and other types of correspondence. The most straight forward way to store
this type of information is to transform a printed copy of a letter into an image file
using a scanner and image capture software. In addition to scanning the letter and
saving it as an image file, you must create index data for the letter. You can then
use the ARSLOAD program to load the index data into the database and store the
letter file on the system. Your users can then query, retrieve, and view, print or
send copies of the letter using one of the Content Manager OnDemand client
programs.

Content Manager OnDemand provides the Generic Indexer so that you can index
input files that contain data other than AFP data, line data, and PDF. You specify
the index data for the input files that you want to index with the Generic Indexer
in a parameter file. The parameter file contains the index field names and values
and identifies the input files that you want to process. You can create up to 32
index fields for each input file that you want to load into the system, providing
many ways for users to query and retrieve the letters. The number of index fields
that you define usually depends on how your users retrieve documents from the
system. In the example that follows, index fields were defined for the date on the
letter, the name of the person that sent the letter, the company name, and the
subject of the letter.

This section describes how to use a scanner and image capture software to create
the image files. Before you can load the image files into the system, you must
define an application group to manage the storage of the letters, an application to
specify the physical and logical properties of the letters, and a folder to let users
search for and retrieve the letters.

Defining the application group

When you load an input file into the system, IBM Content Manager OnDemand
updates the database with the index data that you provide and stores the indexed
groups of pages as documents in cache storage and archive storage. The
application group contains the information that Content Manager OnDemand uses
to store and maintain the index data and the documents on the system. This
section provides information about some of the key properties of the application
group. You can use the Content Manager OnDemand administrative client to
define an application group.

© Copyright IBM Corp. 1991, 2010 155

 “Database Organization”
“Expiration Type”
“Permissions”
“Field Definition”

Database Organization
The Database Organization determines how IBM Content Manager OnDemand
organizes the index data that is stored in the application group.

Accept the default Database Organization of Multiple Loads per Database Table
and Table Size of its maximum number of rows. Each time that a letter (input file)
is loaded into the system, Content Manager OnDemand adds one row to a
database table. When a table reaches its maximum number of rows, Content
Manager OnDemand closes the table and creates a new table (unless you select
Single table for all loads). Content Manager OnDemand always adds index records
to the open table; the closed tables can be queried.

Expiration Type
The Expiration Type determines how IBM Content Manager OnDemand deletes
index data and documents from the application group.

Accept the default Expiration Type of Load. This means that Content Manager
OnDemand deletes the index data and documents from one load process (one or
more input files) at a time from the application group. Depending on the number
of input files processed during a load process, one or more letters (input files) may
be deleted at a time. For example, if you create a parameter file for the Generic
Indexer that contains index data for several input files, then Content Manager
OnDemand will delete all of the index data and documents from the application
group at the same time.

Permissions
Application group permissions determine the users that can access information
stored in the application group and determine the users that can do other types of
tasks related to the application group.

Under the *PUBLIC identifier, specify the Access permission so that all of the users
defined to the server can access data stored in the application group.

Field Definition
The Field Definition page is where you define the database fields for the
application group. When you load an input file into the system, IBM Content
Manager OnDemand stores the index data that is specified in the parameter file
into fields in records that are added to the database. When a user searches for
letters, Content Manager OnDemand compares the search criteria entered by the
user with index data in the application group.

Define the following database fields. The fields allow users to locate letters based
on different criteria, such as the date of the letter, the name of the person that sent
the letter, and the subject of the letter.
ldate The date on the letter. Defined as a date field.
name The person that sent the letter. Defined as a string field that contains
variable length data.

156 Common Server Administration Guide

 company
The person’s company. Defined as a string field that contains variable
length data.
subject
The subject of the letter. Defined as a string field that contains variable
length data.

Defining the application

Most customers define an application for each different source of input data that
they plan to load into IBM Content Manager OnDemand. This section provides
information about some of the key properties of the application. You can use the
Content Manager OnDemand administrative client to define an application.
“Application Group”
“Data Format”
“Indexer”
“Data Compression”

Application Group
You must assign an application to an application group. Assign the application to
the application group that was created in “Defining the application group” on
page 155.

Data Format
The Data Format determines the kind of data that is found in the documents that
are stored on the system. If the type of the data that is found in the original input
file is different than the type of the data that is found in the documents that are
stored on the system, then you should specify the type of the data that will be
stored in Content Manager OnDemand. (In this example, the type of the data is the
same, a TIFF image.) Selected TIFF as the Data Type. When saving the scanned
image of a letter, save the data as a TIFF image.

Indexer
The indexer determines the indexing program that Content Manager OnDemand
uses to index and convert input data. Select Generic as the indexer. To store TIFF
images in the system, you must index them with the Generic Indexer program that
is provided with Content Manager OnDemand.

Data Compression
The Data Compression determines whether IBM Content Manager OnDemand
compresses the input files.

Selected Disable, so that Content Manager OnDemand does not attempt to

compress the input files. In this example, the scanned image files are created as
compressed TIFF images. Therefore, it is not necessary for the system to compress
them. If you need to create scanned image files as uncompressed TIFF images, you
should select one of the compression methods so that the system can compress the
input files to improve storage efficiency and retrieval performance.

Loading image files 157

Defining the folder
You must define a folder so that users can search for and retrieve the input files
that you load into Content Manager OnDemand. This section provides information
about some of the key properties of the folder. You can use the Content Manager
OnDemand administrative client to define a folder.
“Application Group”
“Permissions”
“Field Definition”
“Field Mapping”

Application Group
A folder can be used to search one or more application groups. Select the
application group that was created in “Defining the application group” on page
155. When users open the folder, they can search for and retrieve the input files
that were loaded into the application group.

Permissions
Folder permissions determine the users that can open the folder and determine the
users that can do other types of tasks related to the folder.

Under the *PUBLIC identifier, specify the Access permission so that all users
defined to the library server can open the folder.

Field Definition
The Field Definition page is where you define the search fields for the folder. The
search fields contain the search criteria entered by the user. For most folders, you
probably want to define a search field for each field that you defined for the
application group.

Define the following fields. The fields allow users to locate letters based on
different criteria, such as the date of the letter, the name of the person that sent the
letter, and the subject of the letter.
Letter Date
The date on the letter.
From The person that sent the letter.
Company
The person’s company.
Subject
The subject of the letter.

Field Mapping
The Field Mapping page is where you map, or associate, the folder fields to the
application group fields. This is how you specify that the search criteria that a user
enters in a particular folder field should be used to search a specific application
group field. Map each of the folder fields to their corresponding application group
fields. For example, map the folder field named Letter Date to the application
group field named Ldate.

158 Common Server Administration Guide

Accessing the image files
The ARSLOAD program runs on the Content Manager OnDemand server and is
the primary Content Manager OnDemand program for loading images and other
user-defined data. The files that you want to load into the system by using the
ARSLOAD program must be stored on the server or you must provide network
access to the files.

In the example, the files were copied from a PC to the server as binary files with a
file type of TIF.

Store the input files on the server in the location from which you plan to run the
ARSLOAD program. Otherwise, you must specify the full path name of the input
files in the Generic index file.

Creating index data

You must create index data for your input files before you can load them into IBM
Content Manager OnDemand. If the input data is other than AFP, line, or PDF,
then you must use the Generic Indexer to load it into the system. You specify
index data for the Generic Indexer using a parameter file. You should use a
standard text editor to create the parameter file. The following figure shows an
example of a parameter file that can be used by the Generic Indexer to process
image files. See the IBM Content Manager OnDemand for i Common Server: Indexing
Reference for more information about the Generic Indexer and the parameter file.

Loading image files 159

CODEPAGE:819
COMMENT: input file number 1
GROUP_FIELD_NAME:ldate
GROUP_FIELD_VALUE:09/01/95
GROUP_FIELD_NAME:name
GROUP_FIELD_VALUE:Mr. Earl Hawkins
GROUP_FIELD_NAME:company
GROUP_FIELD_VALUE:Soft Products
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:optical storage devices
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter1.tif
COMMENT: input file number 2
GROUP_FIELD_NAME:ldate
GROUP_FIELD_VALUE:09/01/95
GROUP_FIELD_NAME:name
GROUP_FIELD_VALUE:Hans G. Piker
GROUP_FIELD_NAME:company
GROUP_FIELD_VALUE:MBI Company
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:optical storage devices
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter2.tif
COMMENT: input file number 3
GROUP_FIELD_NAME:ldate
GROUP_FIELD_VALUE:09/16/95
GROUP_FIELD_NAME:name
GROUP_FIELD_VALUE:Laurie Unicolas
GROUP_FIELD_NAME:company
GROUP_FIELD_VALUE:Dove Properties
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:account balance due
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter3.tif
COMMENT: input file number 4
GROUP_FIELD_NAME:ldate
GROUP_FIELD_VALUE:10/01/95
GROUP_FIELD_NAME:name
GROUP_FIELD_VALUE:George VanLocal
GROUP_FIELD_NAME:company
GROUP_FIELD_VALUE:Express American
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:airline fares
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter4.tif

Figure 44. Example of a Generic Indexer parameter file

Save the parameter file as LETTERS.IND on the server in the directory from which
you plan to run the ARSLOAD program.

Configuring the ARSLOAD program

Important: The IBM Content Manager OnDemand server job must be running,
otherwise the ARSLOAD program will fail.

The ARSLOAD program is the primary Content Manager OnDemand data

indexing and loading program for image files. The ARSLOAD program determines
if the input data needs to be indexed, and if so, it calls the indexing program. The
ARSLOAD program then processes the index data, loading it into the database,

160 Common Server Administration Guide

 optionally compresses the input data into storage objects, and copies the storage
objects to storage volumes. See “ARSLOAD” on page 248 for more information
about running the ARSLOAD program within QSHELL, including the parameters
that you can specify to process input files.

You typically run the ARSLOAD program each time that you want to load a file or
set of files into the system. You can either run the ARSLOAD program from the
command line or configure it to run periodically to check for input data to process.
To support a low volume scanning operation, most customers run the ARSLOAD
program from the command line using QSHELL. For example:
arsload -n -g Letters letters

Specify the following parameters to the ARSLOAD program:

-n Do not delete the input files.
-g Letters
The name of the application group to load.
letters
The name of the input file to process.

In the example, the ARSLOAD program must locate the input file LETTERS.IND in
the current directory. The input file contains the index information that was created
in “Creating index data” on page 159 (which is a parameter file for the Generic
Indexer). The image files must be in the same directory.

Processing the input data

The ARSLOAD program processes the parameter file, loads the index data into the
database, and loads the image files into Content Manager OnDemand.
“Processing index data”
“Processing the image files”
“Verifying processing” on page 162

Processing index data

The ARSLOAD program processes the parameters that were specified on the
command line and the indexing parameter file before loading the index data into
the database. The ARSLOAD program extracts information from the application
group and the application and performs the following processing:
v Determines the database field information from the application group
v Determines the data type and other information from the application
v Creates one database row for each group that was specified in the parameter
file. One group was specified for each image file.
v Passes the index rows to the database manager. The rows contain the index
values and other fields generated by Content Manager OnDemand. An index
row contains:
– One column for each field that was defined for the application group
– One or more columns of Content Manager OnDemand control information

Processing the image files

The ARSLOAD program processes each image file that was specified in the
parameter file. The ARSLOAD program extracts information from the application
group and the application and performs the following processing:

Loading image files 161

 v Determines the compression information from the application
v Determines the storage management information from the application group.
The storage management information determines the storage locations, such as
disk and archive storage.
v Stores the image files in storage objects. Content Manager OnDemand uses a 10
MB storage object (the default value) to improve storage efficiency and
performance. Content Manager OnDemand assigns unique names to the storage
objects and sequentially numbers them within an application group.

Verifying processing
The ARSLOAD program saves a copy of the messages that were generated during
a load process in the system log. (In the System Log folder, search for message
number 87 for a successful load or 88 for an unsuccessful load.) After a load
process completes, you can open the System Log folder and review the messages.
The information in the messages includes the date and time that the load process
started and completed, the name of the input file(s), and the number of rows that
were added to the database. For example:
arsload: Processing file
>/images/IBMCM.ODKREL.Orders.PackingList.20090118.143129.ARD<
arsload: 01/26/09 12:25:42 -- Loading started, 201165 bytes to process
OnDemand Load Id = >5492-0-0-5FAA-11549-11549<
Loaded 1 rows into the database
Document compression type used - Disable. Bytes Stored = >201281< Rows = >1<
arsload: 01/26/09 12:25:48 Loading completed
arsload: Processing successful for file
>/images/IBMCM.ODKREL.Orders.PackingList.20090118.143129.ARD<

You can verify the number of rows that Content Manager OnDemand added to the
database. In the example, the number of rows added to the database should equal
the number of groups (and image files) that was specified in the parameter file.

The OnDemand Load ID represents the data that the ARSLOAD program stored
into the system during a load process. The Load ID can be used to identify a
specific load process. For example, you can run the RMVRPTOND command and
specify the Load ID to delete the index data and documents that were created
when the ARSLOAD program processed a Generic Indexer parameter file.

162 Common Server Administration Guide

Loading user-defined data
IBM Content Manager OnDemand provides support for storing and retrieving
almost any type of data. For example, Content Manager OnDemand provides
support for AFP, Line, PDF, GIF, JFIF (JPEG), PCX, and TIFF data. However,
Content Manager OnDemand is not limited to maintaining these types of data.
Content Manager OnDemand provides the User-Defined data type to support
almost any other type of data that you want to store in the system. For example,
you can configure the system to process Lotus® WordPro documents, so that when
a user retrieves one of the files from the system, Content Manager OnDemand
automatically starts Lotus WordPro to open the document.

To store user-defined data on the system, you must create index data for the input
files and you must register the file type of the input file with Content Manager
OnDemand. The file type determines the program that is started to open a file
when a user retrieves one of the files from the system. The file type must also be
registered with the client operating system. If your Content Manager OnDemand
system supports client programs that run under different operating systems, then
you must register the specified file type on all of the client operating systems.

Content Manager OnDemand provides the Generic Indexer so that you can index
user-defined data. You specify the index data for the input files that you want to
index with the Generic Indexer in a parameter file. The parameter file contains the
index field names and values and identifies the input files that you want to
process. You can create up to 32 index fields for each input file that you want to
load into the system, providing many ways for users to query and retrieve
documents. The number of index fields that you define usually depends on how
your users retrieve documents from the system. For example, you might want to
define index fields for the date, author, and subject or purpose of the user-defined
data.

Before you can load user-defined data into the system, you must define an
application group to manage the storage of the files, an application to specify the
physical and logical attributes of the input files, and a folder to let users search for
and retrieve the files. This section contains an example that shows how to define
Lotus WordPro files to Content Manager OnDemand. It provides an overview of
defining the application group, application, and folder. For details and a
comprehensive example of defining input data to OnDemand, see the following
sections:
“Defining the application group” on page 164
“Defining the application” on page 165
“Defining the folder” on page 166
“Accessing the input files” on page 167
“Creating the index data” on page 167
“Configuring the ARSLOAD program” on page 168
“Processing the input data” on page 169

© Copyright IBM Corp. 1991, 2010 163

Defining the application group
When you load an input file into the system, Content Manager OnDemand
updates the database with the index data that you provide and stores the indexed
groups of pages as documents in cache storage and archive storage. The
application group contains the information that Content Manager OnDemand uses
to store and maintain the index data and the documents on the system. This
section provides information about some of the key properties of the application
group. You can use the Content Manager OnDemand administrative client to
define an application group.
“Database organization”
“Expiration type”
“Permissions”
“Field definition”

Database organization
The Database Organization determines how Content Manager OnDemand
organizes the index data that is stored in the application group.

Accept the default Database Organization of Multiple Loads per Database Table
and Table Size of its maximum number of rows. Each time that a Lotus WordPro
file is loaded into the system, Content Manager OnDemand adds one row to a
database table. When a table reaches its maximum number of rows, Content
Manager OnDemand closes the table and creates a new table. Content Manager
OnDemand always adds index records to the open table; closed tables can be
queried.

Expiration type
The Expiration Type determines how Content Manager OnDemand deletes index
data and documents from the application group.

Accept the default Expiration Type of Load. This means that Content Manager
OnDemand deletes the index data and documents from one load process (one or
more input files) at a time from the application group. Depending on the number
of input files processed during a load process, one or more Lotus WordPro files
may be deleted at a time. For example, if you create a parameter file for the
Generic Indexer that contains index data for several input files, Content Manager
OnDemand will delete all of the index data and documents from the application
group at the same time.

Permissions
Application group permissions determine the users that can access information
stored in the application group and determine the users that can do other types of
tasks related to the application group.

Under the *PUBLIC identifier, specify the Access permission so that all of the users
defined to the server can access data stored in the application group.

Field definition
The Field Definition page is where you define the database fields for the
application group. When you load an input file into the system, Content Manager
OnDemand stores the index data that is specified in the parameter file into fields

164 Common Server Administration Guide

 in records that are added to the database. When a user queries the system, Content
Manager OnDemand compares the search criteria entered by the user with index
data in the application group.

Define the following database fields. The fields allow users to locate files based on
different criteria, such as the date, author, and subject of the file.
fdate The date associated with the file. For example, the date the file was created
or the date the file was published. Defined as a date field.
author The author of the file. Defined as a string field that contains variable
length data.
subject
The subject or purpose of the file. Defined as a string field that contains
variable length data.

Defining the application

Most customers define an application for each different source of input data that
they plan to load into Content Manager OnDemand. This section provides
information about some of the key properties of the application. You can use the
Content Manager OnDemand administrative client to define an application.
“Application Group”
“Data Format”
“File Extension”
“Indexer” on page 166
“Data Compression” on page 166

Application Group
You must assign the application to an application group. Assign the application to
the application group that was created in “Defining the application group” on
page 164.

Data Format
The Data Format determines the kind of data that is found in the documents that
are stored on the system. If the type of the data that is found in the original input
file is different than the type of the data that is found in the documents that are
stored on the system, then you should specify the type of the data that will be
stored in Content Manager OnDemand.

Because there is not a supplied Data Format for Lotus WordPro files, you must
select User Defined from the Data Type list.

File Extension
When you select User Defined from the Data Type list, you must also enter a value
in the File Extension. The File Extension determines the program that is started to
open a user-defined file when it is retrieved from the system. In the example, type
the characters LWP, for Lotus WordPro.

The File Extension that you specify must also be registered on the client operating
system. See your operating system information for help with registering file
extensions.

Loading user-defined data 165

 Indexer
The indexer determines the indexing program that Content Manager OnDemand
uses to index and convert input data. Select Generic as the indexer. To store
user-defined files on the system, you must index them with the Generic Indexer
program provided with Content Manager OnDemand.

Data Compression
The Data Compression determines whether Content Manager OnDemand
compresses the input files.

On the Load Information page, accept the default Data Compression of OD77 so
that Content Manager OnDemand will compress input files before storing them on
the server. Resources are not supported with user-defined input data.

Defining the folder

You must define a folder so that users can search for and retrieve the input files
that you load into Content Manager OnDemand. This section provides information
about some of the key properties of the folder. You can use the Content Manager
OnDemand administrative client to define a folder.
“Application Group”
“Permissions”
“Folder fields”
“Field Mapping” on page 167

Application Group
A folder can be used to search one or more application groups. Select the
application group that was created in “Defining the application group” on page
164. When users open the folder, they can search for and retrieve the Lotus
WordPro files that were loaded into the application group.

Permissions
Folder permissions determine the users that can open the folder and determine the
users that can do other types of tasks related to the folder.

Under the *PUBLIC identifier, specify the Access permission so that all users
defined to the server can open the folder.

Folder fields
The Field Definition page is where you define the search fields for the folder. The
search fields contain the search criteria entered by the user. For most folders, you
probably want to define a search field for each field that you defined for the
application group.

Define the following folder fields. The fields allow users to locate files based on
different criteria, such as the date, the author, and the subject.
File Date
The date associated with the file. For example, the date the file was created
or the date that the file was published.

166 Common Server Administration Guide

 Author
The person that created the file.
Subject
The subject or purpose of the file.

Field Mapping
The Field Mapping page is where you map, or associate, the folder fields to the
application group fields. This is how you specify that the search criteria that a user
enters in a particular folder field should be used to search a specific application
group field. Map each of the folder fields to their corresponding application group
fields. For example, map the folder field named File Date to the application group
field named fdate.

Accessing the input files

The ARSLOAD program runs on the Content Manager OnDemand server and is
the primary data loading program for user-defined data. The files that you want to
load into the system by using the ARSLOAD program must be stored on the
server or you must provide network access to the files.

In the example, the files were copied from a PC to the server as binary files with a
file type of LWP.

Store the input files on the server in the location from which you plan to run the
ARSLOAD program. Otherwise, you must specify the full path name of the input
files in the Generic index file.

Creating the index data

You must create index data for your input files before you can load them into the
system. If the input data is other than AFP, line, or PDF, then you must use the
Generic Indexer to load it into the system. You must specify index data for the
Generic Indexer using a parameter file. You should use a standard text editor to
create the parameter file. The following figure shows an example of a parameter
file that can be used by the Generic Indexer to process the Lotus WordPro files. See
the IBM Content Manager OnDemand for i Common Server: Indexing Reference for
more information about the Generic Indexer and the parameter file.

Loading user-defined data 167

CODEPAGE:819
COMMENT: input file number 1
GROUP_FIELD_NAME:fdate
GROUP_FIELD_VALUE:12/18/95
GROUP_FIELD_NAME:author
GROUP_FIELD_VALUE:Jessica Hawkins
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:optical storage devices
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter1.lwp
COMMENT: input file number 2
GROUP_FIELD_NAME:fdate
GROUP_FIELD_VALUE:12/18/95
GROUP_FIELD_NAME:author
GROUP_FIELD_VALUE:Paul Garveys
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:optical storage devices
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter2.lwp
COMMENT: input file number 3
GROUP_FIELD_NAME:fdate
GROUP_FIELD_VALUE:12/18/95
GROUP_FIELD_NAME:author
GROUP_FIELD_VALUE:Randy Perkinsen
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:account balance due
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter3.lwp
COMMENT: input file number 4
GROUP_FIELD_NAME:fdate
GROUP_FIELD_VALUE:12/18/95
GROUP_FIELD_NAME:author
GROUP_FIELD_VALUE:Georgia July
GROUP_FIELD_NAME:subject
GROUP_FIELD_VALUE:airline fairs
GROUP_OFFSET:0
GROUP_LENGTH:0
GROUP_FILENAME:letter4.lwp

Figure 45. Example of a Generic Indexer parameter file

Save the parameter file as LWP.IND on the server in the directory from which you
plan to run the ARSLOAD program.

Configuring the ARSLOAD program

Important: The Content Manager OnDemand server job must be running,
otherwise the ARSLOAD program will fail.

The ARSLOAD program is the primary Content Manager OnDemand data

indexing and loading program for user-defined data. The ARSLOAD program
determines if the input data needs to be indexed, and if so, it calls the indexing
program. The ARSLOAD program then processes the index data, loading it into
the database, optionally compresses the input data into storage objects, and copies
the storage objects to storage volumes. See “ARSLOAD” on page 248 for more
information about running the ARSLOAD program within QSHELL, including the
parameters that you can specify to process input data.

You typically run the ARSLOAD program each time that you want to load a file or
set of files into the system. You can either run the ARSLOAD program from the

168 Common Server Administration Guide

 command line or configure it to run as a daemon (UNIX® servers) or service
(Windows servers) to periodically check for input data to process. To store a few
WordPro files at a time, most customers run the ARSLOAD program from the
command line using QSHELL. For example:
arsload -n -g 'Lotus WordPro Documents' lwp

Specify the following parameters to the ARSLOAD program:

-n Do not delete the input files.
-g ’Lotus WordPro Documents’
The name of the application group to load.
lwp The name of the input file to process.

In the example, the ARSLOAD program must locate the input file LWP.IND in the
current directory. The input file contains the index information that was created in
“Creating the index data” on page 167 (which is a parameter file for the Generic
Indexer). Because the full path name of the input file was not specified, they must
reside in the same directory.

Processing the input data

The ARSLOAD program processes the parameter file, loads the index data into the
database, and loads the Lotus WordPro files into Content Manager OnDemand.
“Processing index data”
“Processing the Lotus WordPro files”
“Verifying processing” on page 170

Processing index data

The ARSLOAD program processes the parameters that were specified on the
command line and the indexing parameter file before loading the index data into
the database. The ARSLOAD program extracts information from the application
group and the application and performs the following processing:
v Determines the database field information from the application group
v Determines the data type and other information from the application
v Creates one database row for each group that was specified in the parameter
file. One group was specified for each Lotus WordPro file.
v Passes the index rows to the database manager. The rows contain the index
values and other fields generated by Content Manager OnDemand. An index
row contains:
– One column for each field that was defined for the application group
– One or more columns of Content Manager OnDemand control information

Processing the Lotus WordPro files

The ARSLOAD program processes each Lotus WordPro file that was specified in
the parameter file. The ARSLOAD program extracts information from the
application group and the application and performs the following processing:
v Determines the compression information from the application
v Determines the storage management information from the application group.
The storage management information determines the storage locations, such as
disk and archive storage.

Loading user-defined data 169

 v Stores the Lotus WordPro files in storage objects. Content Manager OnDemand
uses a 10 MB storage object (the default value) to improve storage efficiency and
performance. Content Manager OnDemand assigns unique names to the storage
objects and sequentially numbers them within an application group.

Verifying processing
The ARSLOAD program saves a copy of the messages that were generated during
a load process in the system log. After a load process completes, you can open the
System Log folder and review the messages. Search for message number 87 for a
successful load or 88 for an unsuccessful load. The information in the messages
includes the date and time that the load process started and completed, the name
of the input file, and the number of rows that were added to the database. For
example:
arsload: Processing file
>/wordproc/letter.lwp.ARD<
arsload: 01/26/09 12:25:42 -- Loading started, 201165 bytes to process
OnDemand Load Id = >5492-0-0-5FAA-11549-11549<
Loaded 1 rows into the database
Document compression type used - Disable. Bytes Stored = >201281< Rows = >1<
arsload: 01/26/09 12:25:48 Loading completed
arsload: Processing successful for file
>/wordproc/letter.lwp.ARD<

You can verify the number of rows that Content Manager OnDemand added to the
database. In the example, the number of rows added to the database should equal
the number of groups (and Lotus WordPro files) that were specified in the
parameter file.

The OnDemand Load ID represents the data that the ARSLOAD program stored
into the system during a load process. The Load ID can be used to identify a
specific load process. For example, you can run the RMVRPTOND command and
specify the Load ID to delete the index data and documents that were created
when the ARSLOAD program processed a Generic Indexer parameter file.

170 Common Server Administration Guide

Restarting a load process
The ADDRPTOND command will terminate if an unrecoverable error occurs
during index, database, or storage manager processing. Termination processing
includes setting a return code and saving error messages in the system log.

To start problem determination, open the System Log folder and view the
messages that the command generated during the load process. The message log
will contain normal processing messages, return codes, and error messages, such as
message number 87 for a successful load or 88 for an unsuccessful load. See
“System log messages” on page 203 or IBM Content Manager OnDemand: Messages
and Codes, SC27-1379 for other possible messages.

If the command failed during indexing, correct the problem and then restart the
load process from the beginning. Common causes of problems during indexing
include invalid input files or indexing parameter files and insufficient temporary
space.

Tip: The messages in the system log will actually refer to a program named
ARSLOAD.

If the command failed during database processing or storage manager processing:

v Determine and correct the problem.
v If a Load ID is listed in the message log that the ADDRPTOND command saved
in the system log, then you can use the RMVRPTOND command to unload the
data. See “Deleting a report” on page 187 for information about unloading data
from Content Manager OnDemand.
v Restart the load process from the beginning.

© Copyright IBM Corp. 1991, 2010 171

172 Common Server Administration Guide
Importing and exporting OnDemand objects through batch
administration
“Overview”
“Installing batch system administration”
“Importing an XML file into an OnDemand system” on page 176
“Exporting OnDemand administrative objects to an XML file” on page 184

Overview
You can use an XML interface to import and export administrative objects into and
out of an IBM Content Manager OnDemand system. The administrative objects
that can be imported and exported include:
v users
v groups
v applications
v application groups
v storage sets
v folders
v printers
v cabinets
This XML interface expands the functionality and enables you to export all
administrative objects into a single XML file, and later import them into the same
Content Manager OnDemand system or another system.

Also, you can create an XML file from scratch through a user application or Web
interface according to the defined specifications, and import it into the system.

Prerequisite: For all platforms, you should have an appropriate Java Runtime
Environment (JRE). For IBM i systems, install the licensed program product
5761-JV1 - IBM Developer Kit for Java.

Installing batch system administration

You can install and setup the prerequisites for Content Manager OnDemand batch
system administration. Information presented here explains how to do this, and
describes a short installation verification process.
“Prerequisites”
“Configuring Xerces2 Java Parser” on page 174
“Installation verification” on page 174
“Common problems during installation verification” on page 175

Prerequisites
The IBM Content Manager OnDemand Batch System Administration code requires
the following software:

© Copyright IBM Corp. 1991, 2010 173

 v Java Runtime Environment Version 1.4.1 or later. For IBM i systems, install the
licensed program product 5761-JV1 - IBM Developer Kit for Java.
v XML Parser Xerces2 Java Parser Version 2.6.2 or later. See “Configuring Xerces2
Java Parser” for details.
The following files are included with the Content Manager OnDemand batch
system administration:
v /QBIM/ProdData/OnDemand/bin/arsxml
v /QIBM/ProData/OnDemand/bin/xml/ODAdmin.jar
v /QIBM/ProdData/OnDemand/bin/xml/ondemand.xsd - (OnDemand XML Schema
file)
v /QIBM/ProdData/OnDemand/bin/xml/samples/addgroups.xml
v /QIBM/ProdData/OnDemand/bin/xml/samples/addusers.xml
v /QIBM/ProdData/OnDemand/bin/xml/samples/deletegroups.xml
v /QIBM/ProdData/OnDemand/bin/xml/samples/deleteusers.xml
v /QIBM/ProdData/OnDemand/bin/xml/samples/exportgroups.xml
v /QIBM/ProdData/OnDemand/bin/xml/samples/exportusers.xml
v /QIBM/ProdData/OnDemand/bin/xml/samples/updategroups.xml
v /QIBM/ProdData/OnDemand/bin/xml/samples/updateusers.xml

| Configuring Xerces2 Java Parser

| About this task

| The Content Manager OnDemand batch system administration process uses the
| Xerces2 Java Parser Version 2.6.2. The parser files are shipped with OnDemand in
| the /QIBM/ProdData/OnDemand/bin/xml directory on your IBM i server.

| In the Content Manager OnDemand config directory (/QIBM/UserData/

| OnDemand/config), create a file named arsxml.cfg. This file is used to specify the
| directory of the jar files listed above. The file should contain only one line:
| ODXMLDIR=/QIBM/ProdData/OnDemand/bin/xml

| If you are upgrading from a previous version of OnDemand and have already
| configured the arsxml.cfg file, you should change it to point to these new Xerces2
| Parser files in the directory shown above.

Installation verification
About this task

Perform the following steps:

1. Log onto your IBM i system with a user profile that is defined to Content
Manager OnDemand as an Administrator, and that has sufficient authority to
create user profiles.
2. Create five user profiles, to be used for installation verification, called
SAMPLEUSR0, SAMPLEUSR1, SAMPLEUSR2, SAMPLEUSR3, and
SAMPLEUSR4 on your i system. (These user profiles will be deleted when you
have completed the installation verification.)

What to do next

You should not add these five user profiles to Content Manager OnDemand at this
point. You will do this later, using the batch administration function.

174 Common Server Administration Guide

 To run the ARSXML program, first start QSHELL. You do this by using the Start
QSH (STRQSH) command.

Run this command:

arsxml add -h QUSROND -i /qibm/proddata/ondemand/bin/xml/samples/addusers.xml -v

where QUSROND is the name of the Content Manager OnDemand instance into
which you want to add new users.

Important: Omitting the -u and -p parameters causes Content Manager

OnDemand to use the user profile with which you are currently logged on.

The XML file contains user passwords that are six to eight characters. If the
Content Manager OnDemand system where these users are created has different
password restrictions, these passwords might need to be changed before you run
the command.

After you run the command, you should receive several messages stating that a
printer and five users were added successfully.

If the command is properly run, you should be able to use the Content Manager
OnDemand Administrator client to view the newly added users and printer.

To remove the newly added objects, run this command:

arsxml delete -h <hostname> -u <user> -p <password> -i deleteusers.xml -v

where QUSROND is the instance to which you previously added users. Then,
delete the five user profiles called SAMPLEUSR0, SAMPLEUSR1, SAMPLEUSR2,
SAMPLEUSR3, and SAMPLEUSR4 from your IBM i system.

You can use several other sample XML files. However, these files depend on the
users that are created by the addusers.xml file.

Common problems during installation verification

This section discusses some common errors that you might encounter during
installation verification.
“The input file .../xerces-2_6_2/xml-apis.jar was not found”
“The input file .../xerces-2_6_2/xercesImpl.jar was not found” on page 176
“Exception in thread main java.lang.NoClassDefFoundError:
org/w3c/dom/Node” on page 176
“Exception in thread main java.lang.NoClassDefFoundError:
org/apache/xerces/parsers/AbstractDOMParser” on page 176
“A parsing error occurred in file xxxx/samples/addusers.xml, Line 3, Column
62: cvc-elt.1: Cannot find the declaration of element onDemand.” on page 176

The input file .../xerces-2_6_2/xml-apis.jar was not found

This error indicates that the required Xerces2 Java Parser code file xml-apis.jar
was not found. Make sure that the Xerces2 Java Parser directory was correctly
entered into the XML configuration file. For more information, see “Configuring
Xerces2 Java Parser” on page 174.

Importing and exporting OnDemand objects through batch administration 175

 The input file .../xerces-2_6_2/xercesImpl.jar was not found
This error indicates that the required Xerces2 Java Parser code file xml-apis.jar
was not found. Make sure that Xerces2 Java Parser directory was correctly entered
into the XML configuration file. For more information, see “Configuring Xerces2
Java Parser” on page 174.

Exception in thread main java.lang.NoClassDefFoundError:

org/w3c/dom/Node
This error usually indicates that the required Xerces2 Java Parser code file
xercesImpl.jar was not found or is not valid. See “Configuring Xerces2 Java
Parser” on page 174 and make sure that Xerces2 Java Parser code was downloaded
properly and that the directory was correctly entered into the XML configuration
file.

Exception in thread main java.lang.NoClassDefFoundError:

org/apache/xerces/parsers/AbstractDOMParser
This error usually indicates that the required Xerces2 Java Parser code file
xercesImpl.jar was not found or is not valid. See “Configuring Xerces2 Java
Parser” on page 174 and make sure that Xerces2 Java Parser code was downloaded
properly, and that the directory was correctly entered into the XML configuration
file.

A parsing error occurred in file xxxx/samples/addusers.xml, Line

3, Column 62: cvc-elt.1: Cannot find the declaration of element
onDemand.
This error usually indicates that the IBM Content Manager OnDemand schema file,
ondemand.xsd, was not found. See “Installation verification” on page 174 and make
sure that the ARSXML command is run from correct directory.

The sample files require that the Content Manager OnDemand schema file be
located in the directory ″above″ where the ARSXML command is run. If changes
are made to the sample files, it might be necessary to update the location of the
schema file within the sample files to the full path name of the ondemand.xsd file.

Importing an XML file into an OnDemand system

About this task

Importing an XML file that contains administrative objects into a IBM Content
Manager OnDemand system is a two-step process:
1. Preparing an XML file for the import process
2. Importing the XML file by using the ARSXML API
“Preparing an XML file for the import process”
“Creating an XML file” on page 178
“Importing the XML file by using the ARSXML command” on page 184

Preparing an XML file for the import process

Before importing data into an IBM Content Manager OnDemand system, you need
to have an XML file that contains all the data that needs to be imported. The XML
file can be either created during a previous XML export process or created

176 Common Server Administration Guide

manually. If you decide to develop an XML file manually, you must follow the
format of the OnDemand XML schema file.

The OnDemand XML schema file defines the syntactic format for all OnDemand
XML files, and is used during the import process to validate the contents of the
import XML file. For different objects, the schema file specifies which fields are
required and which fields are optional. Also, the schema file can establish a list of
valid values for certain fields.

The following sample is a portion of the OnDemand schema file for the object user:
<xs:element name="user">
<xs:complexType>
<xs: choice maxOccurs="unbounded">
<xs:element name="userPermission" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="task" type="taskString" use="optional"/>
<xs:attribute name="user" type="nameString" use="optional"/>
<xs:attribute name="group" type="nameString" use="optional"/>
<xs:attribute name="userAuthority" type="authString" use="optional"
default="Access"/>
</xs:complexType>
</xs:element>
</xs:choice>

<xs:attribute name="name" type="nameString" use="required"/>

<xs:attribute name="uid" type="xs:integer" use="optional"/>
<xs:attribute name="description" type="descString" use="optional"/>
<xs:attribute name="password" type="passwordString" use="optional"/>

<xs:attribute name="fullName" type="userMiscString" use="optional"/>

<xs:attribute name="acctInfo" type="userMiscString" use="optional"/>
<xs:attribute name="company" type="userMiscString" use="optional"/>
<xs:attribute name="title" type="userMiscString" use="optional"/>
<xs:attribute name="addr1" type="userMiscString" use="optional"/>
<xs:attribute name="addr2" type="userMiscString" use="optional"/>
<xs:attribute name="addr3" type="userMiscString" use="optional"/>
<xs:attribute name="addr4" type="userMiscString" use="optional"/>
<xs:attribute name="dept" type="userMiscString" use="optional"/>
<xs:attribute name="building" type="userMiscString" use="optional"/>
<xs:attribute name="room" type="userMiscString" use="optional"/>
<xs:attribute name="phone" type="phoneString" use="optional"/>
<xs:attribute name="fax" type="phoneString" use="optional"/>
<xs:attribute name="coverPage" type="userMiscString" use="optional"/>
<xs:attribute name="printer" type="xs:string" use="optional"/>
<xs:attribute name="timeOut" type="xs:string" use="optional"/>
<xs:attribute name="email" type="emailString" use="optional"/>

<xs:attribute name="userType" type="userTypeString"

use="optional" default="User"/>
<xs:attribute name="createFoldersAuth" type="yesnoString"
use="optional" default="No"/>
<xs:attribute name="createUsersAuth" type="yesnoString"
use="optional" default="No"/>
<xs:attribute name="createGroupsAuth" type="yesnoString"
use="optional" default="No"/>
<xs:attribute name="createAppGroupsAuth" type="yesnoString"
use="optional" default="No"/>
</xs:complexType>
</xs:element>

The following sample is a portion of the OnDemand schema file for the object
group:

Importing and exporting OnDemand objects through batch administration 177

 <xs:element name="group">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="user" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="task" type="taskString" use="optional"/>
<xs:attribute name="name" type="nameString" use="required"/>
</xs:complexType>
</xs:element>
</xs:choice>

<xs:attribute name="name" type="nameString" use="required"/>

<xs:attribute name="gid" type="xs:integer" use="optional"/>
<xs:attribute name="description" type="descString" use="optional"/>
<xs:attribute name="ownerUser" type="nameString" use="optional"/>
<xs:attribute name="ownerGroup" type="nameString" use="optional"/>
</xs:complexType>
</xs:element>

The following example is a portion of the OnDemand XML file, which contains a
Content Manager OnDemand administrative user named bill and a user group
named SpecialGroup. SpecialGroup is owned by the user admin, and contains a single
user bill.
<user name="bill"
password=""
description="This is an Admin user."
email="[email protected]"
userType="User Admin">
</user>

<group name="SpecialGroup"
description="A Special Group for special users"
ownerUser="admin">
<user name="bill"/>
</group>

Creating an XML file

Occasionally, you need to manually create an OnDemand XML file. To do this you
need to understand the syntax of XML and the structure of the XML objects. These
objects are used by IBM Content Manager OnDemand.
“Overall file structure”
“OnDemand objects” on page 179

Overall file structure

An OnDemand XML file is an unformatted text file that can be created by the user.

Every OnDemand XML file contains the following elements:

XML identifier tag
The XML identifier tag specifies the version of XML that is used and the
encoding that is used. The standard XML identifier is:
<?xml version="1.0" encoding="UTF-8"?>
OnDemand identifier tag
The Content Manager OnDemand identifier tag specifies what the XML file
is used for and what schema file to use. The standard Content Manager
OnDemand identifier is:
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../ondemand.xsd">

178 Common Server Administration Guide

 The name of the ondemand.xsd file, shown here as ondemand.xsd, should be
changed if you have changed the name of your OnDemand XML schema
file. The ondemand.xsd file must be located one directory level above the
directory containing your XML files.
OnDemand objects
See Content Manager OnDemand for Multiplatforms Administration Guide for
objects and data model used in the XML file.
OnDemand ending tag
The Content Manager OnDemand ending tag indicates the end of the
OnDemand XML file. The ending tag is:
</onDemand>

Every standard OnDemand XML file looks like this:

<?xml version="1.0" encoding="UTF-8"?>

<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">
... OnDemand Objects ...
</onDemand>

OnDemand objects
The basic building blocks for the XML file are referred to as objects.

The following objects can be included in the OnDemand XML file:

v user
v group
v application
v applicationGroup
v storageSet
v folder
v printer
v cabinet
These eight objects and all child objects are shown in detail in the XML data tables
in the Content Manager OnDemand for Multiplatforms Administration Guide. The
OnDemand objects can occur in any order within the XML file, but cannot be
imbedded within each other.

Each object that is added to the XML file contains the following information:
v A Start of Object tag
v A list of object attributes
v An optional list of child objects
v An End of Object tag
“Start of Object” on page 180
“Object attributes” on page 180
“Child objects” on page 180
“End of object” on page 180
“Examples” on page 181
“Creating OnDemand XML files for update” on page 181
“Creating OnDemand XML files for delete and export” on page 183
“Application Index Parameter Object” on page 184

Importing and exporting OnDemand objects through batch administration 179

 Start of Object: An object is specified in the XML file by placing the object name
after a < symbol. For example,
<user

starts a user object.

Important: The capitalization of the object names is important and should be used
exactly as shown in the data tables in Content Manager OnDemand for Multiplatforms
Administration Guide.

Object attributes: All of the information about the object is contained within the
object attributes. To add an attribute, specify the attribute name followed by an
equal symbol followed by the value of the attribute in quotation marks. (All
attribute values need to be enclosed in a set of double quotes even if the value is a
numeric value or a single character.) Following the attribute values, the
greater-than symbol is used to indicate the end of the object tag. For example:
<user name="SAMPLEUSER" phone="(212) 555-1212" timeOut="4" >

This tag indicates a user with the name SAMPLEUSER, the phone number (212)
555-1212, and the time out value 4 minutes. All the attributes that can be specified
for each object, as well as the possible values and default values, are shown in the
XML data tables.

Important:
1. The capitalization of the object names is important and should be used exactly
as shown in the data tables in Content Manager OnDemand for Multiplatforms
Administration Guide.
2. When you add a user, IBM Content Manager OnDemand converts lowercase
letters in the user ID to uppercase. You can type the user ID in uppercase,
lowercase, or mixed case letters. In the above example, whether you enter the
user ID as SAMPLEUSER, sampleuser, or SampleUser, Content Manager
OnDemand automatically converts it to SAMPLEUSER.

Child objects: Child objects are constructed the same way as the eight main
OnDemand objects. All child objects must occur after the object to which they are
associated, and before the end of the object tag. In this example, there are two user
permission children for the SampleUser user:
<user name="SampleUser" phone="(212) 555-1212" timeOut="4" >
<permission user="APP1" adminAuthority="Yes" />
<permission user="APP2" adminAuthority="Yes" />

Important: If an object cannot contain any children, such as the permission objects
shown above, it must be ended with a slash / and the > symbol.

See Content Manager OnDemand for Multiplatforms Administration Guide for detailed
information about the types of child objects that each object can have and, in some
cases, the maximum number of child objects that can be created.

Some of the child objects themselves can have children. These are defined in the
same way as above. See the second example in the Examples section.

End of object: The last item the user object needs is the end of object tag. This is
indicated by placing the name of the object between </ and >. For example,
</user>

180 Common Server Administration Guide

indicates the end of the user object.

As with any object if the object does not contain child objects, the object can be
ended by placing a /> at the end of the object definition. So the following,
<group name="Sample" gid="84000">
</group>

is equivalent to:
<group name="Sample" gid="84000"/>

Examples:

The following is example shows a complete OnDemand XML file that contains two
users and a user group:
<?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">

<user
name="SampleUsr1" email="[email protected]" printer="Sample"
userType="User Admin"
createFoldersAuth="Yes">
<permission user="SampleUsr2" adminAuthority="Yes" />
<permission user="SampleUsr3" adminAuthority="No" />
<permission group="SampleGroup1"/>
</user>

<user
name="SampleUsr2" password="xxxxxxx" timeOut="No Limit"
description="This is a description of Sample User Two">
</user>

<group
name="SampleGroup1"
description="A Sample Group Number One"
ownerUser="Admin">
<user name="SampleUsr2"/>
<user name="SampleUsr3"/>
</group>

</onDemand>

The following example shows a folder with a field child, and the field child has a
fieldInfo child.
<?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">
<folder name="FolderOne" searchType="Hit List">
<field name="cost" fieldType="Decimal" >
<fieldInfo user="SampleUser" sortOrder="2" greaterThan="Default" lessThan="Yes"/>
</field>
</folder>
</onDemand>

Creating OnDemand XML files for update: When you create an XML file to be
used for updating information, you should use the same syntax and layout as
discussed in the previous section. However, there are two major differences.
v You only need to specify those fields that you intend to be updated.
v Child objects might contain the additional attribute task. The task attribute
indicates the task that is performed by the child object.

Importing and exporting OnDemand objects through batch administration 181

 Each object that you update must contain the name of the object. Any other
attributes that are specified are updated to the specified value. If an object that is
updated requires a change to another object, that object must be included in the
XML file before the object that references it. For example, to change the user
SampleUser to timeout after 10 minutes, you need to put the following XML code
into an XML file.
<user name="SampleUser" timeOut="10"/>

For all of the main objects, the name field can be specified as _ALL to update all of
the objects of that type. For example, to remove the authority to create folders from
all of the defined users, you can use the following XML code:
<user name="_ALL" createFoldersAuth="No"/>

| When you specify some special characters in XML, you need to use the XML
| specification. For example:
| Table 6. XML specification for special characters
| XML code Character
| &amp; &
| &apos; ’
| &quot; “
| &lt; <
| &gt; >
|
| Your input file might look like this:
| ...
| <user
| name="DBRYANTDEU"
| acctInfo="Engraving &amp; Printing"

To rename some objects, you should use the newName attribute. For example, to
change the name of a printer from Boston to New York, use the following XML
code during an update:
<printer name="Boston" newName="NewYork"/>

Most objects might contain a set of similar child objects. To update these objects,
you should use the task attribute. The task attribute can have three values:
add Indicates that the child object will be added to the parent object. The
default value for the task attribute is add. However, some child objects do
not contain a task attribute. For those objects without a task attribute, the
action taken for the object is the same action as the parent object.
update
This indicates that the child object already exists and should be updated
with the attributes provided.
delete This indicates that the child object already exists and should be removed
from the parent object.

The task attribute is examined only during an update process. To add, update or
delete a child object, the parent object must be specified, and must contain the
child object to be updated.

182 Common Server Administration Guide

The default value for the task attribute is add. However, some child objects do not
contain a task attribute. For those objects without a task attribute, the action taken
for the object will be the same action as the parent object.

When you update or delete child permission objects, you might specify the value
of _ALL for the user or the group, to indicate that the update or removal should
pertain to all of the users or groups that are already defined for the parent object.
“Examples”

Examples:

To add a permission for the user SampleUser to the folder FolderOne, the following
code can be used during an update:
<folder name="FolderOne">
<permission user="SampleUser" adminAuthority="Yes" maxHits="No Limit" />
</folder>

To remove the administration authority permission from SampleUser on the folder

FolderOne, you need to update the permission child. The following code is an
example:
<folder name="FolderOne">
<permission task="update" user="SampleUser" adminAuthority="No" />
</folder>

To remove the SampleUser permission from the folder, you need to delete the
permission child.
<folder name="FolderOne">
<permission task="delete" user="SampleUser"/>
</folder>

To remove all user permissions that are currently defined for the folder FolderOne,
the following XML code can be used during an update:
<folder name="FolderOne">
<permission task="delete" user="_ALL"/>
</folder>

Creating OnDemand XML files for delete and export: When you create an
OnDemand XML file to use for exporting or deleting objects, you should use the
same syntax and layout as described in previous sections. However, there are two
major differences:
v The only attribute field that is examined is the name field.
v All child objects are ignored.
When you export or delete objects, the only information that is required is the
name of the objects. All other attributes might be present in the XML file, but are
ignored. It is possible to delete only child objects through the update process.
During a delete process all child objects are ignored.

When you specify an application for delete or export, you must also specify the
name of the application group in which the application is contained.

The name of _ALL can be used during export and delete to indicate that all objects
of that type should be exported or deleted.

To export the users SampleOne, SampleTwo, and SampleThree, you can use the
following OnDemand XML file:

Importing and exporting OnDemand objects through batch administration 183

 <?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">

<user name="SampleOne"/>
<user name="SampleTwo"/>
<user name="SampleThree"/>
</onDemand>

To delete the printer, OldPrinter, and the folder, MyFolder, use the following XML
code:
<printer name="OldPrinter"/>
<folder name="MyFolder"/>

To delete all defined printers, the following XML code could be used during a
delete process.
<printer name="_ALL"/>

Application Index Parameter Object: The indexParm child object of the

application object has a slightly different syntax than all other objects. Owing to
the type of the data associated with the Index Parameters, you cannot use an object
attribute to specify this information. Thus, for this object (and only this object), the
data associated with the object is simply the character data that appears between
the <indexParm> and the </indexParm> flags.

For example, the following code can be used to set the index parameters associated
with the SampleApp application:
<application name="SampleApp" .... >
<indexParm>
*dummy index parameters
parm1=value;
parm2=value;
parm3=value;
</indexParm>
</application>

Importing the XML file by using the ARSXML command

Use the ARSXML program to import the XML file into the Content Manager
OnDemand system. For syntax, description, and parameters of this command, see
“ARSXML” on page 256.

Exporting OnDemand administrative objects to an XML file

You can use the ARSXML command to export objects from Content Manager
OnDemand into an XML file in several ways:
v You can export a single object, such as a single user.
v You can export all the defined objects of a particular type, for example, all user
groups
v You can export any combination of objects, for example, a user group and all
users in that group
This feature can be used to back up part of a Content Manager OnDemand system,
copy objects from one system to another, or store objects into an XML file so that
they can be processed by another application.

184 Common Server Administration Guide

Use the ARSXML command to export administrative objects into an XML file. For
syntax, description, and parameters of this command, see “ARSXML” on page 256.

If you are exporting objects that have dependencies on other objects: Some objects
in Content Manager OnDemand might have dependencies on other objects. For
example, a group object has a dependency on all of the users that are defined
within the group. When you export these objects, you can use the -r parameter
with a value of d to include in the XML file all of the dependent objects that the
exported objects might have.

See “ARSXML” on page 256 for more example XML files that are generated in
different export scenarios.

Importing and exporting OnDemand objects through batch administration 185

186 Common Server Administration Guide
 Deleting a report
| You can use the RMVRPTOND command to delete the index data and documents
| that the ADDRPTOND command stored in the system during a load process. To
| use the delete command, you must specify the application group name and Load
| ID that the ADDRPTOND command generated during the load process. The Load
| ID represents the index data that was added to the database and the storage
| objects that were copied to disk and archive storage. The complete Load ID can be
| found in the message that the ADDRPTOND command saved in the system log. A
| partial Load ID (which is all that RMVRPTOND actually requires) can be found by
| viewing the Properties of a document from the document list of the OnDemand
| client. From the Search Criteria and Document List panel, right-click a document
| and select Properties. The Document Properties window displays, which contains
| the Partial Load ID information.

See the online help for RMVRPTOND for more information about the command
and parameters.

When the RMVRPTOND command completes, you should open the system log
folder to view the messages that were generated during the delete process. The
messages will reference a program named ARSADMIN.

Important: The Content Manager OnDemand server job must be running.

Otherwise, the RMVRPTOND command fails.

© Copyright IBM Corp. 1991, 2010 187

188 Common Server Administration Guide
 Managing the server
This chapter provides information for a number of topics related to the IBM
Content Manager OnDemand server.
“Errors and alerts”
“System logging facility”
| “ARSSUPPORT utility” on page 192
You can use ARSSUPPORT, a Java based tool that runs on your IBM i server to
gather diagnostic information such as log entries. This tool is especially helpful
when you need to report problems to IBM service.
“Finding or changing the server job and its attributes for a particular instance”
on page 193
“Controlling the run priority of instance server jobs” on page 194
| “Using OnDemand data areas” on page 195
“Restarting journaling” on page 196

Errors and alerts

During normal processing, IBM Content Manager OnDemand programs, including
the client programs, generate messages. Content Manager OnDemand saves the
messages in the System Log and sends a copy of each message to the System Log
user exit program. Content Manager OnDemand assigns a severity to each
message. Messages that are assigned a severity of alert or error are also sent to the
IBM i QSYSOPR message queue and logged in the server job log. Additionally,
when a user runs a query that requires a table of index data that has been
migrated to archive storage, Content Manager OnDemand sends a message to
QSYSOPR and the job log.

Content Manager OnDemand provides the System Logging facility to help you
identify and resolve any alerts and errors that you may receive. You can open the
System Log folder to display the messages that are saved in the System Log. See
“System logging facility” for more information; see “System log messages” on page
203 or IBM Content Manager OnDemand: Messages and Codes, SC27-1379 for a listing
of message numbers and text.

System logging facility

IBM Content Manager OnDemand provides a logging facility to help
administrators track Content Manager OnDemand activity and monitor the system.
When you enable logging for system events, user events, and application group
events, Content Manager OnDemand stores the messages that are generated by the
various Content Manager OnDemand programs in the System Log. You can use
the Content Manager OnDemand client program to search for and filter messages
by time stamp, severity, message number, and user name.
“Searching for and viewing messages” on page 190
“System Log user exit” on page 191
“Monitoring users” on page 191
“Generating usage statistics” on page 191

© Copyright IBM Corp. 1991, 2010 189

 Searching for and viewing messages
To search for and view the messages that are stored in the System Logging facility,
log on to IBM Content Manager OnDemand with an OnDemand client program
and open the System Log folder. Enter search criteria in one or more of the search
fields. When you choose the Search command, Content Manager OnDemand
retrieves the messages from the database that match the search criteria that you
specified.

You can specify a date and time value to search for and retrieve messages. You can
also specify other search criteria, such as:
Userid
The OnDemand user ID
Account
Accounting information; the information specified in the Account field for
the user.
Log Id
Each time that a client logs on to the server, Content Manager OnDemand
assigns a number to that session. All messages that are generated during
that session include the same Log Id.
Severity
Content Manager OnDemand assigns a severity to each message: Alert,
Error, Warning, Info, and Debug
View Depending on the type of message in the System Log, you may be able to
view other information that is related to or associated with the message.
For example:
v You can display the message log that was generated during a load
process by selecting an ARSLOAD message and then choosing the View
all Selected command. You might see ARSLOAD messages after issuing
the ADDRPTOND command.
While most processes do not generate other information that can be
stored in the System Log, you could write a user exit program to process
the messages and generate your own information about the events. For
example, you could write a user exit program to generate a report that
lists the number of users that are logged on to the system in 30 minute
increments. Content Manager OnDemand provides a System Log user
exit so that you can process any message that is stored in the System
Log and take the action that you require. See below for more
information about the System Log user exit.
v Other messages in the System Log do not provide additional records or
other data associated with an event. For example, the Logon and Logoff
events each generate a single message, with no additional information
that you can view.
Msg Num
The message number that is assigned by Content Manager OnDemand
Message
The text of the message that Content Manager OnDemand uses to restrict a
search. For example, if you type Login, Content Manager OnDemand
searches for and displays the messages issued by the Logon to a Server
command.

190 Common Server Administration Guide

System Log user exit
When you enable logging for system, user, and application group events, IBM
Content Manager OnDemand sends a copy of each message that is generated by
the system to the System Log user exit program. The System Log user exit
program is named arslog and resides in the Content Manager OnDemand library
named QRDARS.

The System Log user exit program that is provided by IBM does not perform any
functions. However, you can replace the program that is provided by IBM with
your own program that does user-defined processing. For example, you could
create a program that checks for certain message numbers or severity and takes
whatever action you deem appropriate.

You configure Content Manager OnDemand to send messages to the System Log
user exit by selecting User Exit Logging options with the System Parameters
command. See the online help for the administrative client for more information
about the User Exit Logging options and the System Parameters command.

See the IBM Content Manager OnDemand for i Common Server Planning and
Installation Guide for more information about the System Log user exit.

Monitoring users
The IBM Content Manager OnDemand server generates System Log messages to
help you track the number of users that are logged on to the server:
v Content Manager OnDemand stores message number 201 in the System Log
approximately every 30 minutes if at least one activity is detected. This message
contains the current number of users that are logged on to the server.
v Content Manager OnDemand stores message number 202 in the System Log
every time that the number of concurrent users exceeds the previous maximum
number of concurrent users. The number of concurrent users is reset each time
that you restart the Content Manager OnDemand server processes.

Generating usage statistics

IBM Content Manager OnDemand administrators can run queries against the
System Log database file to gather usage statistics about Content Manager
OnDemand, provided they have checked the appropriate logging options in the
Content Manager OnDemand Application Group definitions for the information
they want to capture.

The initial System Log file name is SL2. This System Log file is found in the library
whose name matches the instance name. For example, the initial System Log file
for the QUSROND instance is named SL2 in library QUSROND on the IBM i
server. When the initial System Log file becomes full, a new file is created, and its
name is incremented by one; the name thus becomes SL3.

For example, on the Message Logging tab of an Application Group definition, the
Content Manager OnDemand administrator can select the Retrieval checkbox,
which provides messages in the System Log for every retrieval from the particular
Application Group.

As another example, the Content Manager OnDemand administrator can set up

Application Group fields such that when the end user searches on that particular
field, the information is provided in the message placed in the System Log. To do

Managing the server 191

 this, select the Log checkbox on the Field Information tab of the Application
Group for the field for which you want to capture information.

Two of the most common message numbers that can be queried from the System
Log file are:
v Number 65 (the actual search)
v Number 66 (the retrieval with field information and OnDemand Application
name)

| ARSSUPPORT utility
| You can use ARSSUPPORT, a Java based tool that runs on your IBM i server to
| gather diagnostic information such as log entries. This tool is especially helpful
| when you need to report problems to IBM service.

| The ARSSUPPORT utility is delivered in the arssupport.jar file. To invoke the

| utility, use this QSHELL command (entered all on one line as one command from
| the QSHELL command prompt) on the IBM i system that is running OnDemand:
| java -cp /qibm/proddata/ondemand/support/arssupport.jar
| com/ibm/cm/od/arssupport parameters

| Prerequisites
| v Ensure that you have IBM Developer Kit for Java (licensed program product
| 5761-JV1) on your system.
| v Ensure that you are logged on to the operating system using an ID that is also
| defined to OnDemand as a system administrator.
| v Run ARSSUPPORT from the QSHELL command prompt.
| v To retrieve system log entries, ensure that the OnDemand server is running.
| v The data is collected from the system where ARSSUPPORT is run.

| Syntax
|  arssupport 
| -h -I instance name -l -m minutes

|  
| -o outputpath -p password -u userid -v
|

| Parameters
| -h Use this parameter to display help and usage information about this tool.
| -I instance name
| Specify the instance name to collect the instance information. If you do not
| specify this option, QUSROND is used as the instance name.
| -l Specify this parameter to retrieve system log entries. If you do not specify
| this option, the log entries for the past 60 minutes are retrieved. Ensure
| that you use this parameter with the -u and -p parameters.
| -m minutes
| Specify how many past minutes of the system log entries to retrieve from
| the server. The maximum is 6000 minutes.

192 Common Server Administration Guide

| -o outputpath
| Specify the output directory name. If the output directory is not specified,
| the output directory is the current directory.
| -p password
| Password that you use to access the server. If the -l parameter is specified,
| the -p parameter is required.
| -u userid
| The OnDemand user ID that you use to access the server. If the -l
| parameter is specified, the -u parameter is required.
| -v Verbose output while running.

| ARSSUPPORT generates information about a Content Manager OnDemand server

| including information about its configuration and system environment.
| ARSSUPPORT archives all files into one compressed file, arssupport.zip, and
| places this file in the odsupport subdirectory of the output directory.

| Examples (shown below as three separate QSHELL commands)

| java -cp /qibm/proddata/ondemand/support/arssupport.jar
| com/ibm/cm/od/arssupport -h
|
| java -cp /qibm/proddata/ondemand/support/arssupport.jar
| com/ibm/cm/od/arssupport -o /directory_name -l -u admin -p password
|
| java -cp /qibm/proddata/ondemand/support/arssupport.jar
| com/ibm/cm/od/arssupport -I instance -l -m 28 -u admin -p password

Finding or changing the server job and its attributes for a particular
instance
The name of the server job for a particular server matches the name of the IBM
Content Manager OnDemand instance for which it is running. For example, the
server job name is QUSROND for the default Content Manager OnDemand
instance named QUSROND. You can use the command WRKACTJOB
JOB(QUSROND) to find this default server job.

In addition, Common Server spawns many QSQSRVR jobs during its processes. To
determine which specific QSQSRVR job to view if you encountered a problem with
a Content Manager OnDemand process, look at the instance job log (for example,
the job log for the QUSROND job) and compare the time stamps of the error
messages to the time stamps of the QSQSRVR job logs to determine which
spawned QSQSRVR job or jobs are related to the particular process you are
investigating.

Server jobs are started using a job description by the name of the instance (which
must be found in the QUSRRDARS library). If a job description by that name is
not found in QUSRRDARS, then job description QOND400 in library QRDARS is
used (and can be changed if necessary).

The job description controls the following attributes of the server job:
v JOBQ
v JOBPTY
v OUTPTY
v PRTDEV
v OUTQ

Managing the server 193

 v INLLIBL
v LOG
v LOGCLPGM
v INQMSGRPY
v HOLD
v DATE
v SWS
v JOBMSGQMX
v JOBMSGQFL

For example, if you wanted to change the job queue that instance TEST used, you
would create a job description called TEST in library QUSRRDARS that specified
the job queue you wanted to use. This alternate job queue could be used to send
the server jobs to a different subsystem than the default.

Controlling the run priority of instance server jobs

The run priority of Common Server instance server jobs is by default set by the
*ANY routing entry in the QSYSWRK subsystem description. Normally this
defaults to priority 50. (It depends on the class that is specified for the *ANY
routing entry in subsystem QSYSWRK.) If you wish to change this for all instance
server jobs, you may add a routing entry to the QSYSWRK subsystem description
using the Add Routing Entry (ADDRTGE) command as follows:
ADDRTGE SBSD(QSYS/QSYSWRK) SEQNBR(nnnn) CMPVAL('QRLMSERVER') +
PGM(QSYS/QCMD) CLS(class)

Where:
nnnn is an unused routing sequence number in the QSYSWRK subsystem,
which is lower than the *ANY routing entry sequence number.
class is the name of an IBM i class object (OBJTYPE(*CLS)) that contains the
attributes you want to use.
For example:
ADDRTGE SBSD(QSYS/QSYSWRK) SEQNBR(1000) CMPVAL('QRLMSERVER') +
PGM(QSYS/QCMD) CLS(QSYS/QSYSCLS35)

The system ships with the following classes that you might consider using:
QSYS/QSYSCLS25 (Run priority of 25)
QSYS/QSYSCLS35 (Run priority of 35)

If you want to specify a different run priority, for example 45, then you need to
create your own class. An example command that does this is:
CRTCLS CLS(QGPL/ONDSVR45) RUNPTY(45) TIMESLICE(2000) +
PURGE(*YES) DFTWAIT(30) CPUTIME(*NOMAX) +
MAXTMPSTG(*NOMAX) +
TEXT('OnDemand Common Server run priority 45 class')

After creating the class, specify it as the class name in the routing entry for
QRLMSERVER in subsystem QSYSWRK.

194 Common Server Administration Guide

| Using OnDemand data areas
| OnDemand data areas can be used to customize the way certain processes run. The
| following table lists the data areas that can be created and used with OnDemand.
| Table 7. OnDemand data areas
| Data area Library Scope Description Details
| name
| QRLCTAPE QRDARS Global Controls end-of-tape *CHAR with a
| option (ENDOPT) length of 7.
| during OnDemand Possible values
| tape processing, such are *LEAVE, and
| as ASM. *UNLOAD, left
| justified. Default
| without data
| area is to unload
| the tape. Note
| that *REWIND is
| not supported,
| since it would
| not be logical to
| rewind the tape
| and leave it
| loaded.
| QRLMFKPORT QUSRRDARS Global Port number for *CHAR with a
| FNDKEYOND length of 10.
| command. Used Contains port
| when two or more number for
| OnDemand servers Common Server
| exist in the network. instance in
| positions 1
| through 5.
| Positions 6
| through 10 are
| no longer used
| and can be left
| blank.
| STRTCPSVR QUSRRDARS Global Default instance *CHAR with a
| name for use with length of 10.
| the STRTCPSVR Contains a
| SERVER(*ONDMD) specific instance
| INSTANCE(*DFT) name, left
| and ENDTCPSVR justified.
| SERVER(*ONDMD)
| INSTANCE(*DFT)
| commands.
| QRLMMONQ QUSRRDARS Global (if in When this data area *CHAR with a
| or instance QUSRRDARS) exists, the monitor length of 1. Can
| library or instance (if will execute ILE be left blank.
| in instance monitor exit
| library) programs. If the data
| area does not exist,
| only OPM monitor
| exit programs will
| be executed. (Checks
| both QUSRRDARS
| and instance library.)

Managing the server 195

| Table 7. OnDemand data areas (continued)
| Data area Library Scope Description Details
| name
| QDFTINST QUSRRDARS Global (if in Default instance *CHAR with a
| or any other QUSRRDARS name used when length of 10.
| library in or any other INSTANCE(*DFT) is Contains a
| library list library in specified on an specific instance
| when library list OnDemand name, left
| command is when command. The justified.
| run command is QDFTINST data area
| run) can exist in multiple
| libraries. A search
| for the QDFTINST
| data area is
| performed using the
| library list. The first
| data area found will
| be used. If the
| QDFTINST data area
| is not found using
| the library list, the
| QUSRRDARS library
| will be searched for
| the data area. If the
| data area exists in
| the QUSRRDARS
| library it will be
| used. If the
| QDFTINST data area
| is not found,
| instance QUSROND
| is used.

| This data area does

| not apply to the
| STRTCPSVR and
| ENDTCPSVR
| commands. See the
| STRTCPSVR data
| area instead.
|
|
Restarting journaling
If you receive a message on the server indicating that journaling needs to be
started for your IBM Content Manager OnDemand database files, issue the
following command from a command line while signed on with sufficient
authority: CALL QRLCSTRJ PARM(RLC)

Important: The parameter value (RLC) must be entered in uppercase.

196 Common Server Administration Guide

 Command reference
This part contains reference information about the IBM Content Manager
OnDemand server commands. The commands are presented in alphabetical order.
Each command contains a description of its purpose. See the online help text for
details about the command parameters.
“OnDemand server commands”

OnDemand server commands

These commands require that you be signed on to the server with a user profile
that is also defined as a user in IBM Content Manager OnDemand. For commands
that specify an application or application group name, if the value to be entered
contains lower case letters, blanks, or special characters, it must be enclosed in
apostrophes.

| Many of these commands include an INSTANCE parameter which specifies the

| OnDemand instance name for which you are running the command. By default,
| the QUSROND default instance is used, and will produce the desired results for
| most systems. You can use an instance other than QUSROND as your default by
| defining the QDFTINST data area as described in “Using OnDemand data areas”
| on page 195. You can also specify the instance name directly when you run the
| commands.
“ADDRPTOND”
“CHGPLDOND” on page 198
“CRTINSTOND” on page 198
“ENDMONOND” on page 198
“FNDKEYOND” on page 198
“MGRMEDRDAR” on page 198
“MRGSPLFOND” on page 199
“PRTRPTOND” on page 199
“PRTTXTOND” on page 200
“RMVRPTOND” on page 200
“STRASMOND” on page 200
“STRDSMOND” on page 201
“STRIMPOND” on page 201
“STRMONOND” on page 201

ADDRPTOND
The Add Report to OnDemand (ADDRPTOND) command allows you to load
reports in IBM Content Manager OnDemand. During this process the report is
broken into segments, indexed, compressed, and stored on disk for retrieval and
later migration to optical or tape media if desired. Input can be in the form of a
spooled file (*SPLF), a database file (*FILE), or a stream file (*STMF).

Important: Set the proper locale before issuing this command.

See the chapter entitled ″Defining a locale″ in the IBM Content Manager OnDemand
for i Common Server Planning and Installation Guide for important details.

© Copyright IBM Corp. 1991, 2010 197

 After the ADDRPTOND command has run, message number 87 will appear in the
System Log if the loading of data was successful; message 88 will appear if the
data loading failed.

CHGPLDOND
The Change Policy Level Date (CHGPLDOND) command changes the next level
date to the new date for objects that are at the named level in the named migration
policy. Only objects in the specified date range are changed.

| CRTINSTOND
| The Create Instance for OnDemand (CRTINSTOND) command creates an
| OnDemand instance.

| An OnDemand instance is a logical server environment with its own library

| containing a unique set of database files. An instance is defined in the ARS.INI file
| by naming the instance (which identifies the name of the library used by the
| instance). All of the database files that belong to an instance run in one and only
| one coded character set identifier (CCSID).

| When you are creating an instance, your user profile must have its locale set to the
| locale of the instance you wish to create. Because the locale is set in the user
| profile, you may need to change your user profile, then sign off and back on before
| creating the instance. Use the Change User Profile (CHGUSRPRF) command to
| change (if necessary) your user profile. You should also make sure that other
| language-related parameters in your user profile are set correctly. You can use the
| Display User Profile (DSPUSRPRF) command to check the locale setting. The locale
| Job Attributes (SETJOBATR) parameter in your user profile is used to determine
| which values are obtained from the locale. For OnDemand, at a minimum, you
| must use SETJOBATR(*CCSID).

ENDMONOND
| The End Monitor for OnDemand (ENDMONOND) command allows you to end a
| currently active monitor for an output queue or directory. Note that the *DIR
| monitor type on the ENDMONOND command will end either a *DIR or *DIR2
| type of monitor, regardless of whether it was started as a *DIR or *DIR2 monitor.

FNDKEYOND
The Find Key for the OnDemand (FNDKEYOND) command allows you to search
for a particular document that is available through the folder specified in the
FOLDER parameter, and starts the IBM Content Manager OnDemand client to
display the results of the search. The key fields entered must exist in the folder.
This is intended as an API to start the Content Manager OnDemand client from an
application running in a 5250 emulation session. See “5250 host connection to
client viewer” on page 205 for more details.

MGRMEDRDAR
| The Migrate Media (MGRMEDRDAR) command provides a tool to move
| OnDemand Spool File Archive data from one media type to another in an easy,
| recoverable way that can be stopped and restarted as needed. When the
| MGRMEDRDAR command runs, it updates all the necessary Spool File Archive
| files to point to the new location. The source media for the command can be an
| optical volume, a tape volume, or an individual report name. The target media can
| be disk for all types of source media, optical if the source media is optical, or

198 Common Server Administration Guide

| *ASM (Archive Storage Manager) if the source media is disk and contains reports
| that have been migrated from the Spool File Archive environment to the Common
| Server environment.

A long running MGRMEDRDAR job can be ended if necessary. However, it must

be ended in a controlled manner to prevent unexpected results. You can use the
End Job (ENDJOB) command, specifying JOB(job-number/user-name/job-name)
OPTION(*CNTRLD) DELAY(500) where job-number/user-name/job-name
identifies the MGRMEDRDAR job.

| Important: The MGRMEDRDAR command is included in this Common Server

| publication because the Spool File Archive data can be migrated to Common
| Server. For this reason, users of Common Server implementations might still be
| interested in using the MGRMEDRDAR command to move data that was
| originally stored in Spool File Archive from one medium to another. For detailed
| information on this media migration facility, refer to the IBM Content Manager
| OnDemand for i support Web page at http://www.ibm.com/software/data/
| ondemand/400/support.html and search for MMF.

| MRGSPLFOND
| The Merge Spooled Files (MRGSPLFOND) command combines multiple SNA
| character stream (SCS) spooled files and writes the result to a single spooled file or
| database file member. Spooled files to be merged must be contained in a single
| output queue and must be in Ready (RDY) status. Spooled files that are not in a
| Ready (RDY) status and that are not SCS will be left in the source output queue.

PRTRPTOND
The Print Report from OnDemand (PRTRPTOND) command prints the specified
report in its entirety.

If a printer name is specified for the PRINTER parameter, IBM Content Manager
OnDemand uses the first record found in the ARSPRT file (in your instance library)
with a printer name that contains the string you entered anywhere in the name.

For example, if you enter PRINTER1 for the PRINTER parameter and your
ARSPRT file has these three records (in this order), Content Manager OnDemand
sends your output to the first one in the following list:
v XPRINTER11
v PRINTER11
v PRINTER1

If *OUTQ is specified for the PRINTER parameter, you must also enter an output
queue name and library name. (*LIBL can be used for the library name.) Content
Manager OnDemand uses the printer associated with the first record found in the
ARSPRT file (in your instance library) with an output queue name that contains
the library name/output queue name you entered. An output queue name without
a library qualifier will never be used when PRINTER(*OUTQ) is specified. The
library on the OUTQ parameter defaults to *LIBL and no match is made. If you
have entered printers without a library qualifier, you must refer to them by name;
for example, PRINTER(PRINTER1). The PRTRPT job library is then used to locate
the output queue.

Command reference 199

 For example, if you enter QUSROND/MYOUTQ for the OUTQ parameter and
your ARSPRT file has these four records (in this order), Content Manager
OnDemand sends your output to the printer name associated with the first output
queue in the following list:
v QUSROND/MYOUTQ
v MYOUTQ
v AMYOUTQ
v TEST/MYOUTQ

Restriction: The COPIES and PAGERANGE parameters were removed from the
PRTRPTOND command in Version 6 Release 1, and should be removed from any
CL programs or job scheduler entries that might currently specify them.

PRTTXTOND
The Print Text for OnDemand (PRTTXTOND) command allows you to print all or
part of a spooled file in a text-only format. This allows the report administrator to
see what the report looks like to ADDRPTOND when it is indexed. Using this
output (spooled file name QPRLMTXT), the administrator can determine how to
index the report.

RMVRPTOND
The Remove Report from OnDemand (RMVRPTOND) command removes the
specified report from IBM Content Manager OnDemand.

STRASMOND
The Start Archived Storage Mgmt (STRASMOND) command starts the Archived
Storage Management (ASM) process which manages the movement of data within
the ASM defined levels. This function can be canceled with a controlled cancel
option if enough time is allowed to end what it is currently processing.

Important:
1. This command must only be run in batch (SBMJOB parameter set to *YES).
Running this command interactively (with SBMJOB(*NO)) may cause SQL
errors.
2. By default, the QUSROND default instance is used, and will produce the
desired results for most systems. If you need to run the STRASMOND
command for multiple instances, you must issue the command separately for
each instance. Note that if you initiate the archive storage manager by running
the STRDSMOND command with RUNASM(*YES), then the instance name is
passed from the disk storage manager and no further specifications are needed.
3. The report that is produced when ASM is run has a spooled file name of
QPRLCASM1. The report provides a list of actions that the ASM process
performed. This report should be checked each time ASM is run to ensure that
processing of the data completed successfully. If a failed condition is found, it
is important to check the job log for the STRASMOND job to determine the
cause of the failure. The STRASMOND command actually runs three
sub-functions: one to process all previously unprocessed objects, one to process
all aggregates with next level date less than or equal to today’s date, and one to
process all objects not in an aggregate with next level date less than or equal to
today’s date. You might see message RDR2798 one or more times in your
STRASMOND job log if any of these three sub-functions had no objects to
process.

200 Common Server Administration Guide

 4. See “Hints and tips” on page 80 for information about resetting optical volume
statistics such as bytes used and the volume full flag if you feel any of your
optical volumes may have incorrect values set.
5. The LOGSTS and SNDFAILMSG parameters have been removed from the
STRASMOND command at Version 6 Release 1 and should be removed from
any CL programs or job scheduler entries that may currently specify them.

STRDSMOND
| The Start Disk Storage Management (STRDSMOND) command starts the Disk
| Storage Management (DSM) task which manages the movement of OnDemand
| data on disk and between disk and the Archived Storage Manager (ASM) or Tivoli
| Storage Manager (TSM). DSM also controls the expiration of data in OnDemand.

Although you can run multiple STRDSMOND commands for different application
groups within the same instance or different instances, it is not recommended.

| This process can be canceled if absolutely necessary. Note that spawned jobs that
| are part of DSM processing may continue to run even after you cancel the original
| DSM job. You may also receive many SQL messages in the job log of the instance
| server job. Also be aware that when the DSM job is canceled, the report that
| provides information about the data that has been processed during the DSM job
| (system log message number 197) will not be created in the system log as is done
| when DSM runs to a normal completion.

Important: If you run STRDSMOND for a specific application group (rather than
the default of *ALL) and you set the Run ASM (RUNASM) parameter to *YES, be
aware that ASM will run for ALL application groups, even though you have
named a specific application group for DSM to use. You can, however, name a
specific Policy for ASM to process, if desired. Also note that when you specify
RUNASM(*YES), OnDemand will initiate a separate batch job for ASM.

Restriction: The VALIDATE parameter was removed from the STRDSMOND

command in Version 6 Release 1, and should be removed from any CL programs
or job scheduler entries that might currently specify it.

STRIMPOND
The Start Import into OnDemand (STRIMPOND) command allows you to import
data into OnDemand. This command is used only if you have migrated your index
data to an alternate media (such as optical or tape), which is not recommended,
but may be necessary in some cases.

STRMONOND
| The Start Monitor for OnDemand (STRMONOND) command allows you to specify
| the name of an output queue or IFS directory to monitor. When a spooled file is
| added to the output queue or a file is added to an IFS directory, the file is
| automatically processed by ADDRPTOND if it meets certain criteria as defined in
| the online help for the STRMONOND command. For example, spooled files must
| be in Ready (RDY) status to be processed. Files added to IFS directories must end
| in either a .IND extension (for *DIR monitor type) or a .ARD extension (for *DIR2
| monitor type).

Important: Set the proper locale before issuing this command. See the chapter
entitled ″Defining a locale″ in the IBM Content Manager OnDemand for i Common
Server: Planning and Installation Guide for important details.

Command reference 201

 The application and application group names for spooled files are determined
using spooled file attributes such as spooled file name or user data (or a number of
others). You can alter these values that Content Manager OnDemand uses for
application and application group by using the monitor user exit program as
described in “API and user exit reference” on page 213.

The application and application group names for workstation files are determined
by the file name itself. The monitor can use any one of the first four parts of the
file name. For example, a file name of CHECKSTMTS.BIGSTMTS.data might be used to
archive an application named CHECKSTMTS into an application group named
BIGSTMTS.

After the STRMONOND command has processed an input file, message number
87 will appear in the System Log if the loading of data was successful; message 88
will appear if the data loading failed.

You can end the monitor by:

v Specifying a method for the monitor to end automatically.
v Running the ENDMONOND command.
v Ending the monitor job using the ENDJOB command. Specify
OPTION(*CNTRLD) and DELAY(999999). The job will end as soon as the
monitor finishes processing the current file.

202 Common Server Administration Guide

System log messages
“Overview”

Overview
For a complete list of System Log messages, see IBM Content Manager OnDemand
Messages and Codes, SC27-1379.

You should always keep the system logs. (See the application group and folder
titled System Log.) For example, the System Log is an easy place to locate the Load
Identifier for archived data. Every time data is loaded into IBM Content Manager
OnDemand, message number 87 is placed in the system log and the Load
Identifier is recorded as part of the message. The Load Identifier is also called the
Report ID and is a required parameter (RPTID) for the Remove Report from
OnDemand (RMVRPTOND) and Print Report from OnDemand (PRTRPTOND)
commands. (You can also display a partial Load Identifier using the OnDemand
client while viewing archived data, which can be used for RMVRPTOND and
PRTRPTOND.)

When installed, the System Log application group is defined to never expire and
IBM recommends that you do not change that setting. If you do change the setting,
you should only expire the System Log data after all other application groups have
expired their data. In other words, the value in the Expire in x Days field under
Life of Data and Indexes on the Storage Management tab of the System Log
application group should always be larger than the same value in any other
application group. If any other application group is using the Never Expire setting,
you should not change the System Log application group setting from the default.

© Copyright IBM Corp. 1991, 2010 203

204 Common Server Administration Guide
 5250 host connection to client viewer
| This section describes the IBM Content Manager OnDemand 5250 Host
| Connection, which allows an IBM i application to send information to the Content
| Manager OnDemand client workstation viewer program (the viewer). The intent is
| to provide a mechanism by which a 5250 line-of-business application can use the
| viewer to display documents from the OnDemand database. This is done with
| little or no interaction between the user and the viewer.

| This function is comprised of two parts:

| v The FNDKEYOND command, which the line-of-business application will invoke.
| The FNDKEYOND command is a part of Option 10 (Common Server) of
| Content Manager OnDemand for i, and is used to retrieve documents archived
| using the Content Manager OnDemand Common Server feature. The output of
| the FNDKEYOND command will be displayed using the workstation viewer.
| v A companion program that resides on the workstation, which is the interface
| between the FNDKEYOND command and the viewer.
“Operational and environmental considerations”

Operational and environmental considerations

For this function to operate correctly, you must address several operational and
environmental considerations. This section will describe these considerations.
“Workstation installation tasks”
“Server configuration” on page 207

Workstation installation tasks

| For the FNDKEYOND command to operate correctly, the workstation companion
| program, QRLROCD.EXE, must be running on the workstation when the
| FNDKEYOND command is run on the server. This program is found in the
| OnDemand install directory, usually C:\Program Files\IBM\OnDemand32. The
| following paragraphs describe a suggested approach for simplifying the startup of
| this program.

After the OnDemand client software is installed on your workstation, you should
establish a shortcut which points to the QRLROCD.EXE program. This shortcut can
be placed on the workstation desktop, in the startup folder or in any other place
which meets your needs. Placing the shortcut in your startup folder will start the
program automatically when you start your workstation. This is appropriate if you
use this interface frequently. If you end the program and need to restart it, or if
you have no need for the program to be started automatically, you may want to
place a shortcut on the desktop.

| In most cases, you will only need to start the companion program once. If,
| however, the workstation is attached to multiple OnDemand server systems, you
| may need to start the program multiple times. In this case, you should create a
| shortcut for each one, for reasons explained below in the section labeled Multiple
| OnDemand servers in the network. Follow the directions in the sections below,
| depending on your configuration. The term ″multiple OnDemand server systems″

© Copyright IBM Corp. 1991, 2010 205

| refers to a network where there are two or more OnDemand server systems from
| which you need to view FNDKEYOND output concurrently using the viewer.
“One OnDemand server in the network”
“Multiple OnDemand servers in the network”
“Other workstation considerations”

One OnDemand server in the network

| If you will be using FNDKEYOND and there is only one OnDemand server where
| the command will be used, you may allow the command and the companion
| program to use the default port number (3005). In this case, it is not necessary to
| modify the shortcut to specify a different port. Skip to the section titled Other
| workstation considerations. If the above does not describe your configuration,
| continue with the next section.

Multiple OnDemand servers in the network

| If there are multiple OnDemand servers where the FNDKEYOND command may
| be run, a separate workstation companion program must be started on the
| workstation for each system.

Each instance of the companion program must be configured to use a different

port. After you have created the shortcuts you need, you should alter the
properties of the shortcuts to specify a port number and, optionally, a system
name. The system name, if specified, will appear as the window title for the
viewer which the shortcut will start.

To specify a port and system for a shortcut, right-click the shortcut. From the
pop-up menu, select Properties. On the Shortcut tab, you will see an entry box
labeled Target. This should contain the path for the QRLROCD.EXE program. At
the end of the path, after QRLROCD.EXE, add at least one space, followed by:
/p=nnnn /s=systemName

where nnnn is the port number and systemName is the name of the OnDemand
server.

Example:
..../qrlrocd.exe /p=3006 /s=ACCOUNTING

You may also use uppercase P and S (...qrlrocd.exe /P=3007 /S=BILLING ).

After adding the port and system parameters, press OK to save the new properties
of the shortcut. You also should change the title which displays beneath the
shortcut to something meaningful, such as ″OnDemand Viewer for ACCOUNTING
reports″.

Make a note of the port numbers and system names you have specified for the
shortcuts. It will be necessary to configure the server systems so that
FNDKEYOND will use the matching port numbers instead of the default. This is
discussed in the section ″Server Configuration″ below.

Other workstation considerations

| For FNDKEYOND output to be displayed correctly using the IBM Content
| Manager OnDemand viewer, the FNDKEYOND command on the server system
| must be able to determine the TCP/IP address of the workstation. You should

206 Common Server Administration Guide

| access your line-of-business applications which invoke FNDKEYOND through a
| terminal emulation session. The connection method for the session should be
| TCP/IP. If the FNDKEYOND command is run in a job attached to this session, the
| address of the workstation can be determined by the FNDKEYOND command,
| and nothing further needs to be done.

| If the emulation session does not use TCP/IP, the FNDKEYOND command
| searches for the presence of a data area, located in QUSRRDARS library, which has
| the same name as the device name associated with the emulation session. If the
| data area exists, the command looks for a non-blank value in positions 1-15 of the
| data area and uses this value as the workstation IP (Internet Protocol) address. It is
| the responsibility of the user to ensure that this data area exists and contains the IP
| address. You can use the CRTDTAARA and CHGDTAARA commands for this
| purpose.

| If the FNDKEYOND command detects errors when sending the search request to
| the workstation companion program, it will assign a three-digit error code and will
| display this information in message RDR2882.

| The following table lists the error codes and their meanings for exception
| RDR2882.
| Table 8. Exception RDR2882 error codes
| Error code Error description
| 002 Environment error. A connection could not be established with the
| workstation companion program because the workstation IP address
| could not be determined.
| 091 The TCP/IP socket could not be created.
| 092 Connect failed for TCP/IP socket. The most likely cause is that the
| workstation companion program is not running, or there is a port
| number mismatch between the FNDKEYOND command and the
| companion program.
| 093 Socket Close operation failed.
|

| Server configuration
| The information in this section is pertinent only if you created more than one
| shortcut. If you created only one shortcut, the FNDKEYOND command will
| function correctly using the default port number, and nothing further needs to be
| done.

If you created more than one shortcut, you should also have specified different
port numbers for the shortcuts. Since the FNDKEYOND command must use the
same port numbers which you specified on the shortcuts, it is necessary to
configure the command on the server systems to use the specified ports.

The FNDKEYOND command checks for the existence of a data area named
QRLMFKPORT, in library QUSRRDARS. If this data area does not exist, the
commands will use the default port number (3005). If the data area exists, the
FNDKEYOND command will use the port number found in the data area contents.
The first five characters of the data area contents represent the port number which
the FNDKEYOND command should use. The next five characters are no longer
used and will be ignored. To create this data area, enter the following:

5250 host connection to client viewer 207

| CRTDTAARA QUSRRDARS/QRLMFKPORT TYPE(*CHAR) LEN(10) VALUE( 'AAAAABBBBB' )
| where AAAAA is the FNDKEYOND port number and BBBBB is no longer used
| and will be ignored.

| For example, to specify that FNDKEYOND, on this system, should use port 3007,
| specify VALUE(’0300700000’). It is important that the five-position port number be
| right-justified within the first five positions of the data area value, with leading
| zeros if necessary. Enter 00000 for the last five positions that are no longer used.

| If there are multiple OnDemand servers in your network, and there are
| workstations which will display FNDKEYOND output from these systems, you
| must configure the FNDKEYOND command on these systems to use unique port
| numbers. Create the data area on the systems where it is necessary to change the
| port assignments for the FNDKEYOND command. For example, on SYSTEMA,
| specify VALUE( ’0300500000’), and on SYSTEMB specify VALUE( ’0300700000’). It
| is imperative that these commands on multiple systems in the network use
| different port numbers.

208 Common Server Administration Guide

Server printing and faxing
“Using an IBM i printer file to define server print parameters”
“Server fax setup” on page 210

Using an IBM i printer file to define server print parameters

You can use an IBM i printer file to define some of the server print parameters in
your Common Server application definition by specifying the following in the
Print Parameters field on the Print Options tab of your application:
PRTF=LIBRARY/PRINTERFILENAME

where LIBRARY is the name of the library that contains your printer file and
PRINTERFILENAME is the name of the printer file.

Important:
1. The entire line must be entered in uppercase.
2. The printer file cannot be an externally-described printer file. If necessary, you
will need to create a printer file that has the same characteristics (LPI, CPI,
page size, overlays, and so on), but that does not specify a source file (keyword
SRCFILE) on the CRTPRTF command.

This printer file specification is also used when faxing from the server to produce
the temporary i spooled file which is then faxed.

The following parameters, even though specified in the printer file identified in the
PRTF parameter, are overridden as shown in the following table.
Table 9. Parameter Overrides
Printer file Changed to Where specified When specified
parameter
DEVTYPE *AFPDS if AFP Application When defining the
data.*SCS if SCS or definition - View application
SCS-extended Information tab -
data.*LINE if Line Data Type field
data and an EBCDIC
code page is used;
otherwise it is set to
*SCS and the data is
converted from
ASCII to EBCDIC.
OUTQ Server Queue Name Printer definition When printing the
document, you select
the Server Printer
definition to use
COPIES Number of Copies Client Print window When printing the
document
USRDTA The first 10 When you logon to When you logon to
characters of your OnDemand OnDemand
OnDemand user ID

© Copyright IBM Corp. 1991, 2010 209

 Table 9. Parameter Overrides (continued)
Printer file Changed to Where specified When specified
parameter
USRDFNDTA Application name Application When defining or
definition - General updating the
tab - Name field application
PAGERANGE Pages value Client Print window, When printing the
but only if already document
viewing the
document

If no PRTF parameter is specified, printer file QSYSPRT is used and in addition to

the printer file parameters specified above, the parameters in the following table
are also set.
Table 10. QSYSPRT Parameters
Printer file Changed to Where specified When specified
parameter
CTLCHAR *FCFC for SCS and Application When defining or
Line data; otherwise definition - View updating the
use the CTLCHAR Information tab - application
value specified in the Data Type field
QSYSPRT printer file.
PAGRTT Orientation (for AFP) Application When defining or
definition - View updating the
Information - application
Orientation field

Server fax setup

When defining a printer for use with server fax functions, a Server Queue Name is
required in the printer definition within the IBM Content Manager OnDemand
Administrator. You can either specify the name of a library/output queue or
*NONE. If *NONE is specified, the output is temporarily spooled to
QUSRRDARS/QRDARS400 output queue before it is sent to fax using the
QRLMSFAX program. If you enter a library/output queue name, then Content
Manager OnDemand will use that output queue to temporarily spool the data.

If you use the SNDFAX command in the QRLMSFAX program (which is the
default as shipped), the restrictions in the following table apply to the fax
information. If you use a different server fax product, see “Facsimile user exit
program” on page 267.
Table 11. SNDFAX command fax information restrictions
OnDemand client SNDFAX maximum SNDFAX keywords Length passed to
prompt field length used QRLMSFAX
Recipient Attention 40 TO position 2 100
Recipient Company 40 TO position 3 100
Recipient Fax 32 TO position 1, TO 100
Number position 4
Sender Name 40 FROM position 1 100

210 Common Server Administration Guide

Table 11. SNDFAX command fax information restrictions (continued)
OnDemand client SNDFAX maximum SNDFAX keywords Length passed to
prompt field length used QRLMSFAX
Sender Company 40 FROM position 2 100
Sender Tel Number 40 FROM position 3 100
Sender Fax Number – (not used) 100
Sender Cover Page 10 CRTCVRP - can be 10
blank, *NO or *YES;
default is *YES
Subject 40 TITLE 100
Notes 40 COMMENT 100

Server printing and faxing 211

212 Common Server Administration Guide
API and user exit reference
“API reference”
“User exit reference” on page 264

API reference
This section contains reference information about the IBM Content Manager
OnDemand server Application Programming Interfaces (APIs).

The APIs contained in this reference include APIs for various Content Manager
OnDemand functions beyond the standard command set described in “Command
reference” on page 197. The APIs are presented in alphabetical order. Each API
contains a description of its purpose and syntax (including descriptions of the
parameters that can be used). Examples and general information about using the
APIs have also been included.

Important: These APIs require that you be signed on to the server with a user
profile that is also defined as a user in Content Manager OnDemand.
“Using quotes when executing the APIs”
“Using the QSHELL environment”
“Calling QSHELL commands from an IBM i command line” on page 214
“How to read a syntax diagram” on page 215
“ARSDATE” on page 217
“ARSDOC” on page 221
“ARSLOAD” on page 248
“ARSXML” on page 256

Using quotes when executing the APIs

When you execute an IBM Content Manager OnDemand program from the IBM i
command line interactively, in batch using the SBMJOB command or the QSHELL
environment and you specify parameter values that contain a null (blank) character
or some other special character (such as the parenthesis), you must delimit the
parameter value with double quote characters. For example, when executing the
ARSDOC GET program from the i command line and you specify the -o parameter
to specify one or more application group field names, each field name is enclosed
with parenthesis and the entire string must be surrounded by double quote
characters, for example: -o "(sdate)(student)". See the operating system
documentation for more information about the use of quotes when executing the
APIs. Note that if the same string is included in a parameter file using the -F
parameter on the ARSDOC GET command, it would be enclosed in brackets and
the double quotes are not required, for example: [-o (sdate)(student)].

Using the QSHELL environment

All ARSxxxxxx API programs must be executed using the QSHELL environment.
QSHELL is a command interpreter that allows IBM i to execute AIX commands on
i. These commands can also be run from a script file. More information about
QSHELL can be found at http://publib.boulder.ibm.com/infocenter/iseries/

© Copyright IBM Corp. 1991, 2010 213

 v6r1m0/topic/rzahz/rzahzintro.htm. Option 30 for 5770-SS1 (IBM i) installs the
QSHELL intepreter. The QSHELL environment is started by the QSH or STRQSH
i command.

Multiple ARSxxxxxx programs may be issued in one QSHELL session. After the
completion of a QSHELL command, a $ is displayed. This notifies the user that the
QSHELL command has completed. This does not mean that the command actually
ran successfully and performed the desired function.

All command examples assume that the QSHELL environment has been started
and the ARSxxxxx programs are in a directory specified in the PATH variable. IBM
Content Manager OnDemand places a symbolic link to the commands in the
/usr/bin directory during installation. To exit the QSHELL environment, press the
F3 key.

The -v parameter will provide detailed program logging information. The -u

parameter specifies a valid Content Manager OnDemand user that exists with the
proper authority to perform the functions requested. The -p parameter specifies the
Content Manager OnDemand password for the Content Manager OnDemand user
specified in the -u parameter. The user ID and password are not normally needed
when running these programs in i. By default, the current i user profile and
password are used as the Content Manager OnDemand user ID. If your i user
profile does not exist in Content Manager OnDemand, you must specify a valid
Content Manager OnDemand user ID and password to use these programs.

The -h is the Content Manager OnDemand instance name where the program is to
execute. For the purposes of this document, the administrative user name will be
testadmin, the password will be ondemand and the host name is QUSROND. User
testadmin must have the appropriate authority to perform the function being
requested by the ARSxxxxxx command.

Calling QSHELL commands from an IBM i command line

When executing the ARSxxxxxx programs from an IBM i command line, the i QSH
command is used. When embedded single quotes exist within the program
parameter, they must be doubled. For example:.
QSH CMD('arsdoc get ...... "-i WHERE Account#=''1234567'' "....-u testadmin -p ondemand')

Since the QSHELL environment will log messages to the terminal, you will want to
control this by setting environment variable QIBM_QSH_CMD_OUTPUT. This
variable will control where the messages are logged. This does not interfere with
the messages that get logged to the System Log. The QSHELL environment logging
can be sent to the terminal session, to a file in the IFS directory structure, or you
can choose not to log the messages. The ADDENVVAR, CHGENVVAR,
RMVENVVAR and WRKENVVAR commands can be used to manipulate the
QSHELL environment. The environment parameters can be set for the entire
system and for the job. In most cases, you will not want to change the
environment parameter at the system level, because it will affect all users of
QSHELL on the system.
v Set the job environment to log messages to the terminal
ADDENVVAR ENVVAR(QIBM_QSH_CMD_OUTPUT) VALUE(STDOUT) LEVEL(*JOB)
v Set the system environment to not log messages.
ADDENVVAR ENVVAR(QIBM_QSH_CMD_OUTPUT) VALUE(NONE) LEVEL(*SYS)

214 Common Server Administration Guide

 v Set the job environment to log messages to the a file in the IFS. mydirectory
must exist in the IFS.
ADDENVVAR ENVVAR(QIBM_QSH_CMD_OUTPUT)VALUE('FILE=/mydirectory/QSHELL_output') LEVEL(*JOB)

The following is an example of the messages that might be displayed to the

terminal or logged in the output file.
OnDemand Load Id = >5013-1-0-85FAA-11359-11359<
Loaded 4 rows into the database
Document compression type used - OD77. Bytes Stored = >10240<

Message QSH0005 will be issued in the job log when running the QSH command.
The message text is Command ended normally with exit status &1. The possible
statuses returned are shown in the following table.
Table 12. Message QSH0005 status codes
Status Description
0 Completed Successfully
1 Command Failure
2 Folder does not exist or do not have
authority to folder
3 User ID or Password is not valid. Cannot
establish communication to server
127 Command Not Found
254 No Hits Match Query

How to read a syntax diagram

A syntax diagram shows you how to specify an API program so that the operating
system can correctly interpret what you type.

Read a syntax diagram from left to right and from top to bottom, following the
horizontal line (the main path). If the line ends with an arrowhead, the API syntax
is continued and the next line starts with an arrowhead. Facing arrowheads mark
the end of the API syntax.

When you type an API from the syntax, be sure to include punctuation, such as
commas and equal signs.

Parameters are classified as keywords or variables:

v Keywords represent constants and are shown (in syntax) in uppercase letters;
however, you can enter keywords in either uppercase or lowercase.
v Variables represent names or values you supply and are shown (in syntax) in
lowercase letters; however, you can enter variables in either uppercase or
lowercase unless the syntax directions explicitly state the case restrictions. An
example of a variable is a file name.

A parameter can be a combination of a keyword and a variable.

Required parameters are displayed on the main path.

API and user exit reference 215

  PROGRAM required parameter 

Optional parameters are displayed below the main path.

 PROGRAM 
optional parameter

A stack of parameters, with the first parameter displayed on the main path, shows
that you must choose one of the parameters.

 PROGRAM required choice 1 

required choice 2

A stack of parameters, with the first parameter displayed below the main path,
shows that you can choose one of the parameters.

 PROGRAM 
optional choice 1
optional choice 2

An arrow returning to the left, above the path, shows that items can be repeated
following these conventions:
v If the repeat arrow contains a break, the item can be repeated in a list with the
items separated by blank spaces.

 PROGRAM  repeatable parameter 

v If the repeat arrow contains a comma, the item can be repeated in a list with the
items separated by commas.

 PROGRAM  repeatable parameter 

You can repeat items from parameter stacks following the stack conventions for
required and optional parameters described previously.

Some syntax diagrams contain parameter stacks within other parameter stacks. You
can only repeat items from stacks according to the conventions described
previously. That is, if an inner stack does not have a repeat arrow above it but an
outer stack does, you can choose only one parameter from the inner stack and
combine it with any parameter from the outer stack, and that combination can be
repeated. For example, the following diagram shows that you could combine
parameter choice2a with parameter choice2 and then you can repeat that
combination again (choice2 plus choice2a).

216 Common Server Administration Guide

 ,

 PROGRAM  
parameter choice1
parameter choice2
parameter choice2a
parameter choice2b
parameter choice2c
parameter choice3

Some APIs are preceded by an optional path parameter.

 PROGRAM 
path

If you do not supply the path parameter, the system searches the current directory
for the API. If the API is not in the current directory, the system continues to
search for the API using the directories defined in the PATH environment variable.

Some APIs in this section have several formats that accomplish the same task.
These APIs appear (in syntax) similar to the following:

 PROGRAM FORM1 
PROGRAM FORM2

The description of the API directs you to the correct format to use.

ARSDATE
Purpose
Display the IBM Content Manager OnDemand internal database value for a given
date and time string or display the date and time string for a given Content
Manager OnDemand internal database value.

Syntax
-a
 arsdate -g 
-i -h hours -n minutes -s seconds
-t
-z

 
-d days -m months -y years -f ″ format ″

API and user exit reference 217

   
internalValue
″ dateString ″

Description
The ARSDATE program can be used to display the IBM Content Manager
OnDemand internal database value for a given date and time string or display the
date and time string for a given Content Manager OnDemand internal database
value.

Values whose data types are Date, Time, Date/Time, or Date/Time (TZ) are
represented in an internal form that is transparent to the casual user of Content
Manager OnDemand. Casual users enter date and time values the same way that
they appear in a report. However, to search the database with an SQL string, a
user must enter the internal form of the value. The ARSDATE program lists the
internal value of a date or time string.

Parameters
-a Use to display database values and date strings for Date fields. For
example, to display the database value for the date 9/1/99, enter:
arsdate -a 9/1/99

The ARSDATE program returns:

9/1/99 -> 10836

To display the date string for the database value 10836 in the default date
format, enter:
arsdate -a 10836

The ARSDATE program returns:

10836 -> 9/1/99
-i Use to display database values and date and time strings for Date/Time
fields. The time part of a Date/Time field is not adjusted for the local time
zone. You typically use the -i parameter to find out one of two things:
v Given a date and time printed on a report, what value did Content
Manager OnDemand store in a Date/Time database field? You can use
the result to search a Date/Time field with an SQL string.
v Given a value stored in a Date/Time database field, what would be the
date and time printed on a report?
-t Use to display database values and time strings for Time fields. The time is
not adjusted for the local time zone. For example, to display the database
value for the time 04:00:00, enter:
arsdate -t 04:00:00

The ARSDATE program returns:

04:00:00 -> 4800

To display the time string for the database value 4800, enter:
arsdate -t 4800

218 Common Server Administration Guide

 The ARSDATE program returns:
4800 -> 04:00:00
-z Use to display database values and date and time strings for Date/Time
(TZ) fields. The time part of a Date/Time (TZ) field is adjusted for the
local time zone. If you run the ARSDATE program with the -z parameter
on systems in different time zones and you specify the same date and time
value, the result will be different. For example, suppose that you need to
determine the value stored in a Date/Time (TZ) field for ″09/01/00
04:00:00″. The command:
arsdate -z "09/01/00 04:00:00"

When run on a server in the Eastern time zone will return:

09/01/00 04:00:00 -> 936187200

If you run the same command on a server in the Mountain time zone, then
result will be:
09/01/00 04:00:00 -> 936180000

A typical use of the -z parameter is to determine a database value with

which to search the system log. You can use the result to search the
Date/Time (TZ) field of the system log with an SQL string. For example,
suppose a user in New York logs on to a server in Denver. To retrieve the
log on messages with an SQL string, you must specify the date and time
part of the query using the local time of the client that is running the
query. If the user logged on to the server at 4 a.m. Eastern time, then a
query that is run in Denver must specify 2 a.m. to retrieve the message.
-g Display the current system date.
-d days
Add the specified number of days to the specified internal value.
-h hours
Add the specified number of hours to the specified internal value.
-m months
Add the specified number of months to the specified internal value.
-n minutes
Add the specified number of minutes to the specified internal value.
-s seconds
Add the specified number of seconds to the specified internal value.
-y years
Add the specified number of years to the specified internal value.
-f ″format″
Determines the format of the date and time string that Content Manager
OnDemand displays.
Table 13 on page 220 lists the standard date and time formats that are
supported by Content Manager OnDemand. If the input data contains a
date or time format that is not listed in the table, you can specify the
format to Content Manager OnDemand. However, when specifying a
format, you can only use values and separators from the standard formats
that are listed in the table. Date and time formats may also be specified on
the Load Information page in the application and the Field Information
page in the folder.

API and user exit reference 219

 The format consists of a set of values (for example, %m) and separators
(such as the blank character). Some of these formats may require the
removal of leading or imbedded blanks, or other characters.
Table 13. Date and time format specifications
Date Format Specifier Date Format Example
%m/%d/%y mm/dd/yy 01/31/95
%d/%m/%y dd/mm/yy 31/01/95
%f/%e/%y m/d/yy 1/31/95
%e/%f/%y d/m/yy 31/1/95
%m-%d-%y mm-dd-yy 01-31-95
%d-%m-%y dd-mm-yy 31-01-95
%m%d%y mmddyy 013195
%m%d%Y mmddyyyy 01311995
%y%m%d yymmdd 950131
%Y%m%d yyyymmdd 19950131
%b %e, %Y Mth d, yyyy Jan 31, 1995
%B %e, %Y Month d, yyyy January 31, 1995
%m/%d/%y %H:%M mm/dd/yy hh:mm 01/31/95 10:50
%H:%M hh:mm 10:50
%T hh:mm:ss 10:50:59

Important: Alpha dates, for example, the Mth (%b) and Month (%B)
formats are supported for English only. In other words, you must only use
those formats for months specified in English, such as Jan or January.
internalValue
The internal date and time value from the Content Manager OnDemand
database. Enter one or more internal values when you want to display
formatted date strings.
″dateString″
The date and time string. Enter one or more strings when you want to
display internal date values.

Examples
1. The following example shows how to determine the database value for the
specified date and time string. The data type of the database field is Date/Time.
arsdate -i "09/01/99 04:00:00"

09/01/99 04:00:00 -> 936158400

In the example, you could use the database value to search a Date/Time field
in the database with an SQL string. For example:
arsdoc get -i "WHERE somedate=936158400" ...
2. The following example shows how to determine the date and time string for
the specified database value. The data type of the database field is Date/Time.
The result is shown using the default display format.
arsdate -i 936158400

936158400 -> 09/01/99 04:00:00

220 Common Server Administration Guide

 3. The following example shows how to determine the database value for the
specified date and time string. The data type of the database field is Date/Time
(TZ). The ARSDATE program adjusts the time part of the result for the local
time zone.
arsdate -z "09/01/99 04:00:00"

09/01/99 04:00:00 -> 936180000

If you were to run the same command on a server in the Eastern time zone, the
result would be:
arsdate -z "09/01/99 04:00:00"

09/01/99 04:00:00 -> 936187200

Notes
1. When displaying the date string for a given internal value, by default, the
ARSDATE program displays the date string using the mm/dd/yy format. If you
want the ARSDATE program to display the date string using a different format,
then you must specify the date format with the -f parameter. For example:
arsdate 10907

10907 -> 11/11/99

arsdate -f "%m/%d/%Y" 10907

10907 -> 11/11/1999

2. When displaying the internal value for a given date string, by default, the
ARSDATE program expects you to specify the date string using the mm/dd/yy
format. If you want to specify the date string using a different format, then you
must specify the date format with the -f parameter. For example:
arsdate 11/12/99

11/12/99 -> 10908

arsdate 11/12/1999

11/12/1999 -> -1 (Error)

arsdate -f "%m/%d/%Y" 11/12/1999

11/12/1999 -> 10908

3. The upper limit of the date is September 17, 2059. To format the output for a
date, specify the -f parameter as follows:
arsdate -f "%m/%d/%Y" 32767
32767 -> 09/17/2059

IFS Location
/usr/bin/arsdate
The IBM i executable program.

ARSDOC
Purpose
The ARSDOC program is a multi-purpose document processing program. You can
use the ARSDOC program to query the database and generate a list of items that
match a query, retrieve documents from the system, add, delete, and update
documents, and send documents to a server printer.

API and user exit reference 221

 Description and syntax
The ARSDOC program provides the following functions:
v ADD
v DELETE
v GET
v PRINT
v QUERY
v UPDATE
| v HOLD_ADD
| v HOLD_RELEASE
| v CFSOD-FED
For each function, you can specify all of the required options on the command line
or you can specify the name of a parameter file that contains the options. The
syntax of each function is listed twice: first, when you specify the options on the
command line; second, when you specify a parameter file.

ADD function:

Use to store data into the system by specifying the folder, application group,
application, and database fields and values.

Important: Set the proper locale before issuing the ARSDOC ADD API. See the
chapter entitled “Defining a locale” in the IBM Content Manager OnDemand for i
Common Server Planning and Installation Guide for important details.
If you specify the -O parameter, then you do not have to specify all of the database
fields (however, you must always specify date and time fields).When you specify
the -O parameter, the ARSDOC program stores a default value in any database
field that you omit. The default value for string fields is an empty string. The
default value for numeric fields is 0 (zero). Numeric fields include integer and
decimal (floating point) fields. When adding a document, you can specify the data
in one of three ways:
v A document file
v An SQL query that contains clauses, database field names, index values, and
operators
v A public named query

When you specify an SQL query or public named query, you are creating a
database row that points to an existing document that has been identified by the
query.

| When you use the ADD function to add a row for an existing document, the row
| must be added to the application group and the application that contain the
| document. The application must be specified with the -a parameter. The
| application group must be specified with the -g parameter and must be one of the
| application groups referenced by the folder named with the -f parameter.

Important: The ADD function will fail unless the Database Organization for the
application group named with the -g parameter is Multiple Loads per Database
Table and the Expiration Type is Segment or Document.

222 Common Server Administration Guide

  arsdoc add -a application -g applGroup 
-f folder -G applGroup

 -h instance  -n dbfield=value 
-i sqlQuery -O
-o docfilename
-q namedQuery

 
-p password -S startdate,enddate -u userid
, format

|  
-U user_alias -v

When you use the parameter file option, you must specify the -F, -h, -p, -u, -U,
and -v parameters on the command line. All other parameters must be specified in
the parameter file. The following diagram shows the syntax of the ADD function
when you use the parameter file option:

 arsdoc add -F parmfile -h instance 

-p password -u userid

 
-v

The syntax of the parameter file for the ADD function is:

 [ -a application ] [ -f folder ] [ 
-g applGroup
-G applGroup
]

  [ -n dbfield=value ] 
[ -i sqlQuery ] [ -O ]
[ -o docfilename ]
[ -q namedQuery ]

 
[ -S startdate,enddate ]
, format

DELETE function:

API and user exit reference 223

 Use to delete index records that point to individual documents in IBM Content
Manager OnDemand. The data will still exist on disk or archive media, because the
documents being deleted might represent only a few pages of an entire input file.
However, the data will no longer be retrievable after the index records are deleted.

To identify the documents that you want to delete index records, you must enter
an SQL query or specify the name of a public named query. The SQL query must
contain clauses, database field names, index values, and operators. The DELETE
function deletes index records for all documents that match the query.

If you want to delete an entire input file (load) of documents (such as an entire
spooled file) from Content Manager OnDemand, use the Remove Report from
OnDemand (RMVRPTOND) command instead of ARSDOC DELETE.

 arsdoc delete -h instance 

-f folder -G applGroup

 -i sqlQuery 
-q namedQuery -p password

|  
-S startdate,enddate -u userid -U user_alias
, format

 
-v

When you use the parameter file option, you must specify the -F, -h, -p, -u, -U,
and -v parameters on the command line. All other parameters must be specified in
the parameter file. The following diagram shows the syntax of the DELETE
function when you use the parameter file option:

 arsdoc delete -F parmfile -h instance 

-p password

 
-u userid -v

The syntax of the parameter file for the DELETE function is:

 [ -f folder ] [ -i sqlQuery ] 
[ -G applGroup ] [ -q namedQuery ]

 
[ -S startdate,enddate ]
, format

GET function:

Use to retrieve documents and resources from the system. The GET function can
also generate and save generic index data for the documents that match the query.
You must identify the name of the IBM Content Manager OnDemand library
server. You specify the application group or folder that you want to search. To
query the database, you can enter an SQL query or specify the name of a public
named query. The SQL query must contain clauses, database field names, index
values, and operators. By default, the ARSDOC program sends a copy of the
224 Common Server Administration Guide
 documents that match the query to the display (interactive) or the job log (batch).
You can also choose to write the output to a file. To retrieve documents in a sorted
order, you must specify the -n parameter.

|  arsdoc get 
-a [ -A value ] -c -d directory

 -h instance -i sqlQuery 
-f folder -g -G applGroup -q namedQuery

|  
-l holdname -L max# -n -N -o name

 
-p password -P -Q SQLqueryfile -s seconds

|  
-S startdate,enddate -u userid -U user_alias
, format

 
-v -x loadId -X loadId

When you use the parameter file option, you must specify the -F, -h, -p, -u, -U,
and -v parameters on the command line. All other parameters must be specified in
the parameter file. The following diagram shows the syntax of the GET function
when you use the parameter file option:

 arsdoc get -F parm_file -h instance 

-p password -s seconds

 
-u userid -v

The syntax of the parameter file for the GET function is:

|  
[ -a ] [ -A value ] [ -c ] [ -d directory ]

 [ -f folder ] 
[ -g ] [ -G applGroup ]

 [ -i sqlQuery ] 
[ -q namedQuery ] [ -L max# ] [ -n ] [ -N ]

 [ -o name ] 
[ -S startdate,enddate ]
, format

 
[ -x loadId ] [ -X loadID ]

PRINT function:

Use to send documents to an IBM Content Manager OnDemand server printer. You
must name the Content Manager OnDemand library server and the folder that you
want to search and specify the query to run. The items that match the query are

API and user exit reference 225

 sent to the server printer named with the -P parameter. The server printer must be
defined to Content Manager OnDemand using the administrative client. To query
the database, you can enter an SQL query or specify the name of a public named
query. The SQL query must contain clauses, database field names, index values,
and operators. You can limit the number of documents sent to the printer by using
the -L parameter and specifying the maximum number of documents that should
be retrieved, regardless of the number of documents that match the query. You can
limit the number of database tables searched, and possibly increase the
performance of a query, by specifying the -S parameter and specifying a start date
and an end date. The PRINT function does not currently support server FAX.

 arsdoc print -h instance 

-f folder -G applGroup

|  -i sqlQuery 
-q namedQuery -l holdname -L max# -p password

 -P printer 
-S startdate,enddate -u userid
, format

|  
-U user_alias -v [ -X loadID ]

When you use the parameter file option, you must specify the -F, -h, -p, -u, -U,
and -v parameters on the command line. All other parameters must be specified in
the parameter file. The following diagram shows the syntax of the PRINT function
when you use the parameter file option:

 arsdoc print -F parmfile -h instance 

-p password -u userid

 
-v

The syntax of the parameter file for the PRINT function is:

 [ -f folder ] [ -i sqlQuery ] 
[ -G applGroup ] [ -q namedQuery ]

 [ -P printer ] 
[ -L max# ]

 
[ -S startdate,enddate ]
, format

QUERY function:

By default, the ARSDOC program sends the list of items that match the SQL query
to the SQL query to the display (interactive) or the job log (batch). You can also
choose to write the output to a file.

 arsdoc query 
-d directory -D -e delimiter -f folder

226 Common Server Administration Guide

  -h instance -i sqlQuery 
-G applGroup -H -q namedQuery -I

|  
-l holdname -L max# -n

-N ″  ( dbfield ) ″

 
-o outputFile -S startdate,enddate
, format

|  
-p password -u userid -U user_alias -v -x loadId

 
-X loadId

When you use the parameter file option, you must specify the -F, -h, -p, -u, -U,
and -v parameters on the command line. All other parameters must be specified in
the parameter file. The following shows the syntax of the QUERY function when
you use the parameter file option:

 arsdoc query -F parm_file -h instance 

-p password

 
-u userid -v

The syntax of the parameter file for the QUERY function is:

 
[ -d directory ] [ -D ] [ -e delimiter ]

 [ -f folder ] 
[ -G applGroup ] [ -H ]

 [ -i sqlQuery ] 
[ -q namedQuery ] [ -I ] [ -L max# ] [ -n ]

 
[ -o outputFile ]

[ -N  ( dbfield ) ]

 
[ -S startdate,enddate ] [ -x loadId ]
, format

 
[ -X loadID ]

UPDATE function:

Use to update documents. You must name the application group to update and
specify one or more application group fields and their values. To identify the
documents that you want to update, you must enter an SQL query or specify the

API and user exit reference 227

 name of a public named query. The SQL query must contain clauses, database field
names, index values, and operators. The UPDATE function updates all of the rows
that match the query. It does not change the actual document data.

 arsdoc update -g applGroup -h instance 

-f folder -G applGroup

 -i sqlQuery f p  -n dbfield=value 
-q namedQuery -p password

|  
-S startdate,enddate -u userid -U user_alias
, format

 
-v

When you use the parameter file option, you must specify the -F, -h, -p, -u, -U,
and -v parameters on the command line. All other parameters must be specified in
the parameter file. The following shows the syntax of the UPDATE function when
you use the parameter file option:

 arsdoc update -F parm_file -h instance 

-p password

 
-u userid -v

The syntax of the parameter file for the UPDATE function is:

 [ -f folder ] [ [ -i sqlQuery ] 
-g applGroup [ -q namedQuery ]
-G applGroup
]

  [ -n dbfield=value ] 
[ -S startdate,enddate ]
, format

| HOLD_ADD function:

| Use to add documents to a hold. Use an SQL string or Named Query to query the
| database and determine the documents to add to the hold.

228 Common Server Administration Guide

| Ensure that enhanced retention management is turned on for the application group
| and you have permission to add documents to a hold before you attempt this
| function. Otherwise, a permission error will occur.

| If a duplicate attempt is made to add the same documents to a hold, no error

| occurs, and ARSDOC displays a successful message. However, the system log
| might contain messages that indicate that the documents were already added.

|  arsdoc hold_add -h instance 

| -f folder -G applGroup

|  -i sqlQuery -l holdname 
| -q namedQuery -p password

|  
| -S startdate,enddate -u userid -U user_alias
, format

|  
| -v
|

| When you use the parameter file option, you must specify the -f, -h, -p, -u, -U, and
| -v parameters on the command line. All other parameters must be specified in the
| parameter file. The following diagram shows the syntax of the hold_add function
| when you use the parameter file option:

|  arsdoc hold_add -F parmfile -h instance 

| -p password

|  
| -u userid -v
|
| The syntax of the parameter file for the hold_add function is:

|  [ -f folder ] [ -i sqlQuery ] 
| [ -G applGroup ] [ -q namedQuery ]

|  
| [ -S startdate,enddate ]
, format
|

| HOLD_RELEASE function:

| Use to remove documents from a hold. You can query the database by using an
| SQL string or Named Query to determine the documents that should be removed
| from a hold.

| If you selected the option in the application group to use implied hold, documents
| are placed on hold as soon as they are loaded, and there is not a hold name that is
| associated with the documents that are placed on hold. To remove documents from
| an implied hold, specify IMPLIED_HOLD as the hold name.

| Ensure that enhanced retention management is turned on for the application group
| and you have permission to release documents from a hold before you attempt this
| function. Otherwise, a permission error will occur.

API and user exit reference 229

| If a duplicate attempt is made to remove the same documents from a hold, no
| error occurs, and ARSDOC displays a successful message. However, the system log
| might contain messages that indicate that the documents were already released.

|  arsdoc hold_release -h instance 

| -f folder -G applGroup

|  -i sqlQuery -l holdname 
| -q namedQuery -p password

|  
| -S startdate,enddate -u userid -U user_alias
, format

|  
| -v
|

| When you use the parameter file option, you must specify the -f, -h, -p, -u, -U, and
| -v parameters on the command line. All other parameters must be specified in the
| parameter file. The following diagram shows the syntax of the hold_release
| function when you use the parameter file option:

|  arsdoc hold_release -F parmfile -h instance 

| -p password

|  
| -u userid -v
|
| The syntax of the parameter file for the hold_release function is:

|  [ -f folder ] [ -i sqlQuery ] 
| [ -G applGroup ] [ -q namedQuery ]

|  
| [ -S startdate,enddate ]
, format
|

| CFSOD-FED function:

| Sends documents to CFS-OD and make them available to IBM FileNet P8 features.
| You can use an SQL string or Named Query to determine the documents to be sent
| to CFS-OD.

| To enable the CFS-OD feature, add the following line to the ars.cfg file:
| ARS_SUPPORT_CFSOD=1

| Ensure that the CFS-OD function is turned on for the application group and you
| have permission to use CFS-OD before you attempt this function. Otherwise, a
| permission error will occur.

| If a duplicate attempt is made to send the same documents to CFS-OD, no error

| occurs, and ARSDOC displays a successful message. However, the system log
| might contain messages that indicate that the documents were already sent to
| CFS-OD.

230 Common Server Administration Guide

|  arsdoc cfsod_fed -h instance 
| -f folder -G applGroup

|  -i sqlQuery 
| -q namedQuery -p password

|  
| -S startdate,enddate -u userid -U user_alias
, format

|  
| -v
|

| When you use the parameter file option, you must specify the -f, -h, -p, -u, -U, and
| -v parameters on the command line. All other parameters must be specified in the
| parameter file. The following diagram shows the syntax of the cfsod_fed function
| when you use the parameter file option:

|  arsdoc cfsod_fed -F parmfile -h instance 

| -p password

|  
| -u userid -v
|
| The syntax of the parameter file for the cfsod_fed function is:

|  [ -f folder ] [ -i sqlQuery ] 
| [ -G applGroup ] [ -q namedQuery ]

|  
| [ -S startdate,enddate ]
, format
|

| Parameters
-a For the GET function, when retrieving AFP documents, specify this
parameter to include resources with the documents that are retrieved. If
documents from the same application have different resource groups, then
the ARSDOC program creates separate output files for each resource
group.
For the ADD function, you must specify the name of the IBM Content
Manager OnDemand application. The application must belong to the
application group named with the -g (or -G) parameter.
| -A value
| Use this parameter to retrieve annotations. The following are the basic
| values of this parameter:
| 0 Include public text annotations
| 1 Include private annotations
| 2 Include annotations that cannot be copied to another server
| 4 Include graphic annotations
| You can also add up two or more of the basic parameter values to create
| new values. For example:

API and user exit reference 231

| 3 Retrieve all public and private text annotations
| 5 Retrieve public and private annotations (text and graphic) that can
| be copied to another server
| 6 Retrieve all public annotations (text and graphic)
| 7 Retrieve all text and graphic annotations
| Table 14. Possible values for the ARSDOC GET function -A parameter
| Can be Cannot be
| Flag value Public Text copied Private copied Graphic
| -A 0 X X X
| -A 1 X X X X
| -A 2 X X X X
| -A 3 X X X X X
| -A 4 X X X X
| -A 5 X X X X X
| -A 6 X X X X X
| -A 7 X X X X X X
|
| See “Examples” on page 243 for examples of using the -A parameter with
| the ARSDOC GET function.
| Do not use the -A parameter with the -X parameter. When you use the -X
| parameter, all of the documents in a load are retrieved. The documents in
| the load are identified by an index file that was created when the data was
| loaded. When the documents were loaded, no annotations existed.
| Therefore, no annotation information exists in the index file for the
| documents, and you cannot retrieve annotations by using this method.
-c For the GET function, use to concatenate all of the documents that match
the query into one output file. Name the output file with the -o parameter.
However, even if you do specify the -c parameter, the ARSDOC program
creates separate output files when any of the following conditions occur:
v If more than one application group is referenced by the folder. The
ARSDOC program creates one output file for each application group
that contains items that match the query.
v If more than one application is contained in an application group. The
ARSDOC program creates one output file for each application that
contains items that match the query.
v If documents from the same application have different resource groups,
the ARSDOC program creates separate output files for each resource
group.
For example, if a folder references two application groups, then the
following specification:
-o student -c
Can result in file names such as: student.516 or student.517
Where 516 and 517 are application group identifiers. One file is created for
each application group. Each file contains all of the items that match the
query for that particular application group.
| If you have difficulty viewing documents that are retrieved in the same
| file, retrieve the documents as individual documents.

232 Common Server Administration Guide

-d directory
The name of the directory where the ARSDOC program writes the output
files. The directory must exist before the ARSDOC program attempts to
save the output files.
-D For the QUERY function, appends the document handle information to the
end of each line. The document handle information consists of the
following ten values, in the order listed:
1. Document name
2. Offset
3. Length
4. Compressed object offset
5. Compressed object length
6. Annotation type
7. Compression type
8. Resource ID
9. Primary node ID
10. Secondary node ID
The values are separated by a delimiter. The default delimiter is the
comma character. You can specify a different delimiter with the -e
parameter.
-e delimiter
For the QUERY function, specifies a one character delimiter to use as a
separator between values. By default, Content Manager OnDemand
separates values in the output with a comma.
-f folder
The name of the Content Manager OnDemand folder. The folder name
must be specified exactly as it appears in Content Manager OnDemand.
The case of the folder name is significant. For example, to query the
System Log folder, you must enter:
-f "System Log"

If you are using a parameter file, then you must specify the -f parameter in
the parameter file. If you are not using a parameter file and you do not
specify the -f parameter, then the ARSDOC program prompts you for the
folder name when you run the program.
For the GET and QUERY functions, you can omit the -f parameter and
specify the -G parameter to search a specific application group.
For the UPDATE function, if the folder that is specified with the -f
parameter contains only one application group, then you can omit the -g or
-G parameter (you do not have to specify the name of the application
group).
When you specify the -X parameter, you cannot specify the -f parameter.

Note: The following information applies only when an application group

name is not provided.

A folder can be used to search one or more application groups. Because the
ARSDOC program generates a single SQL query to search all of the
application groups, the properties of the database fields must be the same
for each application group. The properties include the field name, type,

API and user exit reference 233

 and length. For example, suppose that you define the following application
groups and fields:

Application Group Field Names

Student Bills name, account, billDate
Student Grades name, account, gradeDate
Student Transcripts name, account, transcriptDate

You cannot query the application groups using the ARSDOC program
because the name of the date field is not the same for each application
group. However, if you were to define the application groups and fields as
follows:

Application Group Field Names

Student Bills name, account, studentDate
Student Grades name, account, studentDate
Student Transcripts name, account, studentDate

Then you could query the application groups using the ARSDOC program
because the names of the database fields are the same for each application
group.
-F parmFile
Specifies the name of the file that contains the actions to run and other
parameters, values, and options. You typically specify this option when
you want to perform more than one action.
Ensure that you enclose the parameters and values that are specified in the
parameter file in the left and right brackets, that is, [ and ]. The left and
right brackets are used to identify each parameter in the file, and are
required in the parameter file.

Important: In the parameter file, the parameter values cannot contain the
left or right bracket.
Here is an example of using the ARSDOC program with the -F parameter:
arsdoc get -u oduser -p odpasswd -h odhost -F parmfile -v
Here is an example of the parameter values in the above parameter file:
[-f "Credit Card Statements"][-i "where account = '000-000-000'"]
[-a][-o credit.out]
An action (one or more input lines) can contain a maximum of 32767
characters (bytes).
You can use the \ (backslash) character to continue the parameters of an
action to two or more lines.
A parameter file can contain blank lines and comment lines. A comment
line contains the # character in the first column.
-g For the GET function, use to generate Generic indexer data for the items
that match the query.
See the IBM Content Manager OnDemand for i Common Server: Indexing
Reference for details about the Generic indexer.
When you specify the -g parameter, you must specify the -c, -N, and -o
parameters. However, you cannot specify database field names with the -o
parameter.

234 Common Server Administration Guide

 The ARSDOC program uses the following convention to name the output
files that are generated with the -g parameter:
-o.res_id.appl_group.appl.type
Where:
v -o is the value specified with the -o parameter
v res_id is the resource group identifier.
v appl_group is the name of the application group
v appl is the name of the application
v type is the file type:
– out identifies a document file
– ind identifies a generic index file
– res identifies a resource file
In general, the number of files generated is dependent on the number of
application groups in a folder, the number of applications in an application
group, and the number of versions of resource groups in an application.
For the ADD and UPDATE functions, specifies the name of the Content
Manager OnDemand application group. The application group that you
specify will be searched from the folder that is named with the -f
parameter. For the UPDATE function, if the folder that is specified with the
-f parameter contains only one application group, then you can omit the -g
parameter (you do not have to specify the name of the application group).
-G applGroup
Use to specify the name of the application group.
For UPDATE: If the folder that is specified with the -f parameter contains
only one application group, then you can omit the -G parameter (you do
not have to specify the name of the application group).
For ADD: When the database query is run to retrieve the document that
contains the data that is to be used in the add function, the search is
limited to the specified application group, even if the folder named with
the -f parameter can be used to search more than one application group.
This ensures that only documents in the specified application group can be
used for the add function. You can specify the name of the application
group with the -g parameter or the -G parameter.
For DELETE: The -G parameter is an optional parameter. If specified, then
the database query that is run to determine the document(s) to delete is
limited to the specified application group. The addition of the -G
parameter allows you to delete documents from a specific application
group in folders that can search more than one application group. If you
do not specify the -G parameter, then the query runs against all of the
application groups that can be searched from the folder.
For GET: Specifies the application group to query and retrieve documents
from. The -G parameter lets you retrieve documents from a specific
application group from a folder that can search more than one application
group. If you do not specify the -G parameter, then the query runs against
all of the application groups that can be searched from the folder. You can
omit the -f parameter and specify the -G parameter to search a specific
application group. The -G parameter is required if you specify the -X
parameter.

API and user exit reference 235

 For PRINT: The -G parameter is an optional parameter. If specified, then
the database query that is run to determine the document(s) to print is
limited to the specified application group. The addition of the -G
parameter allows you to print documents from a specific application group
in folders that can search more than one application group. If you do not
specify the -G parameter, then the query runs against all of the application
groups that can be searched from the folder.
For QUERY: Specifies the application group to search. The -G parameter
lets you search a specific application group from folders that can search
more than one application group. If you do not specify the -G parameter,
then the query runs against all of the application groups that can be
searched from the folder. You can omit the -f parameter and specify the -G
parameter to search a specific application group. The -G parameter is
required if you specify the -X parameter.
For UPDATE: When the database query is run to determine the
document(s) to update, the search is limited to the specified application
group, even if the folder named with the -f parameter can search more
than one application group. This guarantees that only documents in the
specified application group can be updated. You can specify the name of
the application group with the -g parameter or the -G parameter.
You can use the -G parameter with the -i parameter to query folders that
can search more than one application group. For example, a folder contains
three application groups; you want to query only one of the application
groups. Use the -G parameter to specify the name of the application group
that you want to query. Use the -i parameter to specify the application
group’s database field names. You can also use the -G and -i parameters
when the application groups have different database field names. The
following example shows how to search a folder and three application
groups that have different database field names:
arsdoc get -f "Student Information" -G loans
-i "WHERE number LIKE '123456' AND loanDate = 10593"
arsdoc get -f "Student Information" -G grades
-i "WHERE number LIKE '123456' AND gradeDate = 10593"
arsdoc get -f "Student Information" -G transcripts
-i "WHERE number LIKE '123456' AND transDate = 10593"
You can use the -G parameter with the -q parameter to query folders that
can search more than one application group. When you specify the -G
parameter and you specify a public named query with the -q parameter,
the ARSDOC program queries the application group named with the -G
parameter instead of the application group specified in the named query.
(If you do not specify the -G parameter, then the query runs against the
application group specified in the named query. If the named query does
not identify an application group, then the query runs against all of the
application groups that can be searched from the folder.)
-h instance
The name of the Content Manager OnDemand instance to process.
This is a required parameter.

Important: If you are running multiple instances of Content Manager

OnDemand on the same workstation, always specify the -h parameter to
identify the name of the instance that you want to process. Verify that the
system is configured with the correct information for all instances of
Content Manager OnDemand.

236 Common Server Administration Guide

 See IBM Content Manager OnDemand for i Common Server Planning and
Installation Guide for information on configuring instances.
-H For the QUERY function, specify this parameter to generate a header
record in the output. The default header record contains the application
group field names. This parameter also generates a line that contains the
names of the database fields. By default, the field names are delimited with
the comma character. You can specify a delimiter of your choice with the -e
parameter.
You can use the -H parameter to generate output that contains only the
application group database field names. To do so, specify the -H parameter
without specifying the -i or -q parameters. (You also must not specify the
-L, -n or -N parameters.)
The ARSDOC program writes the database field names to the specified
output file, or to the display (interactive) or the job log (batch).
-i sqlQuery
A valid SQL query, that includes the names of one or more application
group database fields, index values, and operators. Content Manager
OnDemand does not validate the string that you specify. See the SQL
reference for your database manager product for an overview of SQL
concepts and details about how to construct a query.

Restriction: If you specify the -q or the -X parameters, then you cannot

specify the -i parameter.
For the DELETE or UPDATE functions, if more than one document meets
the search criteria, then multiple documents will be deleted or updated.
For an update, all of the documents will be updated with the same values.
To construct a query with a database field of type date, you must use the
Content Manager OnDemand internal format of the date. That is, the
number of days since January 1, 1970. You can use the ARSDATE program
to list the internal format for a given date string. For example, the
following shows how to use the ARSDATE program to obtain the internal
date for July 21, 1995:
arsdate -a 7/21/95
The ARSDATE program displays:
7/21/95 -> 9333
You would then enter 9333 as the index value for the date field.
-I For the QUERY function, this parameter appends the Load ID to each line.
The Load ID is separated from the database field values by a delimiter. The
default delimiter is the comma character. You can specify a different
delimiter with the -e parameter. You cannot specify the -H, -n, or -N
parameters when you specify the -I parameter.
When you specify the -I parameter, you must also use either the f or p
value:
v Using the f value specifies that the System Log is searched for a
message containing the Load ID for each document in the list. If the
Load ID is found, the Load ID is added to the line containing the other
requested information for the document. If the Load ID is not found,
Load ID could not be found is appended to the line. Use the f value if
you need the exact load ID. Be aware that using this option can take a
long time, as it requires searching the system log.

API and user exit reference 237

 v Using the p value specifies that the system log will not be searched.
Instead, a load ID is built based on the information for the document
contained in the database. This load ID might not match the exact value
of the actual load ID, because the last two fields in the load ID are
internal date representations for the first and last dates in the documents
that are loaded. Using the p value is faster than using the f value, but
does not provide exact load IDs.
To use the -I parameter with the f parameter, the user running the query
must have permission to access the System Log application group and
folder.
If you use the f parameter and the Load ID is not found in the system log,
then the string Load ID could not be found is appended to the end of the
output record.
-l holdname
| For the GET, QUERY, PRINT, HOLD_ADD, and HOLD_RELEASE
| functions, this parameter specifies the hold name. Do not specify this
| parameter when you specify the -X parameter. Do not specify this
| parameter if only database names are specified. Specifying the hold name
| limits the list of returned hits to only those hits that have been added to
| the specified hold. For example, an SQL query or a Named Query
| produces 10 hits. If 2 of the 10 hits have been added to a hold and the
| hold name is provided, the result contains only the two hits that are
| included in the hold.
-L max#
For the GET and PRINT functions, determines the maximum number of
items retrieved from Content Manager OnDemand, regardless of the
number of items that match the query.
For the QUERY function, determines the number of items included in the
hit list, regardless of the number of items that match the query.
-n For the GET function, use to retrieve items one at a time from the server.
By default, the ARSDOC program uses a bulk retrieval method for
high-speed retrieval of items from the server.

| Important: The –n parameter is required when you work with data whose
| indexes are migrated from Spool File Archive and is still managed by
| Spool File Archive by using the Report Management Cycle (RMC).

Tip: Specify the -n parameter if a sort order has been defined in the
folder and it is a requirement that the documents be retrieved in the order
specified by the sort order. For more information about the sort order, see
the online help on the Field Information page for the folder.
For the QUERY function, use to number the items in the output file. If you
specify this option, the ARSDOC program sequentially numbers each line
in the output file, beginning with 1 (one).
For the ADD and UPDATE functions, use to specify the application group
database field names and their values using the form -n dbfield=value.
v Specify a null (blank) field value by using single quotes within double
quotes. For example: -n middle="''"
v Specify a string field value that contains a null (blank) or other special
character by enclosing the field value in single quotes within double
quotes. For example: -n name="'Sally Smith'"

238 Common Server Administration Guide

 You can specify one or more field names and their values (by specifying
the -n parameter one time for each database field name and its value).
When adding a document, you must specify all of the application group
fields unless you specify the -O parameter. When updating a document,
you can specify one or more fields and their values. For a date field, you
must specify the value using the Display Format from the Field
Information page under folders.
-N ″(dbfield1)(dbfield2)(dbfieldn)″
For the QUERY function, specify the order and names of the database
fields to include in the output. For the GET function, when querying a
folder that searches more than one application group or a folder that
searches an application group that contains more than one application,
specify this parameter to add the resource identifier, application group
name, and application name to the output file name. When you specify the
-N parameter, you must specify the -c parameter. If you specify the -g
parameter to generate generic index data, you must specify the -N
parameter.
If the folder searches more than one application group or an application
group contains more than one application and you do not specify the -N
parameter, then the ARSDOC program adds the application group or
application identifier to the output file name. For example, the following
specification:
-o student -c
Can result in output file names such as: student.516 or student.517
Where 516 and 517 are application group identifiers. However, when you
specify the -N parameter, the ARSDOC program uses the resource
identifier, application group name, and application name to name the
output file. For example, the following specification:
-o student -c -N

Can result in output file names such as: student.1.BILLS.1995 or

student.1.BILLS.1996
Where 1 is the resource identifier, BILLS is the application group name, and
1995 and 1996 are application names.
The number of index files created is dependent on the number of
application groups in a folder, the number of applications in an application
group, and the number of resource groups in an application.
For the QUERY function, determines the application group fields that the
ARSDOC program writes to the output file and the field names that
appear in the header record. By default, the ARSDOC program writes all
fields to the output file. You can specify one or more application group
field names using the form -N(dbfield)...(dbfield). Each field name that you
specify must be delimited with parenthesis. When you run a query from
the command line, you must delimit the entire string in double quote
characters. For example, -N″(dbfield)...(dbfield)″.
-o name
For the GET function, use to write documents to one or more files and
identify a user-defined string used to generate unique file names. For
example, the following specification:
-o student -c

API and user exit reference 239

 Can result in the following output file name: student

You can concatenate one or more of the database field names that you
specify with the -i parameter to generate a unique file name. For example,
the following specification:
-o "(sdate)(student)"
-i "WHERE sdate='971025' AND student='001200340056'"

Can result in the file name: 971025.001200340056

When you use database field names to generate a unique file name:
v Content Manager OnDemand verifies that the field names that you
specify are valid for the application groups that can be searched by the
folder specified with the -f parameter.
v If the field name that you specify is a date field, the output format of the
date is determined by the Format on the Load Information page under
applications.
v The field names must be delimited with parenthesis.
v You can specify the fields in any order. The order that you specify
determines the file name that the ARSDOC program generates.
v You cannot use a field name to represent a directory name. For example,
the following is not valid:
-o "(field_1)/(field_2)
v You cannot specify the -c parameter to concatenate items in one output
file. Each item that matches the query is stored in a separate output file.
v If one or more documents have the same values for the specified
database fields, only one file is created, and the contents of the file
contains the last document that was retrieved. Therefore, make sure that
you specify an appropriate number of database field names that
uniquely identifies each document that is retrieved.
If more than one item matches a query and you do not generate a unique
file name using database field names, concatenate items in a single file
with the -c parameter, or specify the -g parameter, then the ARSDOC
program generates a unique file name for each item that matches the query
by adding a .n extension to the file name. Where n is the number of the
item that matched the query. For example, if you specify:
-o statements

And two items match the query, the ARSDOC program creates the
following files: statements.1 and statements.2
You must specify the -o parameter when you specify the -c parameter.
For the QUERY function, determines the file name of the output file in
which the ARSDOC program writes the list of items that match the query.
For the ADD function, determines the name of the input file that contains
the document to be added. The value that you specify is not checked for
valid characters. You can specify a full path name, including the back slash
or forward slash characters that are part of a directory path. When adding
a document, you can provide the input data by specifying the name of the
input file that contains the data with the -o parameter, an SQL query with
the -i parameter, or a public named query with the -q parameter. Only one
document may be added at a time.
-O For the ADD function, you must specify this parameter if you intend to

240 Common Server Administration Guide

 omit one or more database fields. However, you may never omit date or
time fields. When you specify the -O parameter, the ARSDOC program
stores a default value in any other database field that you omit. The
default value for string fields is an empty (null) string. The default value
for numeric fields is 0 (zero). Numeric fields include integer and decimal
fields.
-p password
The password of the Content Manager OnDemand user that you named
with the -u parameter. If there is no password assigned to the user that
you specify, use double quotes to show a null password. That is, specify -p
"". If you omit the -p parameter, then the ARSDOC program prompts you
to enter the password when you run the program. If there is no password
assigned to the user that you specify, press the Enter key when prompted.
If you omit -u and -p parameters, Content Manager OnDemand will use
the IBM i user profile of the user issuing ARSDOC as the Content Manager
OnDemand user ID.
-P Indicates PDF files that are retrieved and should be stored in individual
files even if concatenation has been requested.
-P printer
For the PRINT function, identifies the Content Manager OnDemand server
printer to which you want to send the documents that match the query.
-q namedQuery
The name of a public named query for the folder named with the -f
parameter. A named query is a set of search criteria previously saved on
the library server that can be recalled by name to search a folder. A named
query is typically defined to search a folder for a specific document or set
of documents.

Restriction: If you specify the -i or the -X parameters, then you cannot

specify the -q parameter.
-Q SQLqueryfile
Use this parameter to specify a file name that contains one or more query
strings. Specify only one of the parameters, -i, -q, or -Q.
-s seconds
For the GET function, determines the number of seconds that the ARSDOC
program waits between query requests when you specify more than one
query with the -F parameter. If you do not specify this option, then the
ARSDOC program does not wait between query requests. That is, the
default is 0 (zero) seconds.
-S startdate, enddate [,format]
Provides a date range that the ARSDOC program uses to limit a search to
specific tables. When you specify this parameter, the ARSDOC program
searches only tables that contain a segment within the specified date range.
You can optionally specify a date format. See “ARSDATE” on page 217 for
a list of the standard date formats. An example of a date range with a date
format is:
-S "01011990,12311990,%m%d%Y"
If you do not specify a date format, then the date values must be specified
by using the Display Format that is set on the Field Information page in
the folder. An example of a date range without a date format is:
-S "01011990,12311990"

API and user exit reference 241

 Important:
v For most queries, you should always specify the -S parameter and
specify a date range. Doing so limits the range of a query and can
significantly improve the performance of a query.
v For the ADD function, if you specify the -o parameter, you cannot
specify the -S parameter.
v For the GET and QUERY functions, if you specify the -X parameter, you
cannot specify the -S parameter.
v For all functions, if you specify the -q parameter, you cannot specify the
-S parameter.
-u userid
The Content Manager OnDemand user that is permitted to perform the
specified function. The ARSDOC program verifies that the user ID that you
specify is a valid Content Manager OnDemand user for the library server
that you name with the -h parameter, that the user ID is permitted to open
the folder that you name with the -f parameter, and that the user ID has
permission in application groups to perform the specified function. If you
omit the -u parameter, then the ARSDOC program prompts you to enter
the user ID when you run the program.
| -U user_alias
| Identifies the users when multiple users share a common user ID. The
| maximum length for user_alias is 128.
-v Enables verbose mode, which displays all messages (informational and
error). By default, the ARSDOC program displays error messages.
-x loadId
For the GET function, use to limit the documents that can be retrieved to
the set of documents that were loaded into the system under the specified
loadId.
For the QUERY function, use to limit the query to the set of documents
that were loaded into the system under the specified loadId.
When you specify the -x parameter, use the -f and -G parameters as
follows:
v Specify the -f parameter to search all application groups. You can specify
the search using the -i parameter or the -G parameter.
v Specify the -g parameter to search a specific application group. You must
specify the search using the -i parameter.
v Specify both the -f parameter and the -G parameter. The ARSDOC
program will verify that the application group can be searched from the
folder.
When you specify the -x parameter, you cannot specify the -X parameter.
-X loadId
For the GET function, retrieve documents by using the index file that was
generated for the specified loadId.
For the QUERY function, build a hit list from the index file that was
generated for the specified loadId.
For the PRINT function, the -i SQL parameter can be specified when the
-X flag is used. If it is specified, it is used only if the retrieve fails using the
loadID. If the -X flag is used, the application group name must be
provided using the -G flag.

242 Common Server Administration Guide

 For the CFSOD-FED function, send documents to CFS-OD and make them
available to IBM FileNet P8 features by using the index file that was
generated for the specified loadId.
When you specify the -X parameter, you must specify the -G parameter
and name the application group.
When you specify the -X parameter, you cannot specify the -x parameter,
or the -i, -q, -S, and -f parameters.

Examples
1. The following shows how to use the GET function to retrieve documents and
save them in a file in the current directory.
arsdoc get -h QUSROND -f "Student Information" -o student
-c -S 1/1/97,12/31/97 -i "WHERE student='001200340056'" -v

The ARSDOC program saves all of the documents that match the query in the
following output file: student
2. The following shows how to use the GET function and a parameter file to run
more than one query at a time. The parameter file is in the current directory.
The output files are saved in the current directory.
arsdoc get -h QUSROND -F parmfile -v

The parameter file contains two queries:

[-f "Student Information"] [-S 1/1/97,12/31/97] [-o (student)(type)] \
[-i "WHERE student='123420010056' AND type='B' OR type='G' OR type='T'"]

[-f "Student Information"] [-S 1/1/97,12/31/97] [-o (student)(type)] \

[-i "WHERE student='123450011917' AND type='B' OR type='G' OR type='T'"]

Assuming that documents exist for all of the specified types, the ARSDOC
program creates the following output files:
123420010056.Bills
123420010056.Grades
123420010056.Transcripts
123450011917.Bills
123450011917.Grades
123450011917.Transcripts
3. The following shows how to use the GET function to retrieve documents,
write the documents to a file, and generate and save generic index data for
the documents that match the query. The example shows how to specify the
name of a public named query that is valid for the specified folder.
arsdoc get -h QUSROND -f "Student Information"
-a -c -g -o student -q "3rd yr students GPA>3.5" -N -v

The number of output files that the ARSDOC program generates is a factor of
the number of application groups queried, the applications contained in the
application groups, whether the data is AFP and if so, the versions of resource
groups in each application. At a minimum, for AFP data with one version of
the resource group and one application group, the ARSDOC program
generates three output files. For example:
student.1.Student Information.TRANSCRIPTS.ind
student.1.Student Information.TRANSCRIPTS.out
student.1.Student Information.TRANSCRIPTS.res

API and user exit reference 243

 For AFP data, if there is more than one version of the resource group per
application, then the ARSDOC program can generate additional output files.
For example:
student.1.Student Information.TRANSCRIPTS.ind
student.1.Student Information.TRANSCRIPTS.out
student.1.Student Information.TRANSCRIPTS.res
student.2.Student Information.TRANSCRIPTS.out
student.2.Student Information.TRANSCRIPTS.ind
student.2.Student Information.TRANSCRIPTS.res
If the application group contains more than one application, then the
ARSDOC program can generate additional output files. For example:
student.1.Student Information.Bills.ind
student.1.Student Information.Bills.out
student.1.Student Information.Bills.res
student.2.Student Information.Grades.out
student.2.Student Information.Grades.ind
student.2.Student Information.Grades.res
4. The following shows how to use the QUERY function to generate a list of
items and save the list in a file in the current directory.
arsdoc query -h QUSROND -f "Student Information" -o query1.out -H
-S 1/1/97,12/31/97 -i "WHERE student='0012-0034-0056' AND type='B' OR
type='G' OR type='T'" -v
5. The following shows how to use the QUERY function and a parameter file to
run more than on query at a time. The parameter file is in the current
directory. The output files are saved in the current directory.
arsdoc query -h QUSROND -F parmfile -v

The parameter file contains three queries:

[-f "Student Information"] [-i "WHERE type='B'"] [-o query2.out] \
[-S 1/1/97,12/31/97] [-H] [-N (student)(id)(p_date)]

[-f "Student Information"] [-i "WHERE type='G'"] [-o query3.out] \

[-S 1/1/97,12/31/97] [-H] [-N (student)(id)(p_date)]

[-f "Student Information"] [-i "WHERE type='T'"] [-o query4.out] \

[-S 1/1/97,12/31/97] [-H] [-N (student)(id)(p_date)]
6. The following example shows how to use the QUERY function to search a
specific application group:
arsdoc query -h QUSROND -i "where Date_Taken BETWEEN 9863 AND 11531"
-G load-scanned-images-jpeg -o jpeg -v
7. The following example shows how to use the ADD function to add a
document to the Credit Card Statements folder:
arsdoc add -h QUSROND -o /newdata/crd.dat -n "crd_date=01/21/98"
-n "account='000-000-000'" -n balance=123.45 -n "name='John Watpole'"
-f "Credit Card Statements" -g CRD -a CRD -v
8. The following example shows how to use the UPDATE function to update a
document in the Credit Card Statements folder, changing the balance from
123.45 to 0.00:
arsdoc update -h QUSROND -i "where account='000-000-000' and
name='John Watpole'" -n "balance=0.00" -S 1/1/97,12/31/97 -f
"Credit Card Statements" -g CRD -v

244 Common Server Administration Guide

 9. The following example shows how to use the DELETE function to delete a
document from the Credit Card Statements folder:
arsdoc delete -h QUSROND -i "where account='000-000-000' and
name='John Watpole'" -f "Credit Card Statements" -S 1/1/97,12/31/97
-v
10. The following example shows how to use the PRINT function to send the
documents that match a query to a server printer:
arsdoc print -h QUSROND -P
svrprt1 -i "where account='000-000-000' and name='John Watpole'"
-f "Credit Card Statements" -S 1/1/97,12/31/97 -v
11. You can use the ARSDOC program to use the ADD function to add an index
that points to an existing document. For example, assume that you loaded a
bank statement for account number 000-000-000, date 5/23/97, and account
name Joe Smith. You want to add a new index, but point to the existing
statement. The new index uses the same account number and date, but
contains a different account name (for example, Sally Smith). After adding the
index, if a query is run with account name Joe Smith or Sally Smith, the
same bank statement will be retrieved. To add an index for an existing
document:
arsdoc add -h QUSROND -i "where sdate=10005 and account='000-000-000'
and name='Joe Smith'" -n "sdate=5/23/97" -n "account=000-000-000" -n
"name='Sally Smith'" -f "Credit Card Statements" -S 1/1/97,6/31/97 -v
12. The following example shows how to use the QUERY function to limit a
search to the documents that were loaded into the system under a specific
load ID. For example, assume that the specified folder could be used to search
several application groups; each application group contains more than one
application; there are 500,000 documents in the application groups. By using
the -x parameter, the query will be limited to the set of documents that was
loaded into the system under the specified load ID. Without the -x parameter,
the query is run against all 500,000 documents.
arsdoc query -h QUSROND -x 19867-025-0-3FAA-10136-10136
-f load-scanned-images -q query -o out -v
13. The following example shows how to use the QUERY function to limit a
search to the documents that were loaded into the system under a specific
load ID. In the example, the load ID, application group name, and query
string are provided. The search is limited to the application group and only
those documents that were loaded into the system under the specified load
ID.
arsdoc query -h QUSROND -x 19867-025-0-3FAA-10136-10136
-i "where Date_Taken BETWEEN 9863 AND 11531" -G load-scanned-images-jpeg
-o jpeg -v
14. The following example shows how to use the QUERY function to limit a
search to the documents that were loaded into the system under a specific
load ID. In the example, the load ID, folder name, application group name,
and named query are provided. The search is limited to the application group
and only those documents that were loaded into the system under the
specified load ID. Because a folder was specified, a named query can be used.
(If an application group name is specified and a folder name is not specified,
a named query cannot be used, because a named query is associated with a
folder.)
arsdoc query -h QUSROND -x 19867-025-0-3FAA-10136-10136
-f load_scanned-images -q query -G load-scanned-images-jpeg -o jpeg -v
15. The following example shows how to use the GET function and an index file
to retrieve documents from the system. The index file was generated for the
set of documents that was loaded into the system under the specified load ID.

API and user exit reference 245

 When using the -X parameter, the database is not queried; rather, documents
are retrieved based on the information in the index file.
arsdoc get -h QUSROND -X 19867-025-0-3FAA-10136-10136
-G load-scanned-images-jpeg -o jpeg -v
| 16. You can run ARSDOC GET with the -a and -g parameters to create generic
| indexer files. This also creates the .res resource file.
| arsdoc get -c -h <host> -u <usr> -p <pwd> -G <ApplGrp> -F <Folder>
| -i <SQL Query> -a -g -n -o <filename> -S <data range>

| If the -S <date range> is not specified, all tables will be searched, possibly
| resulting in poor performance.
| 17. -A parameter: The following are two examples of using the ARSDOC GET
| function with the -A parameter.

| Tip: In the following examples, the -u and -p parameters are not required for
| IBM i.
| v To retrieve public text annotations:
| arsdoc get -u oduser -p passwd -h odserver -f "CRD" -q named_query
| -o loaddata -a -g -c -N -A 0 -v
| v An example of the messages that are generated by the ARSDOC program.
| New messages are highlighted:
| 03/10/2004 10:32:12: Starting arsdoc. Version: 8.4.1.0
|
| 03/10/2004 10:32:14: arsdoc get -u oduser -h odserver -f CRD -q named_query -o loaddata -a -g -c -N -A 0 -v
|
| 03/10/2004 10:32:14: Attempting login for userid 'oduser' on server 'odserver' ...
|
| 03/10/2004 10:32:20: Login successful
|
| 03/10/2004 10:32:20: Searching for folder 'CRD' ...
|
| 03/10/2004 10:32:27: Search successful
|
| 03/10/2004 10:32:27: Searching for documents in 'CRD' ...
|
|
03/10/2004 10:32:28: Querying database with SQL string 'where account = '000-000-000''
|
| 03/10/2004 10:32:56: Search successful
|
| 03/10/2004 10:32:56: 1 document(s) have been queried. Retrieving 1 document(s).
|
| 03/10/2004 10:34:05: (1): Retrieving document for userid 'oduser' ...
|
| 03/10/2004 10:34:05: Document successfully retrieved and stored in file 'loaddata.2.CRD.CRD.out'
|
|
03/10/2004 10:34:15: Writing generic indexer file(s).
|
| 03/10/2004 10:34:46: '1' annotations were written to file 'loaddata.2.CRD.CRD.ann'
|
| 03/10/2004 10:34:46: A total of 1 annotations were written to file 'loaddata.2.CRD.CRD.ann'
|
| 03/10/2004 10:34:53: Generic indexer file 'loaddata.2.CRD.CRD.ind' has been successfully created.
|
| 03/10/2004 10:34:54: arsdoc completed.

18. -Q parameter: The following is an example command and an example file that
contains SQL statements.
Example command:
arsdoc get -h QUSROND -f "Labor Reports" -Q /home/dbryant/QSTRING.TXT -d /home/dbryant -o
REPORTS -a -g -c -N -v

Example file containing SQL statements:

# Query on one line
where EMPLNAME = 'B ROCKER'
# Query on multiple lines
where EMPLNAME\
= 'M VESPA'
| 19. -U parameter: In this example, if a common user ID oduser is shared by three
| users: John Smith, Mark Jones, and Kathy Brown. A user alias is assigned to
| identify each of the actual users. In this example, the user alias is the real user
| name.

246 Common Server Administration Guide

| arsdoc query -u oduser -p odpasswd -h host -i query_string -f folder
| -v -U "John Smith"
| arsdoc query -u oduser -p odpasswd -h host -i query_string -f folder
| -v -U "Mark Jones"
| arsdoc query -u oduser -p odpasswd -h host -i query_string -f folder
| -v -U "Kathy Brown"

| In the system log, the user ID column then contains:

| ODUSER-JOHN SMITH
| ODUSER-MARK JONES
| ODUSER-KATHY BROWN
| 20. HOLD_ADD function:

| Tip: In the following example, the -u and -p parameters are not required for
| IBM i.
| arsdoc hold_add -u oduser -p odpasswd -h odserver -l hold_audit -f
| "Monthly Status Reports" -i "where code='TX' and sdate=14117" -v
| 21. HOLD_RELEASE function:

| Tip: In the following example, the -u and -p parameters are not required for
| IBM i.
| arsdoc hold_release -u oduser -p odpasswd -h odserver -l hold_audit -f
| "Monthly Status Reports" -i "where code='TX' and sdate=14117" -v
| 22. CFSOD_FED function:
| arsdoc cfsod_fed -u oduser -p odpasswd -h odserver -f
| "Monthly Status Reports" -i "where code='TX' and sdate=14117" -v

Notes
The ADD function will fail unless the Database Organization for the application
group named with the -g parameter is Multiple Loads per Database Table and the
Expiration Type is Segment or Document.

The ADD function can be run without providing an input document from a file or
by retrieving an existing document from the system. This means that you can add
database field values without adding a document. To add database field values
without adding a document, do not specify the -o, -i, or -q parameters; specify the
database field names and their values using one or more -n parameters.

The ARSDOC program can print the PTF version number and the ARSDOC GET
function can print the number of documents that were queried and retrieved and
print a status message for each document that is retrieved. To enable the messages,
specify the -v parameter.

The following shows an example of the new messages:

12/08/02 10:33:36: Starting arsdoc. Version: 7.1.0.12

12/08/02 10:33:36: arsdoc get -u admin -h instance -q 000-000-000 -f CC Stmts -o test -v -c

12/08/02 10:33:36: Attempting login for userid 'admin' on server 'instance' ...

12/08/02 10:33:37: Login successful

12/08/02 10:33:37: Searching for folder 'CC Stmts' ...

12/08/02 10:33:38: Search successful

12/08/02 10:33:38: Searching for documents in 'CC Stmts' ...

12/08/02 10:33:40: Search successful

API and user exit reference 247

 12/08/02 10:33:40: 2 document(s) have been queried. Retrieving 2 document(s).

12/08/02 10:33:41: (1): Retrieving document for userid 'admin' ...

12/08/02 10:33:41: Document successfully retrieved and stored in file 'test'

12/08/02 10:33:42: (2): Retrieving document for userid 'admin' ...

12/08/02 10:33:42: Document successfully retrieved and stored in file 'test'

12/08/02 10:33:45: arsdoc completed.

IFS Location
/usr/bin/arsdoc
The IBM i executable program.

ARSLOAD
Purpose
The ARSLOAD program can be used to process the input files that you want to
load into the system. The ARSLOAD program determines if the input data needs
to be indexed, and if so, calls the appropriate indexing program. The ARSLOAD
program calls the storage manager programs to load report data on storage
volumes and the database manager to update the IBM Content Manager
OnDemand database with the index information that was extracted from or
specified for the input file.

Important: Set the proper locale before issuing the ARSLOAD API. See the chapter
entitled “Defining a locale” in the IBM Content Manager OnDemand for i Common
Server: Planning and Installation Guide for important details.

Syntax
|  arsload 
-a application -B Format -b Field name
-A applID

  
-c indexDir -d dataDir -f -F C T X

 
-g applGroup -h instance -i -I instance
-G applGroupID

|  
-j parmFile -J file_name_delimiter -L -n

248 Common Server Administration Guide

 
-p password -t seconds -T -u userid -U filename

  
-v -X loadFilename
4
G

Description
The ARSLOAD program is the main IBM Content Manager OnDemand data
indexing and loading program. The ARSLOAD program calls the indexing
program if the input data needs to be indexed, creates input files for the storage
manager, and updates the Content Manager OnDemand database. The ARSLOAD
program saves processing messages in the system log. You can open the System
Log folder and list the messages that were generated when an input file was
processed.

You typically configure the ARSLOAD program to run as a monitor to periodically

check specified IFS directories for input files to process.

The ARSLOAD program can use the following sources for input files to process:
v one or more file systems specified with one or more -d parameters,
v one or more load file names.

If you omit the load file name, the ARSLOAD program will run in monitor mode
and attempt to load input data from the directories that are specified by the -d
parameter. If you omit the load file name and do not specify the monitor mode
parameter (-d), the ARSLOAD program will issue a usage note and exit.

Important: When running the ARSLOAD program in monitor mode, the .ARD and
.PDF file name extensions are required to initiate a load process.

When you run the ARSLOAD program, you must provide the user ID and
password of an Content Manager OnDemand user with administrator authority for
the application group into which the input data will be loaded. There are several
ways that you can provide the user ID and password:
v Do not specify the -u and -p parameters. In this case, the current user profile of
the job that is running ARSLOAD is used as the Content Manager OnDemand
user ID. This is the recommended method.
v Use the -u and -p parameters each time that you run the ARSLOAD program.
v Use the -U parameter each time that you run the ARSLOAD program to name a
file that contains a single line with the userid and password of a user that has
administrator authority for the application group.

Parameters
-a application
The name of the application to load. If the application group contains more
than one application, then you must identify the application to load.
Otherwise, the load will fail. If you plan to automate the loading of files

API and user exit reference 249

 into different application groups and applications, then use the -A
parameter to specify the part of the file name that identifies the name of
the application.
-A applID
Determines the part of the file name that identifies the application to load.
If the application group contains more than one application, then you must
identify the application to load; otherwise, the load will fail.
You typically use this parameter when you run the ARSLOAD program as
a monitor to automate the loading of files into different application groups
and applications. For example, a file transmitted from an OS/390 or z/OS
system might use the following file naming convention:
| MVS.JOBNAME.DATASET.FORMS.YYYYDDD.HHMMSST.ARD

Important: The .ARD file name extension is required to initiate a load

process.
v Unless you specify otherwise, the ARSLOAD program uses the FORMS
part of the file name to identify the application group to load. You can
use the -g parameter to specify a different part of the file name that
identifies the application group (MVS, JOBNAME, or DATASET). For
example, arsload -G JOBNAME.
v If the application group to load contains more than one application
(source of data), then you must identify the application to load;
otherwise, the load will fail. When you run the ARSLOAD program, you
can use the -A parameter to specify the part of the file name that
identifies the application (MVS, JOBNAME, DATASET, or FORMS). For
example, to use the DATASET part of the file name to identify the
application, run the ARSLOAD program with the -A DATASET parameter.
-b <field>
Field identifier for file name index parameter. Specifies the field name in
the application group that is set to the value that is specified by the IDX in
the -B parameter. If an IDX is not identified by the -B parameter, this value
is ignored.
For example,
arsload -b "field1" -B "AG.IDXAPP.ARD" -g ApplGroup1 ... ApplGroup1.App1.ARD

takes the value App1 from the input file name and insert it into "field1" of
application group "ApplGroup1" during the load. In this example we set
"field1" to the name of the application that is loaded, "App1."
-B Format
Use this parameter to define file name formats for any files that are
processed by ARSLOAD. Use the following to create the file name format:
v WRIter
v MVS
v JOBname
v DATaset
v FORms
v YYddd
v HHmmm
v AG (Application group name)
v APP (Application name)

250 Common Server Administration Guide

 v IDX (Indicates which part of the file name to use as index)
v IGN (Ignore)
v .EXT (Extension)
The letters in lowercase are optional. For example:
ARSLOAD –G FORMS –J “-“ –B “WRItER-MVS-IGN-IGN-FORms”
ARSLOAD –G JOBNAME –B “WRITER.IGN.JOB.IGN.DAT.IGN.EXT”
ARSLOAD –J “-“ –B “IGN-IGN-AG-APP-IGN.EXT”
ARSLOAD –B “APP.IGN.AG.IGN.IGN”
Here are two examples of using the IDX identifier:
v Simple index input format:
arsload –b “account_num” –B “AG.APP.IDX”

where the system uses the IDX part of the file name as an index
parameter for the account_num field.
v Dual purpose index format:
arsload –b “report_name” –B “AG.IDXAPP”

where the system uses the APP part of the file name as an index
parameter for the report_name field
| The IDX value works with the PDF indexer only. It does not work with the
| OS/400 indexer or the generic indexer.
| You can use the -B parameter or the -g and -a parameters combined but
| cannot use all three of them together. If you specify the -B parameter, you
| identify the application group name and the application name as parts of
| the filename.
-c indexDir
The file system in which IBM Content Manager OnDemand temporarily
stores data created by the indexing program. The default location is the
directory from which the ARSLOAD program was invoked.
-d dataDir
The directory that contains input files to process.
Any file with a file type extension of .ARD or .PDF will be processed (.ARD
files are transmitted to the server by an OS/390 or z/OS download utility;
.PDF files are created by Acrobat Distiller). The case of the file type
extension is not significant.
You can specify this parameter one or more times. The ARSLOAD program
will search for input files to load in each of the directories that you specify.
To specify more than one directory, specify the -d parameter multiple
times. In the following example:
arsload ... -d dir1 -d dir2 -d dir3...

the ARSLOAD program will search for input files in the dir1, dir2, and
dir3 directories.
-f Use to unload the data if the load process fails. If the database manager
step fails, then Content Manager OnDemand should remove any index
data that was added to the database. If the storage manager step fails, then
Content Manager OnDemand should remove any storage objects that were
copied to storage volumes.

API and user exit reference 251

 Important: If an input file fails to load, you should review the message log
that was created during the load process. You can retrieve a message log
from the system log. If the message log contains a Load ID, then it means
that for some reason, Content Manager OnDemand stored at least some of
the input data in the application group. Before you attempt to reload the
input data, you must remove the data that was created during the failed
load process by using the RMVRPTOND command.

See “Deleting a report” on page 187 for help with removing the data that
is created when a file is loaded into the system.
-F Trace output format
Optional parameter when -T is specified. The default output is text format.
The possible values are C, T, and X:
C or CSV
The CSV format is a comma separated file that is useful in
spreadsheets.
T or TEXT
Default output format.
X or XML
The XML format outputs XML structured data. Using the XML
output requires a header and trailer to be added to the trace file to
complete the XML syntax and create valid XML. After the XML
structured data is combined with .XSL and .DTD files, it can be
viewed in a browser or XML editor.
-g applGroup
The name of the application group to load. This parameter is required if
you specify a load file name to process. This parameter is optional if you
specify the -d parameter. However, if you specify the -d parameter, unless
you specify otherwise, the ARSLOAD program uses the FORMS part of the
file name to determine the name of the application group to load. If you
plan to automate the loading of files into different application groups and
applications, then you should use the -g parameter to specify the part of
the file name that identifies the application group to load.
-G applGroupID
Determines the part of the file name that the ARSLOAD program uses to
identify the name of the application group to load.
You typically use this parameter when you run the ARSLOAD program as
a monitor to automate the loading of files into different application groups
and applications. For example, a file transmitted from an OS/390 or z/OS
download utility might use the following file naming convention:
MVS.JOBNAME.DATASET.FORMS.YYYYDDD.HHMMSST.ARD

Important: The .ARD file name extension is required to initiate a load

process.
v Unless you specify otherwise, the ARSLOAD program uses the FORMS
part of the file name to identify the application group to load. You can
use the -g parameter to specify a different part of the file name that
identifies the application group (MVS, JOBNAME, or DATASET). For
example, arsload -G JOBNAME.
v If the application group to load contains more than one application
(source of data), then you must identify the application to load;
otherwise, the load will fail. When you run the ARSLOAD program, you

252 Common Server Administration Guide

 can use the -A parameter to specify the part of the file name that
identifies the application (MVS, JOBNAME, DATASET, or FORMS). For
example, to use the DATASET part of the file name to identify the
application, run the ARSLOAD program with the -A DATASET parameter.
-h instance
The name of the Content Manager OnDemand instance to process. This is
a required parameter.

Important: If you run multiple instances of Content Manager OnDemand,

always specify the -h parameter to identify the name of the instance that
you want to process. Verify that the system is configured with the correct
information for all instances of Content Manager OnDemand. See IBM
Content Manager OnDemand for i: Planning and Installation Guide for
information on configuring instances.
-i Use to run the data indexing program only; do not copy report data to
storage volumes or add the index data to the database.
-I instance
The name of the Content Manager OnDemand instance that you want to
process. The name of the default instance on the IBM i is QUSROND. You
must specify the -I parameter and name the instance, if you are running
more than one instance on the same IBM i system and you want to process
an instance other than the default instance (QUSROND).
-j parmFile
Use to specify the name of a parameter file that contains additional
indexing parameters.
When you specify the -j parameter and name a parameter file, the
ARSLOAD program adds the indexing parameters from the specified
parameter file to the indexing parameters that it extracts from the
application. (Indexing parameters are typically specified on the Indexing
Information page in the application definition.) If an indexing parameter
appears in both the application and the parameter file that you specify,
unexpected results may occur.
| -J File name delimiter
| Use this parameter to define file name formats for MVS download files
| and files that are processed by the ARSLOAD daemon. By default, this
| parameter is "."
-L Trace level number
Optional parameter when –T is specified. Possible trace levels include:
1 Errors
2 Warnings
4 Info
Provides informational trace messages for debugging problems.

Important: Use only under the supervision of support because it

might affect performance.
8 Flow
Provides function entry and exit information.

API and user exit reference 253

 Important: Use only under the supervision of support because it
might affect performance.

The trace level numbers are added up, and the default level is 3, which is
used to report errors and warnings which occur during loading.
-n Determines whether Content Manager OnDemand deletes the input files
when the ARSLOAD program terminates.
v If you specify the -N parameter, then Content Manager OnDemand does
not delete the input files when the ARSLOAD program ends.
v If you do not specify the -N parameter, then Content Manager
OnDemand deletes the input files when the ARSLOAD program ends.
In either case, if the ARSLOAD program fails in the load step because of a
device or system problem, then you can restart the load step after you
correct the problem by using the intermediate files that were created by the
ARSLOAD program. The ARSLOAD program stores the intermediate files
in the directory named with the -c parameter (or the directory from which
you started the ARSLOAD program, if you did not specify the -c
parameter). The intermediate files have the same file name as the original
input file.
-p password
The password for the user that is specified with the -u parameter. If the
user is not assigned a password, enter a null password (that is, specify -p
"").
-t seconds
Determines the polling time in seconds. This is the interval of time in
which the ARSLOAD program checks the input directory (specified by the
-d parameter) for input files to process. The default value is 600 seconds,
which means that the ARSLOAD program checks the input directory every
ten minutes.
-T Fully qualified trace file name
When a file is specified, trace is activated for ARSLOAD. If the file already
exists, it is renamed with the current date and time, and a new file is
created.
-u user ID
The user ID of an Content Manager OnDemand user with administrator
authority for the application group. The user must have permission to add
documents to the application group.
If you omit the -u and -p parameters, then the current user profile for the
job is used for the Content Manager OnDemand user ID. If that user
profile does not match an Content Manager OnDemand user ID, then
Content Manager OnDemand attempts to obtain the user ID and password
from the value of the -U parameter. If the ARSLOAD program cannot
locate or use the file named with the -U parameter, then it attempts to log
on to Content Manager OnDemand and access the application group with
a user ID of QONDADM and no password.
-U filename
See -u for information.

Important: After you configure the file named with the -U parameter ,
remember to change the password any time that you change the user’s
password in Content Manager OnDemand; otherwise the load will fail.

254 Common Server Administration Guide

 The ARSLOAD program can accept an expired password; however, the
ARSLOAD program will fail if you specify an incorrect password.
-v Enables verbose mode, which displays all messages (informational and
error). By default, the ARSLOAD program displays error messages.
-X indexer
Allows you to override the indexing program that was specified on the
Indexer Information page for the application. The possible values are 4 and
G:
v Specify -X 4 to use OS/400 Indexer.
v Specify -X G to use the Content Manager OnDemand Generic Indexer.
You must specify an indexing program if the input contains index data in a
format other than the one supported by the indexing program that was
specified for the application. For example, assume that you defined an
application and specified OS/400 Indexer as the indexing program. Later,
you used the ARSDOC program to extract documents from an application
group. The ARSDOC program generates index data that is in the Generic
indexer format. To load the index data into the application, you must
specify:
arsload -X G . . .
loadFilename
Specifies an input file to process.
You may specify the names of one or more input files to process. If you
specify more than one input file, separate the file names with a blank
character.
The ARSLOAD program concatenates the following file type extensions to
the file name that you specify: IND, OUT, and RES
v The IND file contains the index data
v The OUT file contains the report data
v The RES file contains the resource data
For example, if you specify arsload -g BILLS po3510, the ARSLOAD
program processes the following files:
v po3510.ind
v po3510.out
v po3510.res
If the ARSLOAD program does not find a file with the IND file type
extension, it automatically calls the indexing program to process the input
file.
If you omit an input file name, the ARSLOAD program will run in daemon
mode and attempt to load input data from the directories that are specified
by the -d parameter. If you omit an input file name and do not specify the
daemon mode parameter (-d), the ARSLOAD program will issue a usage
note and exit.

Examples
1. The following shows how to run the ARSLOAD program to check the specified
directory for input files to process. The input files must have a file type
extension of .ARD or .PDF. The ARSLOAD program stores temporary work files
in the location specified by the -c parameter. In this example, the ARSLOAD
program uses the FORM part of the file name to determine the application group

API and user exit reference 255

 to load and the application group contains only one application; the ARSLOAD
program logs on to the system and accesses the application group with the
current user profile..
arsload -c /arsdir/dir1 -d /arsdir/dir2
2. The following shows how to run the ARSLOAD program to check the specified
directory for input files to process. The input files must have a file type
extension of .ARD or .PDF. The ARSLOAD program stores temporary work files
in the location specified by the -c parameter. In this example, the ARSLOAD
program uses the JOBNAME part of the file name to determine the application
group to load and the DATASET part of the file name to determine the
application to load; the ARSLOAD program logs on to the system and accesses
the application group with the current user profile..
arsload -c /arsdir/dir1 -d /arsdir/dir2 -A DATASET -G JOBNAME
3. The following shows how to run the ARSLOAD program to load the specified
file into the specified application group. The ARSLOAD program logs on to the
system and accesses the application group by using the user ID and password
from the -u and -p parameters.
arsload -g BILLS -u bob -p secret PO3510
4. The following shows how to run the ARSLOAD program to load several input
files into the specified application group. The application group name contains
an embedded blank character, and must be quoted. The ARSLOAD program
logs on to the system and accesses the application group by using the user ID
and password from the -u and -p parameters.
arsload -g "ABC Credit" -u bob -p secret RW7505 RW8505

Notes
The IBM Content Manager OnDemand server job must be running, otherwise the
ARSLOAD program will fail.

IFS Location
/usr/bin/arsload
The IBM i executable program.

ARSXML
Purpose
The ARSXML program imports objects within an existing IBM Content Manager
OnDemand XML file into a Content Manager OnDemand system, and exports
existing Content Manager OnDemand objects into a Content Manager OnDemand
XML file.

Syntax
Syntax for adding, updating, and deleting administrative objects in an
Content Manager OnDemand system

 arsxml add 
update -d
delete directory

256 Common Server Administration Guide

 -h instance -i input_xml_file 
-e
error_handling a
c
u

 
-p -u userid -v -x
password

Syntax for exporting existing Content Manager OnDemand objects into a

Content Manager OnDemand XML file

 arsxml export 
-d -e
directory error_handling

 -h instance 
-i -o
input_xml_file output_xml_file

 
-p -u userid -v
password -r
range

 
-w -x -y
encoding directory

Description
IBM Content Manager OnDemand includes an XML interface that imports and
exports administrative objects in Content Manager OnDemand. In this model, all
administrative objects are exported into an XML file, and can be imported into the
same system or another system later. You can also create an XML file through a
user application or Web interface according to the defined specifications, and
import a single object or multiple objects into the system by importing the XML
file.

The data import feature allows you to import a single object, a set of defined
objects, or even an entire OnDemand system. This features enables you to
complete the following tasks:
v Update a system with newly defined objects
v Backup a complete system
v Copy a set of objects from one system to another system

The XML import file can be one of the following:

v A file which was previously created during a Content Manager OnDemand
export process.
v A user created XML file which conforms to the Content Manager OnDemand
XML schema.

Important:

API and user exit reference 257

 v The syntax of each Content Manager OnDemand object that is supported by the
import process is specified in the Content Manager OnDemand XML schema
file. Each object within the XML file must conform to the exact syntax as
specified in the OnDemand XML schema file that is shipped with the product.
However, objects may appear in any order within the body of the XML file.
v To use the XML import function, an appropriate Java Runtime Environment
(JRE) is required. For IBM i systems, install the licensed program product
5761-JV1 - IBM Developer Kit for Java.
v The import XML file references an ondemand.xsd file, which is provided with
Content Manager OnDemand. The ondemand.xsd file must reside in the same
directory where the input XML file is located, otherwise, the reference in the
input XML file must contain a full path name for the ondemand.xsd file.
v The capitalization of the object names is important and should be used exactly
as shown in the data tables in IBM Content Manager OnDemand for Multiplatforms
Administration Guide.

Parameters for ARSXML [add|update|delete]

add This is the default action. It adds all of the objects in the input XML file
into the specified IBM Content Manager OnDemand system. For objects
that contain child objects, such as a list of users or a set of permissions,
each child object that is found in the XML file is added to the current list
of objects.
update
All the fields that are specified in the input XML file are updated for the
object. For example, if the XML file contains a user with a name of harry
and a description of The New Description specified, then only the
description field of the user harry is updated. All other fields remain
unchanged.

Restriction: Not all fields of all objects can be updated.

For objects which contain child objects, such as a list of users or a set of
permissions, each child object that is found in the XML file are added to
the list of objects. A special attribute on each child object can be set to
delete for the cases where a member of a list need to be removed. For
example, if you want to add the user newUser to a group, and delete the
user oldUser, the following XML code can be used during an update:
...
<group name="MyGroup">
<user name="newUser" />
<user name="oldUser" task="delete" />
</group>
...
delete
All of the objects that are specified in the input XML file are deleted from
the system. The only attribute that is examined in the XML file is the name
attribute. While all other fields might be present in the XML file, they are
ignored.
-d Specifies the directory that contains the XML file. If you do not use this
parameter, ARSXML looks for the input XML file specified by the -i flag in
the current working directory where the command is run.

258 Common Server Administration Guide

-e error_handling
Controls how the import process handles any Content Manager
OnDemand errors.

Important: The XML file syntax errors and other XML-specific errors are
detected by the parsing code, and no objects are processed.
The error_handling parameter can take three values:
a Abort. This is the default value.
c Continue. If an error occurs because of problems in the objects or
the Content Manager OnDemand system (for example, you attempt
to add an object but that object already exists, or you attempt to
delete an object that does not exist), the object containing the error
is skipped, and the process continues. However, if an XML parsing
error occurs, ARSXML stops regardless of whether or not this
option is specified.
u Update. This value should only be used during an add action.

During an add action:

Abort If an error occurs during an add (for example, an invalid
parameter, or the object already exists), the error is logged, the
entire import process is stopped, and no further objects are added.
Continue
If an error occurs during an add action, the object containing the
error is skipped and an error message is logged. However, the
import process continues.
Update
If an object already exists, perform an update action instead of an
add action.

During a delete action:

Abort If an error occurs during a delete (for example, there is an invalid
object or the object does not exist), the error is logged, the entire
delete process is stopped, and no further objects are deleted.
Continue
If an error occurs during an delete action, the object containing the
error is skipped and an error message is logged. However, the
import process continues.

During an update action:

Abort If an error occurs during a update (for example, there is an invalid
object or the object does not exist), the error is logged, the entire
update process is stopped, and no further objects are updated.
Continue
If an error occurs during an update action, the object containing
the error is skipped and an error message is logged. However, the
import process continues.
-h instance
Specifies the host name of the Content Manager OnDemand system
-i Specifies the input XML file.

API and user exit reference 259

| -p password
| The password is optional. If you omit the -p parameter but you do specify
| a user ID with the -u parameter, the ARSDOC program prompts you to
| enter the password when you run ARSXML. If there is no password
| assigned to the user you specify, press Enter when prompted. If you omit
| both the -p and -u parameters, Content Manager OnDemand uses the IBM
| i user profile of the user executing ARSXML as the Content Manager
| OnDemand user ID.
| -u userid
| The user ID is optional. If you omit it, Content Manager OnDemand uses
| the current user profile of the job running ARSXML as the Content
| Manager OnDemand user ID. If that user profile does not match an
| Content Manager OnDemand user ID, ARSXML prompts you to enter a
| user ID.
-v Enables verbose mode, which displays all messages (informational and
error). By default, the ARSXML program displays error messages.
-x Used to prevent prompting from occurring. If you do not use this option,
during a delete operation, you are prompted whether you really want to
complete the operation, for example:
The printer object named 'LabPrinter' is about to be deleted.
Do you want to delete this object? (Y/N)

You need to respond with a y or Y to confirm the process. Any other

response terminates the process. If you use this option, you do not get the
prompt during an operation.

Important: While importing objects, if an object references another object in its

definition but the referenced object cannot be found, and the import command
uses the -e c parameter, an error message is issued, and the default value is used.
For example, if a user is defined with a default printer and the default printer
cannot be found, the user is added with a default printer of *NONE. If the -e c
parameter is not used, the above action will not occur.

Parameters for ARSXML export

-d Use this option to specify the directory for the input XML file. If you do
not use this parameter, the ARSXML command looks for the input XML
file that is specified by the -i flag in the current working directory where
the command is run.
-e error_handling
Specifies what to do if an error occurs during the export process. The
error_handling parameter can take two values:
a Abort. This is the default value. The export process stops when an
error occurs.
c Continue. If an error occurs due to problems in the objects or the
IBM Content Manager OnDemand system (for example, you
attempt to export an object but that object already exists), the
object that contains the error is skipped, and the process continues.
However, if an XML parsing error occurs, ARSXML stops
regardless of whether this option is specified.
-h instance
The name of the Content Manager OnDemand instance you want to
process. The name of the default instance in IBM i is QUSROND. You must

260 Common Server Administration Guide

 specify the -h parameter and name the instance if you are running more
than one instance on the same IBM i system, and you want to process an
instance other than the default instance (QUSROND).
-i Use to specify the input XML file. All of the objects that are specified in the
XML file are exported from the system into the output XML file. In this
case, the only attribute in the XML file that is examined is the name
attribute. While all other attributes are present in the XML file, they are
ignored. If an object is specified with the name _ALL, all of the objects of
that type defined on the system are exported. If the -i parameter is not
present, all of the objects in the specified system are exported. However,
you are prompted to confirm whether this is what is intended, because the
export process could take a long time. You can use the -x option to turn off
the prompting.
-o Used to specify the name of the output XML file. If this parameter is not
specified, the output is directed back to your display if you are running
interactively, or to a spooled file if you are running in batch mode.
-p password
The password is optional. If you omit the -p parameter but you do specify
a user ID with the -u parameter, ARSDOC prompts you to enter the
password when you run ARSXML. If there is no password assigned to the
user ID you specify, press Enter when prompted. If you omit both the -p
and -u parameters, Content Manager OnDemand uses the IBM i user
profile of the user executing ARSXML as the Content Manager OnDemand
user ID.
-r range
Use this option to specify how much data to export. The range parameter
can take four values:
a When an application group is exported, all of the applications that
are contained within the application group are exported.
d Export the specified objects and all dependent objects. If you use
this parameter, each object is examined for any dependent objects,
and those objects are exported as well. For example, if only user
groups are exported and the d option is used for the extent, then
any users that the groups refer to are exported as well.
l Export the objects and any logical views that are associated with
them.
p Export the objects and a list of permissions for each object.

More than one range option can be specified in the command line, in other
words, the options may be combined. For example,
-r pl

If no range option is specified, then only the specified object or objects are
exported.
-u userid
The user ID is optional. If it is omitted, Content Manager OnDemand uses
the current user profile of the job running ARSXML as the user ID. If that
user profile does not match a Content Manager OnDemand user ID,
ARSXML prompts you to enter a user ID.
-v Enables verbose mode, which displays all messages (informational and
error). By default, the ARSXML program displays error messages.

API and user exit reference 261

 -w Specifies the encoding in which the resultant output XML file will be
created. The default is UTF-8. The encodings that are supported are those
supported by the Xerces2 Java Parser. For more information, see
http://xml.apache.org/xerces-j/faq-general.html
-x Used to prevent prompting from occurring. If you do not use this option,
during an export operation, you are prompted whether you really want to
complete the operation, for example:
No input file was specified.
Do you want to export all of the objects on the system? (Y/N)

You need to respond with a y or Y to confirm the process. Any other

response terminates the process. If you use this option, you do not get the
prompt during an operation.
-y Use this option to specify the directory for the output XML file. If this
option is not used, the output file that is specified by the -o parameter is
written to the current working directory where the command is run.

Examples
Example 1: Adding users:

A user wants to add several users to an IBM Content Manager OnDemand system.
That user has created an XML file called newusers.xml.

To complete this task, the following QSHELL command line function is called:
arsxml add -h neptune.ny.ibm.com -u admin -i newusers.xml

The file newusers.xml might look like this:

<?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">
<user name="Bill" password="xxxxx" userType="User Admin"/>
<user name="Erin" password="xxxxx" userType="User"/>
<user name="Brie" password="xxxxx" userType="User"/>
</onDemand>

Example 2: Updating users:

A user wants to update the telephone numbers of the users in the system. This
user created an XML file phone.xml, which contains the data for the users and their
phone numbers.

To complete this task, the following QSHELL command line function is called:
arsxml update -h neptune.ny.ibm.com -u admin -i phone.xml

The file phone.xml might look like this:

<?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">
<user name="Bill" phone="(212) 555-0919"/>
<user name="Erin" phone="(212) 555-4295"/>
<user name="Brie" phone="(212) 555-0301"/>
</onDemand>

Example 3: Exporting multiple objects:

262 Common Server Administration Guide

A user wants to export the printer objects named Prz1 and Prz2. This user also
want to export the storage set named FavoriteSS. An XML file exportlist.xml has
been created, and contains the information on these objects.

To complete this task, the following QSHELL command line function is called:
>arsxml export -h jupiter.ibm.com -i exportlist.xml -o output.xml

The file exportlist.xml might look like this:

<?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">
<printer name="Prz1"/>
<printer name="Prz2"/>
<storageSet name="FavoriteSS"/>
</onDemand>

After the user runs the command, an output file named output.xml is created, and
contains the information for the two printers and the storage set.

Example 4: Exporting a group:

A user wants to export a group named BigGroup and any users and user groups
that are referenced by it. A file named exportbiggroup.xml has been created and
looks like this:
<?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ondemand.xsd">
<group name="BigGroup"/>
</onDemand>

To complete the task, the following QSHELL command should be used:

>arsxml export -h jupiter.ibm.com -i exportbiggroup.xml -r d -o output.xml

This command creates an XML file that contains the BigGroup object and all the
users and groups that are referenced by it. Also, any users within the referenced
groups are exported.

Example 5: Exporting all of the users:

A system administrator wants to export all of the users in an IBM Content

Manager OnDemand system. A file named exportallusers.xml is created, and
looks like this:
<?xml version="1.0" encoding="UTF-8"?>
<onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi="noNamespaceSchemaLocation="ondemand.xsd">
<user name="_ALL"/>
</onDemand>

To complete the task, the following QSHELL command should be used:

arsxml export -h jupiter.ibm.com -i exportallusers.xml -o users.xml

This command creates an XML file users.xml that contains the information on all
of the users that are defined on the specified system.

Tips for using ARSXML

This section includes tips for using ARSXML to import and export administrative
objects.

API and user exit reference 263

 Tip 1: Child objects must be created under parent objects:

Child objects can appear only under parent objects, but not vice versa. For
example, the following XML file example is valid:
<group name="MyGroup">
<user name="tom" />
<user name="chuck" />
</group>

However, this example is not valid:

<user name ="tom">
<group name ="MyGroup">
</group>
</user>

The same is true for permissions for users and groups. They are child objects
under the application group and folder objects. For example, to add a folder that
contains permission for the user Bill, the XML file might look like this:
<folder name="MyFolder"...>
<permission user="Bill" accessAuthority="Yes"
viewNQAuthority="Yes" maxHits="No Limit" />
...
</folder>

Tip 2: Application group and folder authorities and permissions are not linked:
If you specify adminAuthority="Yes", you do not get the view, add, print, fax, and
copy document permissions, or the view, add, and copy annotations permissions.
You need to specify each item individually.

Tip 3: Parsing error while running ARSXML:

You might receive this error message while running ARSXML:

A parsing error occurred in file fileName, Line nnn, Column nnn :
cvc-elt.1: Cannot find the declaration of element 'onDemand'.

It usually indicates that the IBM Content Manager OnDemand schema file
(ondemand.xsd) cannot be found. The Content Manager OnDemand schema file
should be placed in the directory where the Content Manager OnDemand XML file
resides. Otherwise, the fully qualified path name should be placed in the
noNamespaceSchemaLocation element of the Content Manager OnDemand XML file.

User exit reference

| “Output queue or directory monitor user exit program”
| “Overview of the monitor” on page 265
| “How the monitor exit works” on page 265
“Exit program details” on page 267
“Facsimile user exit program” on page 267

Output queue or directory monitor user exit program

You can design a user exit program to alter the application group name or
application name the monitor finds as it processes files in a monitored output
queue or IFS directory.

264 Common Server Administration Guide

 Overview of the monitor
An output queue or directory monitor (started by the Start Monitor for OnDemand
(STRMONOND) command or by using a monitor definition in System i Navigator)
automatically processes files from the specified output queue or IFS directory.

When you start the monitor, two parameters are used to determine which
application group and application to use to archive the input files.

The Value for application name (APPSRC) parameter is used to determine the
application name. Up to three sources can be specified. If a valid application name
is not found that uses the first source, the second source is used. If a valid
application name is not found that uses the second source, the third source is used.

The Value for application group (APPGRPSRC) parameter is used to determine the
application group name. Up to three sources can be specified. If a valid application
group name is not found that uses the first source, the second source is used. If a
valid application group name is not found that uses the second source, the third
source is used.

The same source or different sources can be specified for APPSRC and
APPGRPSRC.

Valid sources for an output queue monitor are:

v *SPLFNAME
v *FORMTYPE
v *USERDATA
v *JOBNAME
v *USRDFNOPT1
v *USRDFNOPT2
v *USRDFNOPT3
v *USRDFNOPT4
v *USRDFNDTA

Valid sources for a directory monitor are:

v *FIRST
v *SECOND
v *THIRD
v *FOURTH

| How the monitor exit works

| Application name - first pass: When an input file is selected from an output queue
| or IFS directory to be processed, OnDemand checks for a user exit program in the
| monitor job’s library list with a name that matches the first attribute specified in
| the APPSRC parameter of the STRMONOND command.

| If a program is found, it is called, allowing the application name to be changed

| within the exit program as needed. OnDemand then uses the new application
| name to verify that an application definition by that name exists.

| If a program is not found, OnDemand looks for an application name that matches
| the first attribute.

API and user exit reference 265

| Application name - second pass: If an application is still not found, OnDemand
| now checks for a user exit program in the monitor job’s library list with a name
| that matches the second attribute specified in the APPSRC parameter of the
| STRMONOND command.

| If a program is found, it is called, allowing the application name to be changed as

| needed. OnDemand then uses the new application name to verify that an
| application definition by that name exists.

| If a program is not found, OnDemand looks for an application name that matches
| the second attribute.

| Application name - third pass: If an application is still not found, OnDemand now
| checks for a user exit program in the monitor job’s library list with a name that
| matches the third attribute specified on the APPSRC parameter of the
| STRMONOND command.

| If a program is found, it is called, allowing the application name to be changed as

| needed. OnDemand then uses the new application name to verify that an
| application definition by that name exists.

| If a matching application name is still not found, error messages are placed in the
| monitor job log. For an output queue monitor, the spooled file is moved, in Ready
| (RDY) status, to the error output queue (ERROUTQ) specified in the
| STRMONOND command. For a directory monitor, files will be left in the directory
| and have ’.ERR’ added to end of the file name.

| Application group name - first pass: Next, OnDemand checks for a user exit
| program in the monitor job’s library list with a name that matches the first
| attribute specified in the APPGRPSRC parameter of the STRMONOND command.

| If a program is found, it is called, allowing both the application group and

| application names to be changed as needed. OnDemand then uses the new
| application group name to verify that an application group definition by that name
| exists.

| If a program is not found, OnDemand looks for an application group name that
| matches the first attribute.

| Application group name - second pass: If an application group is still not found,
| OnDemand now checks for a user exit program in the monitor job’s library list
| with a name that matches the second attribute specified in the APPGRPSRC
| parameter of the STRMONOND command.

| If a program is found, it is called, allowing both the application group and

| application names to be changed as needed. OnDemand then uses the new
| application group name to verify that an application group definition by that name
| exists.

| If a program is not found, OnDemand looks for an application group name that
| matches the second attribute.

| Application group name - third pass: If an application is still not found,

| OnDemand now checks for a user exit program in the monitor job’s library list
| with a name that matches the third attribute in the APPGRPSRC parameter of the
| STRMONOND command.

266 Common Server Administration Guide

| If a program is found, it is called, allowing both the application group and
| application names to be changed as needed. OnDemand then uses the new
| application group name to verify that an application group definition by that name
| exists.

| If a program is not found, OnDemand looks for an application group name that
| matches the third attribute.

| If a matching application group name is still not found, error messages are placed
| in the monitor job log. For an output queue monitor, the spooled file is moved, in
| Ready (RDY) status, to the error output queue (ERROUTQ) specified in the
| STRMONOND command. For a directory monitor, files will be left in the directory
| and have ’.ERR’ added to end of the file name.

| Special case – APPSRC(*APPGRP): If the value of the APPSRC parameter is

| *APPGRP, the monitor exit is called only for the APPGRPSRC parameter. The
| application name can still be changed by the exit program.

Exit program details

When OnDemand calls the user exit, it passes several parameters, only two of
which can be changed.

These two changeable fields are:

v Application group – 60 bytes
v Application – 60 bytes
For example, if the monitor finds PGM123 in the User Data spooled file attribute of
the spooled file, but you want OnDemand to use the application name INVOICES,
you can write your user exit program as follows:
CHGVAR VAR(&APP) VALUE('INVOICES')

There is a sample monitor output queue user exit program in the source file
QSAMPLES2 in the library QUSRRDARS, with member name PGM123.

Facsimile user exit program

The facsimile user exit program is designed to enable OnDemand server fax
functions to work with IBM i facsimile (fax) software other than Facsimile Support
from IBM. To accomplish this, modify and recompile the QRLMSFAX program
source code to change the command that is issued when an end user requests a
server fax during report retrieval. Simply change the line in the program that
issues the SNDFAX command to use the command for the fax software you have
installed on your system. (You could also call a program if no command is
available.)

An end-user requesting a server fax causes the QRLMSFAX program to be called.

If you do not change and recompile it, the standard program will run (which
issues the Facsimile Support command). If you do change and recompile the
QRLMSFAX program, then the changed program will run (which will issue your
facsimile command).

The sample CL source code for this program (member name QRLMSFAX) can be
found in source file QSAMPLES2 in libraries QRDARS and QUSRRDARS. (Any
program source code that you modify should not be placed in QRDARS because
that library is replaced during software upgrades. However, QUSRRDARS library

API and user exit reference 267

 is not replaced and can be used for your modified source.) IBM recommends that
you copy this source code into a backup member in case you need to go back to
the original function as shipped from IBM. When you recompile your program, be
sure to preserve the QRLMSFAX program name and place the compiled program
back in QRDARS library to replace the program that is shipped by IBM.

268 Common Server Administration Guide

Automating ARSLOAD data loading
This section provides information to help you configure the ARSLOAD data
loading API.
“ARSLOAD”

ARSLOAD
The ARSLOAD program is the main OnDemand data loading and indexing API.
You can configure the ARSLOAD API to monitor specific IFS directories for report
data. If the data needs to be indexed, then the ARSLOAD program calls the
indexing program that is specified in the OnDemand application. The ARSLOAD
program then works with the database manager to load the index data into the
database and works with the storage manager to load the report data and
resources on to storage volumes.

Note: The OnDemand server job must be running, otherwise the ARSLOAD
program will fail.
“Automating ARSLOAD”

Automating ARSLOAD
The following shows an example of the ARSLOAD API.

arsload -v -c /arsdir/dir4 -d /arsdir/dir1 -d /arsdir/dir2 -d /arsdir/dir3

In the example, the ARSLOAD program checks for data in the specified directories
every ten minutes (the default polling time). If data needs to be indexed, then the
ARSLOAD program stores the index data in the specified index directory.

You must verify the names of the directories. Replace the strings /arsdir/r1,
/arsdir/dir2, /arsdir/dir3, and /arsdir/dir4 with the names of directories that
are valid on the server that you are configuring.

Important: The ARSLOAD program uses a particular part of the input file name to
determine the application group to load. You can use the -G parameter to specify a
different part of the file name to identify the application group to load. If the
application group contains more than one application, then you must identify the
application to load. Otherwise, the load will fail. You can use the -A parameter to
specify the part of the file name that identifies the application.

If a user ID and password are not specified on the ARSLOAD program, the current
IBM i userid is used. See “API and user exit reference” on page 213 for more
information about the ARSLOAD program and its userid and password
parameters.

After indexing the data, the ARSLOAD program deletes the input files, unless you
specify otherwise. Any output or error messages that are generated by the
ARSLOAD program are written to the System Log. You can open the System Log
folder and retrieve any messages that were generated by the ARSLOAD program.
For example, you may see message number 87 for a successful load or message 88
for a failed load.

© Copyright IBM Corp. 1991, 2010 269

270 Common Server Administration Guide
Alternative to starting the administrative client
“Starting the Administrator”

Starting the Administrator

About this task

If you do not need to work with the Content Manager OnDemand administrative
functions that are supported directly thru the Content Manager OnDemand System
i Navigator component (such as tape volumes, tape devices, optical volumes,
optical storage groups, disk pool storage groups, monitor definitions, or migration
policies), you can go directly to the OnDemand Administrator by following the
instructions below:
1. Click Start.
2. Select Programs, then choose IBM OnDemand32.
3. Click OnDemand32 Administrator.
4. When you start the Administrator, Content Manager OnDemand opens the
administrator window that contains a menu bar, toolbar, navigator pane, list
pane, and status bar.
The following figure shows the administrator window.

Figure 46. Administrator main window

“Administrator start up parameters”

Administrator start up parameters

IBM Content Manager OnDemand provides parameters that you can specify as
properties that the operating system uses when you start the Administrator

© Copyright IBM Corp. 1991, 2010 271

 program. The parameters can be used, for example, to automate the logon process
and to select the areas that appear in the navigator pane. The following table lists
the start up parameters for the Administrator.
Table 15. Administrator start up parameters
Parameter Purpose Example
/1 location Identifies the drive and full path name of the /1 D:\Program Files\IBM\OnDemand32\
national language environment program file Locale\Enu
directory.
/B Include Applications in the navigator pane. /B
/D Include Folders in the navigator pane. /D
/D 2 Include Folders in the navigator pane, but /D 2
display only the Permissions and Field
Information pages.
/E Include Storage Sets in the navigator pane. /E
/I Include Users in the navigator pane. /I
/O Include Groups in the navigator pane. /O
/P password The password for the Content Manager /P password
OnDemand user identified with the /U
parameter. Use with the /S and /U
parameters to log on to a specific server,
without displaying the Logon dialog box. If
the logon is not successful, then Content
Manager OnDemand opens the Logon dialog
box to allow the user to log on to the system.
/Q Include Application Groups in the navigator /Q
pane.
/R Include Printers in the navigator pane. /R
/S server Identifies the logon server. Use with the /U /S broncos
and /P parameters to log on to a specific
server, without displaying the Logon dialog
box. If the logon is not successful, the
Content Manager OnDemand opens the
Logon dialog box to allow the user to log on
to the system.
/T Determines the name that appears on the title /T Customer Service
bar of the administrator window. The default
name is Content Manager OnDemand
Administrator.
/U userid Identifies the Content Manager OnDemand /U admin
user. Use with the /S and /P parameters to
log on to a specific server, without displaying
the Logon dialog box. If the logon is not
successful, Content Manager OnDemand
opens the Logon dialog box to allow the user
to log on to the system.

“Changing start up parameters” on page 273

“Examples” on page 273

272 Common Server Administration Guide

Changing start up parameters
About this task

To change start up parameters:

1. Click Start.
2. From the pop-up menu, select Explore.
3. Under Start Menu, expand Programs.
4. Select IBM OnDemand32.
5. In the list pane, point to OnDemand32 Administrator and click the right
mouse button.
6. From the pop-up menu, select Properties.
7. Click the Shortcut tab.
8. In the Target field, enter the startup parameters. Make sure that you enter any
startup parameters after the string:
"D:\Program Files\IBM\OnDemand32\ARSADM32.EXE"
/1 D:\Program Files\IBM\OnDemand32\LOCALE\ENU
9. Click OK.

Results

The next time that you start the administrative client, Windows uses the start up
parameters and values that you specified.

Examples
The following program properties could be used to set up the Administrator so
that when a person starts the program, the name Customer Service is displayed in
the title bar of the administrator window.
"D:\Program Files\IBM\OnDemand32\ARSADM32.EXE"
/1 D:\Program Files\IBM\OnDemand32\LOCALE\ENU /T "Customer Service"

The following program properties could be used to set up the Administrator so

that when a person starts the program, IBM Content Manager OnDemand displays
only users and folders in the navigator pane. When the user selects folders,
Content Manager OnDemand displays only the Permissions and Field Information
pages.
"D:\Program Files\IBM\OnDemand32\ARSADM32.EXE"
/1 D:\Program Files\IBM\OnDemand32\LOCALE\ENU /I /D 2

The following program properties could be used to set up the Administrator so

that when a person starts the program, Content Manager OnDemand attempts to
log on to the specified server, without displaying the Logon dialog box. If the
logon attempt is not successful, then Content Manager OnDemand opens the
Logon dialog box to allow the user to log on to the system.
"D:\Program Files\IBM\OnDemand32\ARSADM32.EXE"
/1 D:\Program Files\IBM\OnDemand32\LOCALE\ENU /S peak /U admin /P pw

Alternative to starting the administrative client 273

274 Common Server Administration Guide
Appendix. Accessibility features
This product includes a number of features that make it more accessible for people
with disabilities. These features include:
v The ability to operate all features using the keyboard instead of the mouse.
v Support for enhanced display properties
v Options for audio and visual alert cues
v Compatibility with assistive technologies
v Compatibility with operating system accessibility features
v Accessible documentation formats

Keyboard input and navigation

Keyboard input
The OnDemand clients can be operated using only the keyboard. Menu
items and controls provide access keys that allow users to activate a
control or select a menu item directly from the keyboard. These keys are
self-documenting, in that the access keys are underlined on the control or
menu where they appear.
Keyboard focus
In Windows-based systems, the position of the keyboard focus is
highlighted, indicating which area of the window is active and where the
user’s keystrokes will have an effect.

Features for accessible display

The clients have a number of features that enhance the user interface and improve
accessibility for users with low vision. These enhancements include support for
high-contrast settings and customizable font properties.
High-contrast mode
The clients support the high-contrast-mode option that is provided by the
operating system. This feature assists users who require a higher degree of
contrast between background and foreground colors.
Font settings
In Windows-based systems, you can specify display settings that determine
the color, size, and font for the text in menus and dialog windows. The
client allows you to select the font for the document list.
Non-dependence on color
You do not need to distinguish between colors in order to use any function
of this product.
Alternative alert cues
In Windows-based systems, the SoundSentry feature can be used to
provide visual feedback for general application and system alerts such as
warning beeps.
Compatibility with assistive technologies
The clients are compatible with screen reader applications such as Narrator
and Via Voice. The clients have properties required for these accessibility
applications to make onscreen information available to visually impaired
users.

© Copyright IBM Corp. 1991, 2010 275

| Fully accessible alternatives for the line data viewer and the AFP
| plugin

| To perform functions of the line data viewer and the AFP plugin, use the client or
| administrative client. At this time, functions of the line data viewer and the AFP
| plugin are not accessible through the Web administrator.

Accessible documentation

Documentation for the OnDemand product is available in HTML format. This

allows users to view documentation according to the display preferences set in
their browsers. It also allows the use of screen readers and other assistive
technologies.

276 Common Server Administration Guide

Notices
This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user’s responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan Ltd.
1623-14, Shimotsuruma, 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, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.

This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. 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.

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. 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.

© Copyright IBM Corp. 1991, 2010 277

 IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

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, should contact:

IBM Corporation
Software Interoperability Coordinator
3605 Highway 52 N
Rochester, MN 55901–7829
U.S.A.

Such information may be available, subject to appropriate terms and conditions,

including in some cases, payment of a fee.

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,
IBM International Program License Agreement or any equivalent agreement
between us.

Any performance data contained herein was determined in a controlled

environment. Therefore, the results obtained in other operating environments may
vary significantly. 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. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of

those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

All statements regarding IBM’s future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which

illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample

278 Common Server Administration Guide

 programs are provided ″AS IS″, without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.

Trademarks
This topic lists IBM trademarks and certain non-IBM trademarks.

IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries,
or both. If these and other IBM trademarked terms are marked on their first
occurrence in this information with a trademark symbol (® or ™), these symbols
indicate U.S. registered or common law trademarks owned by IBM at the time this
information was published. Such trademarks may also be registered or common
law trademarks in other countries. A current list of IBM trademarks is available on
the Web at ″Copyright and trademark information″ at http://www.ibm.com/legal/
copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:

Adobe, Acrobat, Portable Document Format (PDF), PostScript®, and all

Adobe-based trademarks are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States, other countries, or both.

Intel®, Intel, Intel logo, Intel Inside®, Intel Inside logo, Intel® Centrino®, Intel
Centrino logo, Celeron®, Intel® Xeon®, Intel SpeedStep®, Itanium®, Pentium, and
Xeon are trademarks or registered trademarks of Intel Corporation or its
subsidiaries in the United States and other countries.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the
United States, other countries, or both.

Linux is a registered trademark of Linus Torvalds in the United States, other

countries, or both.

Microsoft, Windows, and the Windows logo are trademarks of Microsoft

Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Other company, product, or service names may be trademarks or service marks of

others.

Notices 279
280 Common Server Administration Guide
Index
Numerics APIs
how to read a syntax diagram 215
ARSLOAD (continued)
starting 269
128 ApplGrp Segment Expire 3 reference 213 ARSLOAD.CFG file 249
14 DB Info Exported 6 application group/folder ARSSUPPORT utility 192
166 ApplGrp Segment Export 6 administrator 69, 70 ARSXML
168 ApplGrp Segment Not Available 8 application groups 249 reference 256
196 Cache Expiration 19 access permission 76 assistants and wizards 60
197 Cache Migration 17 adding 112, 114 authority
201 Concurrent Licenses 191 administrator 69 create application groups 70
202 Concurrent Licenses 191 administrator permission 76 create folders 70
87 ApplGrp Load (System Migration) 6 annotation permission 76 create groups 70
concepts 72 create users 70
defining 112, 114, 146, 155, 164 requirements 97
A document permission 76
accessibility 275 documents
adding maintaining 17, 19
expiration processing 3, 8, 19
B
application groups 112 backup and recovery
applications 112 fields
database 152
folders 112 defining 114
reports and resources 42
groups 105 FORMS parameter 249
backup considerations 41
primary storage nodes 112 importing and exporting 173
batch system administration 173
printers 110 importing migrated index data 8
Common problems during
reports 112 importing migrated indexes 7
installation 175
server printers 110 index data
installation verification 174
servers 50 maintaining 3, 6, 7
installing 173
storage nodes 112 logical views permission 76
installing Xerces2 Java Parser 174
storage sets 112 maintenance 3, 6, 7, 17, 19
prerequisites 173
users 97 messages 3, 6, 7, 17, 19
users to a group 106 migration processing 6, 7, 8, 17
administrative client overview 72
adding servers 50 permissions 76, 114 C
assistants and wizards 60 query restriction 76 cabinets
changing a password 51 storage management 114 importing and exporting 173
hardware requirements 45 Application Program Interfaces commands
installing 45 (APIs) 213 adding documents 221
logging on a server 50 applications ADDRPTOND 197
passwords 51 adding 112, 124 CHGPLDOND 15, 65, 198
program properties 271 AFP data 125 CRTINSTOND 198
report wizard 60 concepts 73 data, loading 248
software requirements 45 DATASET parameter 249 deleting documents 221
start up parameters 271 defining 112, 124, 147, 157, 165 documents, adding, deleting, getting,
starting 50 fields printing, updating 221
using 49 defining 125 documents, loading 248
wizards and assistants 60 importing and exporting 173 ENDMONOND 197
administrators indexes exporting an XML file 256
application group/folder defining 125 FNDKEYOND 197
administrator 69 indexing parameters 125 getting documents 221
folder administrator 69 load information 125 importing an XML file 256
system administrator 69 overview 73 loading data, documents, reports 248
user administrator 69 print options 125 MGRMEDRDAR 198
advanced system administration triggers 125 MRGSPLFOND 199
native Lightweight Directory Access archive storage manager, migration printing documents 221
Protocol (LDAP) support 83 processing 8 PRTRPTOND 197
Enabling LDAP authentication 83 ARSDATE PRTTXTOND 197
How Content Manager OnDemand reference 217 reports, loading 248
works with LDAP 83 ARSDOC RMVRPTOND 197
LDAP server requirements 83 reference 221 STRASMOND 197
AFP data, indexing 125 ARSLOAD STRDSMOND 197
aggregation 65, 95 automating 269 STRIMPOND 197
annotation permission 76 reference 248 STRMONOND 197
annotations 55 running 160, 168 updating documents 221

© Copyright IBM Corp. 1991, 2010 281

commands (continued)
XML file, exporting 256
DB2 (continued)
tables 2
G
XML file, importing 256 defining generic indexer parameter file 159, 167
concurrent users monitoring 191 application groups 112 graphical indexer 60
Content Manager OnDemand applications 112 group administration 105
date formats 217 folders 112 group owner 71
internal date format 217 groups 105 groups
conventions primary storage nodes 112 adding 105
group name 71 printers 110 adding users 106
user name 68 reports 112 assigning users 106
copying items 58 server printers 110 concepts 71
create application groups authority 70 storage nodes 112 defining 105
create folders authority 70 storage sets 112 importing and exporting 173
create groups authority 70 users 97 naming 71
create users authority 70 deleting a report 187 overview 71
creating an XML file 178 deleting index data 3, 7 owner 71
disability 275 permissions 76
document permission 76
D drag and drop operations 59
H
data
adding 221 how to read a syntax diagram 215
deleting 3, 18, 221 E
deleting a report 187 Enabling LDAP authentication 83
estimating storage space for 146 error messages 203 I
expiration processing 3, 18 estimating storage space 146 image files
importing migrated indexes 7 expiration of passwords 52 index data 159
life of 3 expiration processing 3, 7 loading 155
loading 145, 155, 163, 248 expired passwords 52 importing migrated index data 7
migration processing 5, 7, 15 exporting items 59 inactivity time out 53
printing 221 index data
restarting a load process 171 about 2
retrieving 221
unloading 187
F adding 221
facsimile parameters 210 creating 159, 167
updating 221 deleting 3, 7, 187, 221
facsimile user exit program 267
data loading 269 expiration processing 3, 7
fax parameters 210
database fields
fax user exit program 267
adding index data 150 defining 125
fields
backup 152 generic indexer 159, 167
application group
concepts 1 importing 7
defining 114
deleting index data 3, 7 indexes
database
expiration processing 3, 7 defining 125
defining 114
fields life of 3
defining 114, 135
defining 114 load information 125
folder
importing migrated index data 7 loading 145, 155, 163, 248
defining 135
maintenance 3 migration processing 5, 7
indexing
migration processing 5, 7 processing with postprocessor
defining 125
segment table 150 programs 125
fields permission 76
updating 221 restarting a load process 171
FILESTAT error codes 196
database manager 1 retrieving 221
folder administrator 69
DATASET parameter triggers 125
folders
applications 249 updating 221
access permission 76
ARSLOAD program 249 indexes
adding 112, 134
date defining 125
administrator 69
Content Manager OnDemand internal installing batch system administration
administrator permission 76
format 217 prerequisites 173
concepts 73
formats of 217 installing the administrative client 45
defining 112, 134, 158, 166
internal format 217 instances 1
fields
obtaining Content Manager internal date format 217
defining 135
OnDemand internal format 217
fields permission 76
DB2
importing and exporting 173
concepts 1
database 1
named queries permission 76 J
overview 73 journal receivers 2
importing migrated index data 9
permissions 76, 135
indexes 2
FORMS parameter
instances 1
journals 2
application groups 249
ARSLOAD program 249
K
systems 1 keyboard 275

282 Common Server Administration Guide

L OnDemand XML files
creating for delete and export 183
reports (continued)
deleting 187, 221
LDAP 83 creating for update 181 estimating storage space for 146
LDAP authentication 56 optical volume statistics reset 80 loading 145, 248
licenses, monitoring 191 OS/400 printer file 209 printing 221
life of data and indexes 3, 5 Output queue monitors 147 restarting a load process 171
load user exit 249 output queue or directory monitor user retrieving 221
loading data 145, 155, 163, 269 exit program 264 unloading 187
loading image files 155 Output queue or directory monitor user updating 221
loading index data 145, 155, 163 exit program requirements
loading reports 145 overview of function 265 hardware 45
loading user-defined data 163 Output queue or directory monitor user software 45
logging on a server 51 exit program processing 265 resetting optical volume statistics 80
logical views permission 76 resources 151
login processing 54 restarting a load process 171
P
M password 54
password length 51 S
managing servers 197 passwords 51, 52, 53 security and user administration 97, 105
maximum password age 52 specifying in ARSLOAD 249 segment table 150
messages permissions server fax parameters 210
128 ApplGrp Segment Expire 3 about 75 server fax user exit program 267
14 DB Info Exported 6 application groups 76, 114 server print parameters 209
166 ApplGrp Segment Export 6 concepts 75 server printers
168 ApplGrp Segment Not examples 76 adding 110
Available 8 folders 76, 135 concepts 71
196 Cache Expiration 19 overview 75 defining 110
197 Cache Migration 17 strategies 80 options 125
201 Concurrent Licenses 191 postprocessor program 125 overview 71
202 Concurrent Licenses 191 primary storage nodes servers
87 ApplGrp Load (System adding 112 adding 50
Migration) 6 concepts 72 adding items 58
application groups 3, 6, 8, 17, 19 defining 112 copying items 58
errors and alerts 189, 203 overview 72 drag and drop operations 59
expiration processing 3, 19 print parameters 209 exporting items 59
licenses 191 printer file 209 logging on 51
migration processing 6, 8, 17 printers system parameters 56
OnDemand errors and alerts 189, 203 adding 110 updating 50
System Log 189, 203 concepts 71 start up parameters 271
MGRMEDRDAR 198 defining 110 starting the administrative client 50
migration processing 5, 7 importing and exporting 173 storage
minimum password length 53 options 125 administration 112
monitor 147 overview 71 for reports 146
monitor exit program parameters 267 printing documents 209, 221 management 114
monitoring program properties 271 storage nodes
concurrent users 191 programs adding 112
licenses 191 date formats 217 concepts 72
users 191 internal date format 217 defining 112
obtaining Content Manager loading data 150
OnDemand internal format 217 overview 72
N storage sets
named queries permission 76 adding 112
naming groups 71 Q assigning to an application
group 114
naming users 68 query restriction 76
concepts 72
defining 112
O R
importing and exporting 173
loading data 150
obtaining Content Manager OnDemand receivers, journal 2 migration processing 8
internal date format 217 recovery considerations 42 overview 72
OnDemand object report specifications archive definition System Migration application
child objects 180 exit 249 group 8
end of object 180 report wizard 60 STRIMPOND command 10
object attributes 180 reports subsystem, changing server jobs 193
Start of Object 180 adding 112, 221 syntax diagram, how to read 215
OnDemand objects 179 backup and recovery 42 system administrator 69
defining 112

Index 283
System Log user exits (continued)
error messages 203 load user exit 249
message reference 203 migration processing 8
System Log messages output queue or directory monitor
128 ApplGrp Segment Expire 3 user exit program 264
14 DB Info Exported 6 reference 264
166 ApplGrp Segment Export 6 saving messages in the System
168 ApplGrp Segment Not Log 54
Available 8 server fax user exit program 267
197 Cache Migration 17 System Log 8
201 Concurrent Licenses 191 user-defined data
202 Concurrent Licenses 191 index data 167
87 ApplGrp Load (System loading 163
Migration) 6 userid 54
application groups 3, 6, 8, 17, 19 specifying in ARSLOAD 249
enabling 54 users
expiration processing 3, 19 adding 97
loading data 151, 162, 170 adding to a group 106
migration processing 6, 7, 17 application group/folder
monitoring 189 administrator 69
user exit programs 54 assigning to a group 106
user messages 191 authority 70, 97
System Log user exit program 8 changing a password 51
System Migration application group 8 concepts 68
system parameters defining 97
about 52 folder administrator 69
annotations 55 importing and exporting 173
inactivity time out 53 licenses 191
login processing 54 monitoring 191
maximum password age 52 naming 68
minimum password length 53 overview 68
password 54 passwords 51
password age 52 permissions 75, 76
password expiration 52 system administrator 69
password length 53 types 69
passwords 53 user 69
setting 56 user administrator 69
System Log 54 using the administrative client 49
time out 53
user exit logging 54
userid 54
systems 1
W
wizards and assistants 60

T X
tables 2
Xerces2 Java Parser 174
time out 53
XML file
trace parameters
creating 178
error 58
exporting 256
flow 58
importing 256
information 58
XML schema file 176
setting 58
warning 58
triggers
defining 125

U
unloading a report 187
update servers dialog box 50
user 69, 70
user administration 97
user administrator 69, 70
user exits
facsimile user exit program 267
fax user exit program 267

284 Common Server Administration Guide




Program Number: 5770-RD1

SC19-2792-00