Difference between revisions of "ars.cfg"

Jump to navigation Jump to search
1,741 bytes added ,  15:32, 29 October 2017
m
Added IBM CMOD ARS_DB2 parameters.
(Initial edit of ars.cfg configuration file.)
 
m (Added IBM CMOD ARS_DB2 parameters.)
Line 1: Line 1:
{{TOCright}}
{{TOCright}}


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.
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 Header, License, & Language CMOD Configuration ==
Line 128: Line 128:


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


   #
   #
Line 138: Line 137:
   #
   #
   ARS_DB_IMPORT=0
   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.  [https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.installmp.doc/dodax012.htm v9.5]


   #  
   #  
Line 144: Line 146:
   #
   #
   ARS_DB_PARTITION=
   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.


[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.installmp.doc/dodax013.htm v9.5]


   ########################################
   ########################################
Line 151: Line 157:
   DB2INSTANCE=archive
   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
   # These parameters used only during database creation
Line 159: Line 170:
   ARS_DB2_LOGFILE_SIZE=1000
   ARS_DB2_LOGFILE_SIZE=1000
   ARS_DB2_LOG_NUMBER=40
   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.


   #
   #
Line 164: Line 196:
   #
   #
   ARS_DB2_TSM_CONFIG=/opt/tivoli/tsm/client/api/bin/dsm.opt.db2
   ARS_DB2_TSM_CONFIG=/opt/tivoli/tsm/client/api/bin/dsm.opt.db2
  ###########################################
  # ORACLE Parameters (Library Server Only) #
  ###########################################
  ARS_ORACLE_HOME=/oracle




Line 183: Line 222:
;ARS_PRINT_PATH=
;ARS_PRINT_PATH=
: This specifies the temporary directory used for creating temporary files for printing.
: 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 ===
=== Special Considerations for IBM CMOD temporary files ===
Line 188: Line 231:


== CMOD LDAP Configuration ==
== 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 ==  
== CMOD Storage Management Configuration ==  
  ######################################################
  # Storage Manager Parameters (Library/Object Server) #
  ######################################################
  #
  # Storage Manager for OnDemand to use
  #
  ARS_STORAGE_MANAGER=TSM


== Unlisted Parameters ==
== Unlisted Parameters ==
Line 203: Line 267:




#######################
# Database Parameters #
#######################
#
# Database for OnDemand to use (Library Server Only)
#
ARS_DB_ENGINE=DB2
#
# 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
#
# Used to specify if the database supports partitioning (Library Server Only)
#  Blank (No partition support)
#
ARS_DB_PARTITION=
########################################
# DB2 Parameters (Library Server Only) #
########################################
DB2INSTANCE=archive
#
# 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
#
# 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
######################################################
# Storage Manager Parameters (Library/Object Server) #
######################################################
#
# Storage Manager for OnDemand to use
#
ARS_STORAGE_MANAGER=TSM
ARS_MESSAGE_OF_THE_DAY=
ARS_TRACE_SETTINGS=
###########################################
# 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=


#######################################
#######################################

Navigation menu