ars.cfg

ars.cfg is the main IBM CMOD configuration file. The default OnDemand configuration file doesn't contain all of the parameters that are recognized by the server - those parameters are listed at the end of this article. This configuration file is from IBM Content Manager OnDemand 10.1 for Linux.

ars.cfg Header, License, & Language CMOD Configuration

 #
 #       ars.cfg - OnDemand Configuration File 
 #
 #  5622-662 (C) COPYRIGHT IBM CORPORATION 2001
 #  All Rights Reserved
 #  Licensed Materials - Property of IBM
 #
 #  US Government Users Restricted Rights - Use, duplication or
 #  disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 #
 #  This program sample is provided on an as-is basis.
 #  The licensee of the OnDemand product is free to copy, revise,
 #  modify, and make derivative works of this program sample
 #  as they see fit.  
 #
 # File Format:
 #       1) Comments must begin with a # in the first column
 #       2) Comments cannot exist on the same line as a PARM
 #       3) PARM=VALUE, no spaces before PARM, no spaces after VALUE,
 #          and no spaces before/after the equal sign.
 #       4) Blank lines are ignored.
 #
 # NOTE:  Please see documentation for configuring these parameters.
 #
 #######################
 # OnDemand Parameters #
 #######################
 #
 # Number of client licenses (Library Server Only) 
 #
 #  - This should be set to however many licenses are purchased
 #
 ARS_NUM_LICENSE=1
 #
 # Language used to create the database (Library Server Only)
 #  - This should be set during installation and should never be changed 
 #
 ARS_LANGUAGE=ENU

ARS_NUM_LICENSE

This parameter determines the number of permitted end-user licenses that CMOD is configured to allow. When the server exceeds this number, the non-compliant use is permitted, but messages are logged into the OnDemand System Log to notify the administrator. Contact your software procurement team to determine the number of licenses your organization is entitled to.

ARS_LANGUAGE

This is the three-alpha ISO code for the language you would like CMOD to use for messages and output.

CMOD Object Server Configuration

This block is largely deprecated. Maintaining separate CMOD object and library servers is uncommon now that limitations on the amount of storage any one server can access has been eliminated by technologies like NFS, SAN, and Cloud-based storage.

 #
 # Object Server/Library Server definitions (Object Server Only)
 #
 #   If Object Server then set
 #
 #     ARS_SRVR=<server>
 #        <server> is name of the OnDemand Library Server
 #
 #     ARS_LOCAL_SRVR=<server>
 #        <server> is name of the local OnDemand Object Server
 #
 #   For Example:
 #
 #      Server Type (hostname)
 #     |----------------------|
 #     | ObjServer   (ObjSrv1)|
 #     |----------------------|
 #
 #     |----------------------|
 #     | LibServer   (LibSrvr)|
 #     |----------------------|
 #
 #     |----------------------|
 #     | ObjServer   (ObjSrv2)|
 #     |----------------------|
 #
 #   LibSrvr:
 #     Neither Variable should be set
 #
 #   ObjSrv1:
 #     ARS_SRVR=LibSrvr
 #     ARS_LOCAL_SRVR=ObjSrv1
 #
 #   ObjSrv2:
 #     ARS_SRVR=LibSrvr
 #     ARS_LOCAL_SRVR=ObjSrv2
 #
 # NOTES:
 #        - These names should be exactly what is specified for the server
 #          in the storage node
 #        - If CICS client is being used you must specifiy the machines
 #          internet address instead of hostname or alias.
 #
 #
 ARS_SRVR=
 ARS_LOCAL_SRVR=

ARS_SRVR

The hostname of the CMOD Library Server. This name should be a fully qualified domain name for reliability. (Library.cmod.example.com)

ARS_LOCAL_SRVR

The hostname of the CMOD Object Server. This name should be a fully qualified domain name for reliability. (Object1.cmod.example.com, Object2.cmod.example.com)

CMOD Database Configuration

 #
 # Number of Database SubServers (Library Server Only)
 #   0         - Defaults to connection per client
 #   Otherwise - The number of Database SubServers to handle connections
 #               to the database (minimum of 2) 
 #
 ARS_NUM_DBSRVR=4

ARS_NUM_DBSRVR

The ARS_NUM_DBSRVR parameter specifies the number of 'subservers' or database connections to create to the database. In larger systems, increasing this number may have performance benefits, at the expense of using additional RAM.

Increasing ARS_NUM_DBSRVR number too high may result in poor performance if not enough RAM is available.

Setting ARS_NUM_DBSRVR to 0 (zero) on large systems may cause performance issues during spikes in activity, as each new connection to CMOD creates a new Subserver, which may consume all available RAM.

 #
 # Database for OnDemand to use (Library Server Only)
 #
 ARS_DB_ENGINE=DB2

ARS_DB_ENGINE

Specifies the database engine to be used, usually DB2 or Oracle.

 #
 # Used for arstblsp command and reloading migrated tables (Library Server Only)
 #   0 (import)
 #   1 (load w/TSM - DB2 only)
 #   2 (load w/DISK - DB2 only, using ARS_TMP)
 #
 ARS_DB_IMPORT=0

ARS_DB_IMPORT

In the early days of CMOD, when storage space was prohibitively expensive, OnDemand had the ability to 'archive' infrequently used database tables in the same way that it archived data to TSM. As storage prices have fallen and data compression in database engines has become common, this method of reducing the use of disk space has become essentially obsolete. v9.5

 # 
 # Used to specify if the database supports partitioning (Library Server Only)
 #   Blank (No partition support)
 #
 ARS_DB_PARTITION=

ARS_DB_PARTITION

If your database engine supports partitioning, change this parameter to 1 on the library server. Application Groups which should support partitioning must have a field defined to hold the partition data.

This configuration parameter is only intended for the very largest of CMOD servers holding hundreds of billions of documents, and serving tens of thousands concurrent users.

v9.5

 ########################################
 # DB2 Parameters (Library Server Only) #
 ########################################
 DB2INSTANCE=archive

DB2INSTANCE

Specifies the name of the database to use for storing document metadata.

CMOD Database Creation

These parameters should be defined before issuing the arsdb command with the -c, -r, or -t options.

 #
 # These parameters used only during database creation
 #
 ARS_DB2_DATABASE_PATH=/arsdb
 ARS_DB2_PRIMARY_LOGPATH=/arsdb_primarylog
 ARS_DB2_ARCHIVE_LOGPATH=/arsdb_archivelog
 ARS_DB2_LOGFILE_SIZE=1000
 ARS_DB2_LOG_NUMBER=40

ARS_DB2_DATABASE_PATH

This parameter describes where the main database should be created. Additional storage can be defined in the ars.dbfs configuration file.

ARS_DB2_PRIMARY_LOGPATH

This is where the databases transaction logs will be stored while CMOD is in operation.

The filesystems specified for storing database transaction logs should be the fastest and most reliable storage your organization has to offer.

ARS_DB2_ARCHIVE_LOGPATH

This is the filesystem where transaction logs will be 'archived' to create space for new transaction logs.

The size of this filesystem will be largely determined by how much logging and loading is done with CMOD.

ARS_DB2_LOGFILE_SIZE

The size of an individual database transaction log file. The size is this parameter (default of 1000) is multiplied by your database's page size (default of 4 kilobytes).

It's is strongly suggested to tune the size of this file to be up to 250MB in size for CMOD servers to reduce overhead in managing transaction logs.

ARS_DB2_LOG_NUMBER

This parameter specifies the number of transaction log files to keep.

The number of logs multiplied by the log file size parameter above determines how large your primary log filesystem should be, and how large your archive filesystem should be.

 #
 # DB2/TSM Parameters
 #
 ARS_DB2_TSM_CONFIG=/opt/tivoli/tsm/client/api/bin/dsm.opt.db2

 ###########################################
 # ORACLE Parameters (Library Server Only) #
 ###########################################
 ARS_ORACLE_HOME=/oracle

CMOD Miscellaneous Configuration

 #
 # OnDemand Temporary Work Directory (Library/Object Server)
 #
 # NOTE:  This directory should have permissions just like /tmp
 #        drwxrwxrwt   /tmp        These perms are 1777
 #
 ARS_TMP=/tmp
 ARS_PRINT_PATH=/tmp

ARS_TMP

This specifies the temporary directory where Content Manager OnDemand should place its temporary files during processing.

ARS_PRINT_PATH=

This specifies the temporary directory used for creating temporary files for printing.

 ARS_MESSAGE_OF_THE_DAY=
 ARS_TRACE_SETTINGS=

Special Considerations for IBM CMOD temporary files

Some of the files that OnDemand stores are extremely large. It's a good idea to set aside a separate 'temporary' filesystem with it's own storage that is NOT shared with the operating system, database, or other data. Using the operating system's default temporary directory can cause problems on the server if the filesystem becomes full. You may experience problems like being unable to log in, being unable to list directory contents, or run basic commands that create temporary files.

CMOD LDAP Configuration

 ###########################################
 # LDAP Parameters (Library Server Only)   #
 ###########################################
 ARS_LDAP_SERVER=
 ARS_LDAP_PORT=
 ARS_LDAP_BASE_DN=
 ARS_LDAP_BIND_DN=
 ARS_LDAP_BIND_DN_PWD=
 ARS_LDAP_BIND_ATTRIBUTE=
 ARS_LDAP_MAPPED_ATTRIBUTE=
 ARS_LDAP_ALLOW_ANONYMOUS=

CMOD Storage Management Configuration

 ######################################################
 # Storage Manager Parameters (Library/Object Server) #
 ######################################################

 #
 # Storage Manager for OnDemand to use
 #
 ARS_STORAGE_MANAGER=TSM

Unlisted Parameters

ODWEK Load Parameters

When loading data via the ODWEK Java API, attempts to load may fail with the error "The server failed while storing a document", because there in not enough space available in the ARS_TMP filesystem to complete the load. You can specify a separate temporary directory for downloaded data to be loaded into IBM CMOD:

ARS_DOWNLOAD_DIR

The directory where data is stored in preparation for ODWEK loading.

ARS_DOWNLOAD_TMP_DIR

The directory where temporary files created during ODWEK loading will be stored.

2. TSM Parameters (Object Server Only) #

DSMSERV_DIR=/opt/tivoli/tsm/server/bin DSMSERV_CONFIG=/opt/tivoli/tsm/server/bin/dsmserv.opt DSM_DIR=/opt/tivoli/tsm/client/api/bin64 DSM_CONFIG=/opt/tivoli/tsm/client/api/bin64/dsm.opt DSM_LOG=/tmp DSMG_DIR=/opt/tivoli/tsm/client/api/bin64 DSMG_CONFIG=/opt/tivoli/tsm/client/api/bin64/dsm.opt DSMG_LOG=/tmp DSMI_DIR=/opt/tivoli/tsm/client/api/bin64 DSMI_CONFIG=/opt/tivoli/tsm/client/api/bin64/dsm.opt DSMI_LOG=/tmp