View source for ars.cfg

{{TOCright}}

ars.cfg is the main IBM CMOD configuration file.  The default IBM Content Manager 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 ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand Configuration File &nbsp; 
|-
|
  #
  #       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.

== IBM CMOD Premium Feature Pack Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! IBM Content Manager OnDemand Premium Feature Pack Parameters &nbsp; 
|-
|
  #  Enable Filenet Content Federation Service - OnDemand
  ARS_SUPPORT_CFSOD=1
  
  # Enable IBM CMOD ERM - IBM Content Manager OnDemand Enhanced Retention Management 
  ARS_SUPPORT_ERM=1
  
|}

After installing the IBM CMOD Feature Pack, add the parameters to the Content Manager OnDemand Configuration File [[ars.cfg]] (UNIX & Linux platforms) or enable it in the IBM Content Manager OnDemand Configurator (Windows).

;ARS_SUPPORT_CFSOD
: Set this parameter to 1 if you are licensed to use the Content Manager OnDemand Content Federation System for OnDemand ("IBM CMOD CFS:OD") feature.

;ARS_SUPPORT_HOLD
: Set this parameter to 1 if you are licensed to use the Content Manager OnDemand Enhanced Retention Management ("IBM CMOD ERM") feature.

Also:  [[ars.cfg#IBM_CMOD_Server_Parameters|Unlisted CMOD Server Options]].

==  IBM 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.

{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand Object Server Configuration &nbsp;   
|-
|
  #
  # 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)

; ARS_STORAGE_MANAGER
: This CMOD parameter configures the server to be 'Cache Only' with no secondary storage management, or 'TSM', which enables storage management with Tivoli Storage Manager (previously "ADSM" or "ADSTAR Distributed Storage Manager", now "Spectrum Protect" as of 2018) or the IBM CMOD cloud storage options in Content Manager OnDemand v9.5.0.4 and higher.  Older versions of CMOD used the "ADSM" parameter,  Also see the [[ars.cfg#CMOD_Storage_Management_Configuration|CMOD Storage Management]] section for more information on configuring CMOD with TSM.

== IBM CMOD Database Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample Content Manager OnDemand Database Configuration &nbsp;   
|-
|
  #
  # 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

  #
  # 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
|}

;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.
: The default of four should work for most non-public-facing Content Manager OnDemand servers.  If your IBM CMOD server is exposed to external customers (via ODWEK / or ICN) you may need to increase this value.  We recommend increasing 2-3x and testing the performance using the [[arssockd]] command with the -px options.
: 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.
; ARS_DB_ENGINE
: Specifies the database engine to be used.  This parameter must be one of the following values: DB2, ORACLE, or MSSQL.

; 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] 

;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]
;DB2INSTANCE
: Specifies the name of the database to use for storing document metadata.

=== IBM CMOD Database Creation ===
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand Database Creation Parameters &nbsp;   
|-
|
  #
  # 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

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

;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.

{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand DB2 TSM Configuration Parameters &nbsp;   
|-
|
  #
  # DB2/TSM Parameters
  #
  ARS_DB2_TSM_CONFIG=/opt/tivoli/tsm/client/api/bin/dsm.opt.db2
|}

;ARS_DB2_TSM_CONFIG
: This is the configuration file for Tivoli Storage Manager used by DB2 for transaction log archiving and automatic backup & restores.

{| class="mw-collapsible mw-collapsed wikitable"
! Sample Content Manager OnDemand Oracle Configuration Parameters &nbsp;   
|-
|
  ###########################################
  # ORACLE Parameters (Library Server Only) #
  ###########################################
  ARS_ORACLE_HOME=/oracle
|}

;ARS_ORACLE_HOME
: Points CMOD to the directory where oracle is installed.

== IBM CMOD Miscellaneous Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand Miscellaneous Configuration Parameters &nbsp;   
|-
|
  #
  # 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_MESSAGE_OF_THE_DAY=
  ARS_TRACE_SETTINGS=
|}

;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_USE_USER_PRINT_OPTIONS
: Set to 1 to enable the use of user print options when printing.  When absent from the config file or set to zero, the server defaults to the server configuration.

;ARS_MESSAGE_OF_THE_DAY
: Specifies a text file that will be displayed when users log in.  Excellent for advising all users of upcoming outages or maintenance, or problems experienced by the CMOD server.

;ARS_TRACE_SETTINGS
: Specifies the location of the file containing the trace settings to use.  Leave blank if you want tracing disabled.  There is a ''substantial'' performance penalty for enabling tracing, and it should be used for debugging purposes on non-production systems only.  The default trace settings file is: /opt/ibm/ondemand/V10.1/config/trace.settings 

=== Special Considerations for IBM CMOD temporary files ===
Some of the files that Content Manager 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.

== IBM CMOD LDAP Configuration ==
For more information on configuring CMOD for Lightweight Directory Access Protocol ("LDAP") or CMOD Active Directory ("AD") access, visit: [https://www-01.ibm.com/support/docview.wss?uid=swg21597246 Content Manager OnDemand LDAP authentication process]

{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand LDAP Configuration Parameters &nbsp;   
|-
|
  ###########################################
  # LDAP Parameters (Library Server Only)   #
  ###########################################
  
  ARS_LDAP_SERVER=server1.ldap.example.com
  ARS_LDAP_PORT=
  ARS_LDAP_USE_SSL=FALSE
  ARS_LDAP_BASE_DN=ou=examplegroup,o=example.com
  ARS_LDAP_BIND_ATTRIBUTE=userid
  ARS_LDAP_MAPPED_ATTRIBUTE=userid
  ARS_LDAP_ALLOW_ANONYMOUS=TRUE
  ARS_LDAP_BIND_MESSAGES_FILE=/opt/IBM/ondemand/V9.5/config/arsldap.ini

  ####################################################
  # LDAP SYNC Parameters (requires CMOD v10.1.0.2+)  #
  ####################################################
  ARS_LDAP_SERVER_TYPE=OPEN
  ARS_LDAP_USER_FILTER=(ObjectClass=USER)
  ARS_LDAP_GROUP_FILTER=(ObjectClass=GROUP)
  ARS_LDAP_GROUP_MAPPED_ATTRIBUTE=GROUPID
  ARS_LDAP_IGN_USERIDS=ADMIN,ARSLOAD,ARSMAINT
  ARS_LDAP_IGN_GROUPS=ADMINS,IT_SUPPORT,HELPDESK

|}

;ARS_LDAP_SERVER
: The fully qualified domain name for your organization's LDAP server.
;ARS_LDAP_PORT
: The TCP/IP port number used by your LDAP server's software.
: The default port is 389 if no value is specified.  
: A popular alternate port number is 3389.
;ARS_LDAP_BASE_DN
: The LDAP Base Distinguishing Name.
;ARS_LDAP_BIND_DN
: If your LDAP server requires a User ID and password to authenticate, this is the user name parameter.
;ARS_LDAP_BIND_DN_PWD
: If your LDAP server requires a User ID and password to authenticate, this is the password parameter.
;ARS_LDAP_BIND_ATTRIBUTE
: The name of the attribute that will be searched for on the LDAP server, and returned to CMOD.
;ARS_LDAP_MAPPED_ATTRIBUTE
: This value can be the same as, or different from the ARS_LDAP_MAPPED_ATTRIBUTE.
: Specify the LDAP field that should be returned and used as the CMOD User ID.
;ARS_LDAP_ALLOW_ANONYMOUS
: Set to TRUE if your LDAP server allows access without authentication. 
: Set to FALSE if your LDAP server requires a Distinguishing Name ("ARS_LDAP_BIND_DN") and password ("ARS_LDAP_BIND_DN_PWD").
;ARS_LDAP_BIND_MESSAGES_FILE
: Set this parameter to the file that contains human-friendly error messages for return codes from the LDAP server in case of failure.
: See the IBM CMOD Knowledge Centre for more information about [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.installmp.doc/dodlx010.htm ARSLDAP.INI]
: Only the PASSWORD_EXPIRED and ACCOUNT_LOCKED return codes from LDAP are currently supported in Content Manager OnDemand v10.1.
;ARS_LDAP_OD_AUTHORITY_FALLBACK
: If set to TRUE, falls back to authentication via the passwords stored in the IBM CMOD database if the UserID doesn't exist in Active Directory or LDAP, or the authentication server is down.
: If set to FALSE, fails to authenicate when the AD/LDAP server is not available to authenicate users, or the user does not exist in AD/LDAP.
: The only exception to this setting is the ADMIN user.
;ARS_LDAP_USE_SSL
: If set to TRUE, set the GSK_PROTOCOL_TLSV1_2=1 as well.

=== IBM CMOD LDAP Sync Parameters ===
These parameters are for LDAP User & Group syncing, and require IBM CMOD v10.1 Fixpack 2 or higher on Multiplatforms, and IBM CMOD iSeries/zSeries 10.1 Fixpack 3.  Despite the minimum version requirements, upgrading to CMOD v10.1 FixPack 4 on all platforms is recommended to receive critical bug fixes.  All of these parameters are REQUIRED for CMOD LDAP Sync to work.

;ARS_LDAP_SERVER_TYPE
: Specifies the type of LDAP server that CMOD will connect to:  AD for Active Directory, SUN for Java System Directory Server, or OPEN for the OpenLDAP project.
: Only one of the above types can be selected.
;ARS_LDAP_USER_FILTER
: Queries the LDAP server for IBM CMOD users that will be synced to OnDemand.
;ARS_LDAP_GROUP_FILTER
: Queries the LDAP server for IBM CMOD groups that will be synced to OnDemand.
;ARS_LDAP_GROUP_MAPPED_ATTRIBUTE
: Specifies the field to use for the IBM CMOD group name.
;ARS_LDAP_IGN_USERIDS
: '''''Only available in CMOD v10.1.0.3 and CMOD v10.5 and higher!'''''
: Populate with a list of up to 10 CMOD User IDs that are exempt from LDAP authentication, who will be authenticated by the password stored in the local OnDemand database.
: It's a very good idea to include CMOD administrators in this list, so they can still log in when your organization's LDAP server is down.
: If you have separate UserIDs for loading ("ARSLOAD") and maintenance ("ARSMAINT") it's a terrific idea to add them to this list of CMOD User ID's, so that normal production processing can continue, in the event of an LDAP server failure.
: In CMOD v10.5.0.1 and higher, the limit for CMOD User IDs has been increased to 100!  
;ARS_LDAP_IGN_GROUPS
: '''''Only available in CMOD v10.1.0.3 and CMOD v10.5 and higher!'''''
: Populate with a list of CMOD User IDs that are exempt from LDAP authentication, who will be authenticated by the password stored in the local OnDemand database.
: Specifies the CMOD group identifiers that CMOD will ignore when syncing.

== IBM CMOD SSO (Single Sign On) Parameters==
;ARS_TRUSTED_SSO_HOSTS
: Set to a single IP address of an IBM Content Navigator ("ICN") server, or a list of comma-separated IP addresses of multiple ICN servers to allow those hosts to use SSO.
: This parameter is REQUIRED to enable access Content Manager OnDemand with Single Sign On.  Without this parameter, OnDemand SSO will not work.

== IBM CMOD Storage Management Configuration == 
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand TSM Configuration Parameters &nbsp;   
|-
|
  ######################################################
  # Storage Manager Parameters (Library/Object Server) #
  ######################################################

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

  #######################################
  # 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
|}

The majority of these configuration parameters are only of interest if you are using the ars_adsm script.  Only the DSM_CONFIG and DSMI_CONFIG parameters are required if your TSM server is on another separate server.

;DSMSERV_DIR
: The directory where IBM Tivoli Storage Manager (now IBM Spectrum Protect) is installed.
;DSMSERV_CONFIG
: The configuration file for the TSM server.
: If your TSM/SP server is remote, these files aren't used.
;DSM_DIR / DSMG_DIR / DSMI_DIR 
: The directory where the 64-bit TSM/SP Client API is installed.
;DSM_CONFIG / DSMG_CONFIG / DSMI_CONFIG
: Points to the file containing the TSM Configuration file.
;DSM_LOG / DSMG_LOG / DSMI_LOG
: Points to the directory where the TSM Client files should be written.

=== Special Considerations for TSM Log files ===
The configuration parameters above that end in _LOG are log files.  By default, the logs all go to /tmp, which is, frankly, a terrible idea.  Instead, these log files should all go to a directory specifically for IBM CMOD Logs.  This will prevent errors arising from conflicting permissions, or filling up the server's temporary space.  Also, these logs should be rotated on a regular basis.  If you feel the need to place these log files in a 'standardized' space, place them in /var/log, but also create the files in advance, and provide them with generous permissions, to minimize frustration and errors.

== IBM CMOD Cloud Storage Options ==

Starting in IBM Content Manager OnDemand v9.5 Fixpack 3, there are a number of parameters for Storage Management that aren't included in the configuration file.  If you're planning on using IBM CMOD Cloud Storage, you'll need to add one or more of these parameters.  If Tivoli Storage Manager will NOT be part of your solution, you'll need to modify the ARS_STORAGE_MANAGER parameter to be "NO_TSM".  If you forget to make this IBM Content Manager OnDemand configuration change, [[arssockd]] may fail to start.  If OnDemand's ARS_STORAGE_MANAGER is set to CACHE_ONLY, then the Cloud Storage options won't be available at all.

=== Amazon Simple Storage Service a.k.a. S3===
;ARS_S3_CONFIG_FILE
: Specifies the location and name of the configuration file, for example:
  ARS_S3_CONFIG_FILE=/opt/IBM/ondemand/V10.1/config/ars.s3

;ARS_S3_CONFIG_DIR
: Specifies the directory where additional configuration files can be found if required for your IBM CMOD S3 connection, for example:
  ARS_S3_CONFIG_DIR=/opt/IBM/ondemand/V10.1/config

For more information: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.installmp.doc/dodex001.htm Knowledgebase for IBM CMOD v10.1] [https://aws.amazon.com/s3/ Amazon Web Services S3]

=== Hadoop Distributed File System ===
;ARS_HDFS_CONFIG_FILE
: Specifies the location and name of the configuration file, for example:
  ARS_HDFS_CONFIG_FILE=/opt/IBM/ondemand/V10.1/config/ars.hdfs

;ARS_HDFS_CONFIG_DIR
: Specifies the directory where additional configuration files can be found if required for your IBM CMOD HDFS connection, for example:
  ARS_HDFS_CONFIG_DIR=/opt/IBM/ondemand/V10.1/config

For more information: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.installmp.doc/dodex002.htm  Knowledgebase for IBM CMOD v10.1] [https://hadoop.apache.org/ Apache Hadoop Project]

=== IBM Cloud Object Storage a.k.a. ICOS ===

;ARS_ICOS_CONFIG_FILE
: Specifies the location and name of the configuration file, for example:
  ARS_ICOS_CONFIG_FILE=/opt/IBM/ondemand/V10.1/config/ars.icos

;ARS_ICOS_CONFIG_DIR
: Specifies the directory where additional configuration files can be found if required for your IBM CMOD ICOS connection, for example:
  ARS_ICOS_CONFIG_DIR=/opt/IBM/ondemand/V10.1/config

For more information: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.installmp.doc/dodex003.htm Knowledgebase for IBM CMOD v10.1] [https://www.ibm.com/cloud-computing/infrastructure/object-storage/ IBM Cloud Object Storage]

=== OpenStack Swift Storage ===

;ARS_SWIFT_CONFIG_FILE
: Specifies the location and name of the configuration file, for example:
  ARS_SWIFT_CONFIG_FILE=/opt/IBM/ondemand/V10.1/config/ars.swift

;ARS_SWIFT_CONFIG_DIR
: Specifies the directory where additional configuration files can be found if required for your IBM CMOD OpenStack Swift connection, for example:
  ARS_SWIFT_CONFIG_DIR=/opt/IBM/ondemand/V10.1/config

For more information: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.installmp.doc/dodex004.htm Knowledgebase for IBM CMOD v10.1] [http://docs.openstack.org/developer/swift/ OpenStack Swift]

=== IBM CMOD Filesystem Storage ===

;ARS_FILESYSTEM_CONFIG_FILE
: Specifies the location and name of the configuration file, for example:
  ARS_FILESYSTEM_CONFIG_FILE=/opt/IBM/ondemand/V10.1/config/ars.fs

;ARS_FILESYSTEM_CONFIG_DIR
:Specifies the directory where additional configuration files can be found if required for your IBM CMOD Filesystem Storage connection, for example:
  ARS_FILESYSTEM_CONFIG_DIR=/opt/IBM/ondemand/V10.1/config

For more information: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.installmp.doc/dodex005.htm Knowledgebase for IBM CMOD v10.1]

== IBM CMOD Unlisted Configuration Parameters ==
These parameters aren't listed in the Content Manager OnDemand Configuration File, and may be undocumented.  Undocumented parameters should be '''throughly''' tested before being used in production to ensure that you understand their behaviour.  

=== IBM CMOD Server Parameters ===
;ARS_ORIGINAL_CODEPAGE
: When upgrading a server from v7.1.x to v8.5 and above, you must specify the original codepage of the database for Unicode support.
: Set this value to the numeric codepage value of the database.  This allows OnDemand to translate the contents of the database to Unicode.
: Where possible, servers should be migrated to support Unicode in their databases.
;ARS_DB_PARTITION
: Determines if IBM Content Manager OnDemand will take advantage of your database engine's partitioning features.  Set to 1 (one) to enable.
: If this parameter is set, Application Groups must have a 'partition' field defined to determine which partition the index data will be stored on.
;ARS_DB_TABLESPACE
: Set this value to an already-existing tablespace name to keep the OnDemand configuration database tables in.
;ARS_DB_TABLESPACE_USEREXIT
: Specify the full directory path to the User Exit that is called when creating CMOD tablespaces.
: The tablespace user exit allows you to customize the creation of tablespaces, tables, and indexes for CMOD metadata tables.
;ARS_LOCK_HOSTS
: Configures Apache Zookeeper for IBM CMOD Active-Active Configuration.  See [http://www-01.ibm.com/support/docview.wss?uid=swg27049639 IBM CMOD Active-Active Support] for more info.
;ARS_DB_MAX_SQL_TABLES
: Specifies the maximum number of tables to query when searching an Application Group.  The default value is unknown.  This parameter is a short term solution -- instead, you should be optimizing [[Table Segmentation in Content Manager OnDemand]] and your DBA should increase the size of DB2 DBHEAP and STMT_HEAP parameters in the database configuration.  Visit the [https://www-01.ibm.com/support/docview.wss?uid=swg21406889 IBM TechNote on ARS_DB_MAX_SQL_TABLES] for more information.
;ARS_LDAP_REFERRALS
:Set this value to FALSE in order to prevent Content Manager OnDemand LDAP Authentication from accepting 'referral' responses from the configured LDAP server, which can stop CMOD LDAP Authentication from working at all.
: See the IBM Technote on [https://www.ibm.com/support/pages/node/477435 CMOD LDAP Authentication Fails]
;ARS_LOAD_IGN_2GB_DOCUMENT_LIMIT_ERROR
:Set to 1 to ignore errors when loading individual documents larger than 2GB.  This parameter is undocumented, and behavior of this parameter should be tested extensively before being used in production environments.  The 2GB boundary exists due to the use of 32-bit integers for describing file lengths, and could cause an overflow error on systems with poor support for large files.
;ARS_LOAD_IGN_DB_NAME_MATCH
:Alters the behavior of field name matching in indexer output when loading data into CMOD with arsload.  [https://www.ibm.com/support/pages/content-manager-ondemand-application-load-id-name-ignored-when-loading-data CMOD Application Load ID Name]
;ARSSOCK_RCVBUF_SIZE
: Set the size of the TCP Receive Buffers for arssockd.  The recommended value is 262144.  Use in combination with ARSSOCK_TCP_NODELAY.
;ARSSOCK_SNDBUF_SIZE  
: Set the size of the TCP Send Buffers for arssockd.  The recommended value is 262144.  Use in combination with ARSSOCK_TCP_NODELAY
;ARSSOCK_TCP_NODELAY
: Set to 1 to enable Nagle's Algorithm in order to improve performance on systems where it isn't enabled by default.  In AIX and Linux, it is enabled at the operating system level by default.  [https://en.wikipedia.org/wiki/Nagle%27s_algorithm Nagle's algorithm]
;ARS_SUPPORT_CFSOD
: Set this parameter to 1 if you are licensed to use the Content Federation System for OnDemand ("CFS:OD") feature.
;ARS_SUPPORT_HOLD
: Set this parameter to 1 if you are licensed to use the Content Manager OnDemand Enhanced Retention Management ("IBM CMOD ERM") feature.
;ARS_SUPPORT_OLD_ODWEK_DOCIDS
: When set to the number one (1), allows the server to accept DocIDs from ODWEK in the legacy (unencrypted/cleartext) format.  This parameter is only supported on versions of IBM CMOD v9.5.0.3 and newer.  Rather than enabling this parameter, your ODWEK apps should be updated to use the new, more secure DocID format. 
;ARS_USE_OLD_STYLE_CASE
: Use the old (pre-v8.5) method for converting the case of characters not in the current codepage. [https://www-01.ibm.com/support/docview.wss?uid=swg1PM82660 IBM PM82660] & [https://www-01.ibm.com/support/docview.wss?uid=swg21673461 IBM Technote] & [http://www.ibm.com/support/docview.wss?uid=swg27041378 ODNews Q1 2014]
: Preserving case-switching behavior [https://www-01.ibm.com/support/docview.wss?uid=swg21631713 IBM Technote]
: ODUG Forums post on Unicode Characters & ARS_USE_OLD_STYLE_CASE: [http://www.odusergroup.org/forums/index.php/topic,3343.0 Failure with special character]
;ARS_USER_EXITS_DIR
: Custom user exits need to live in a directory separate from those provided by IBM.  Specify the directory with this parameter.
: Consider locating your exits in the CMOD instance owners' home directory, with the following structure:  /home/archive/exits/ or /home/odadmin/exits
: See a post on this topic on the [http://www.odusergroup.org/forums/index.php?topic=2209.0 IBM CMOD User Group Forums].

=== IBM CMOD Cloud Storage Parameters ===
;ARS_ICOS_FORCE_COMPLIANCE
: Changes the behaviour of cloud storage in regards to "compliance" - that is, WORM (Write-Once-Read-Many) storage.  When set to 0 (zero), CMOD checks to see if the storage has the ability to protect data from deletion.  By default, this parameter is set to 1 (one), which forces Content Manager OnDemand to place a hold on all data stored onto this cloud storage.

=== IBM CMOD 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.