1,126
edits
Difference between revisions of "ars.cfg"
m
Many Minor updates, section renamed
(Added IBM CMOD CFS and IBM CMOD ERM feature pack configuration parameters.) |
m (Many Minor updates, section renamed) |
||
| 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. This configuration file is from IBM Content Manager OnDemand 10.1 for Linux. | 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 == | == ars.cfg Header, License, & Language CMOD Configuration == | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand Configuration File | ! Sample IBM Content Manager OnDemand Configuration File | ||
|- | |- | ||
| | | | ||
| Line 55: | Line 55: | ||
: This is the three-alpha ISO code for the language you would like CMOD to use for messages and output. | : 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" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Content Manager OnDemand Premium Feature Pack Parameters | ! IBM Content Manager OnDemand Premium Feature Pack Parameters | ||
|- | |- | ||
| | | | ||
| Line 68: | Line 68: | ||
|} | |} | ||
After installing the CMOD Feature Pack, add the parameters to the | 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 | ;ARS_SUPPORT_CFSOD | ||
: Set this parameter to 1 if you are licensed to use the Content Federation System for OnDemand ("CFS:OD") feature. | : 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 | ;ARS_SUPPORT_HOLD | ||
| Line 78: | Line 78: | ||
Also: [[ars.cfg#IBM_CMOD_Server_Parameters|Unlisted CMOD Server Options]]. | Also: [[ars.cfg#IBM_CMOD_Server_Parameters|Unlisted CMOD Server Options]]. | ||
== CMOD Object Server Configuration == | == 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. | 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" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand Object Server Configuration | ! Sample IBM Content Manager OnDemand Object Server Configuration | ||
|- | |- | ||
| | | | ||
| Line 142: | Line 142: | ||
: 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. | : 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. | ||
== CMOD Database Configuration == | == IBM CMOD Database Configuration == | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand Database Configuration | ! Sample Content Manager OnDemand Database Configuration | ||
| Line 182: | Line 182: | ||
;ARS_NUM_DBSRVR | ;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 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 | : 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. | : 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. | : 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. | ||
| Line 197: | Line 197: | ||
: Specifies the name of the database to use for storing document metadata. | : Specifies the name of the database to use for storing document metadata. | ||
=== CMOD Database Creation === | === IBM CMOD Database Creation === | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand Database Creation Parameters | ! Sample IBM Content Manager OnDemand Database Creation Parameters | ||
|- | |- | ||
| | | | ||
| Line 234: | Line 234: | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand DB2 TSM Configuration Parameters | ! Sample IBM Content Manager OnDemand DB2 TSM Configuration Parameters | ||
|- | |- | ||
| | | | ||
| Line 259: | Line 259: | ||
: Points CMOD to the directory where oracle is installed. | : Points CMOD to the directory where oracle is installed. | ||
== CMOD Miscellaneous Configuration == | == IBM CMOD Miscellaneous Configuration == | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand Miscellaneous Configuration Parameters | ! Sample IBM Content Manager OnDemand Miscellaneous Configuration Parameters | ||
|- | |- | ||
| | | | ||
| Line 290: | Line 290: | ||
=== Special Considerations for IBM CMOD temporary files === | === 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. | 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. | ||
== CMOD LDAP Configuration == | == IBM CMOD LDAP Configuration == | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand LDAP Configuration Parameters | ! Sample IBM Content Manager OnDemand LDAP Configuration Parameters | ||
|- | |- | ||
| | | | ||
| Line 347: | Line 347: | ||
: Only the PASSWORD_EXPIRED and ACCOUNT_LOCKED return codes from LDAP are currently supported in Content Manager OnDemand v10.1. | : Only the PASSWORD_EXPIRED and ACCOUNT_LOCKED return codes from LDAP are currently supported in Content Manager OnDemand v10.1. | ||
=== LDAP Sync Parameters === | === 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. | 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. | ||
| Line 369: | Line 369: | ||
Also: [[ars.cfg#CMOD_LDAP_Parameters|Unlisted CMOD LDAP Options]]. | Also: [[ars.cfg#CMOD_LDAP_Parameters|Unlisted CMOD LDAP Options]]. | ||
== CMOD Storage Management Configuration == | == IBM CMOD Storage Management Configuration == | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
! Sample Content Manager OnDemand TSM Configuration Parameters | ! Sample IBM Content Manager OnDemand TSM Configuration Parameters | ||
|- | |- | ||
| | | | ||
| Line 402: | Line 402: | ||
;DSMSERV_DIR | ;DSMSERV_DIR | ||
: The directory where Tivoli Storage Manager (now Spectrum Protect) is installed. | : The directory where IBM Tivoli Storage Manager (now IBM Spectrum Protect) is installed. | ||
;DSMSERV_CONFIG | ;DSMSERV_CONFIG | ||
: The configuration file for the TSM server. | : The configuration file for the TSM server. | ||
| Line 418: | Line 418: | ||
== IBM CMOD Cloud Storage Options == | == IBM CMOD Cloud Storage Options == | ||
Starting in IBM | 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=== | === Amazon Simple Storage Service a.k.a. S3=== | ||
| Line 478: | Line 478: | ||
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] | 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] | ||
== Unlisted Parameters == | == IBM CMOD Unlisted Configuration Parameters == | ||
These parameters aren't listed in the | These parameters aren't listed in the Content Manager OnDemand Configuration File by default. | ||
=== IBM CMOD Server Parameters === | === IBM CMOD Server Parameters === | ||
| Line 518: | Line 518: | ||
: See a post on this topic on the [http://www.odusergroup.org/forums/index.php?topic=2209.0 IBM CMOD User Group Forums]. | : See a post on this topic on the [http://www.odusergroup.org/forums/index.php?topic=2209.0 IBM CMOD User Group Forums]. | ||
=== ODWEK Load Parameters === | === 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: | 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: | ||