ars.cfg - Revision history

Jderrick: /* IBM CMOD Miscellaneous Configuration */

2024-11-20T19:56:07Z

IBM CMOD Miscellaneous Configuration

← Older revision		Revision as of 19:56, 20 November 2024
Line 290:		Line 290:

	;ARS_TRACE_SETTINGS		;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		: 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: trace.settings
			: NOTE: You must start CMOD from the directory that contains the trace settings file, OR specify the full path to the file in this parameter - <code> ARS_TRACE_SETTINGS=/opt/ibm/ondemand/V10.5/trace.settings </code>.

	=== Special Considerations for IBM CMOD temporary files ===		=== Special Considerations for IBM CMOD temporary files ===

Jderrick: /* IBM CMOD LDAP Sync Parameters */

2024-10-30T12:58:36Z

IBM CMOD LDAP Sync Parameters

← Older revision		Revision as of 12:58, 30 October 2024
Line 380:		Line 380:
	: 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.		: 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.		: Specifies the CMOD group identifiers that CMOD will ignore when syncing.

			A complete list of Content Manager OnDemand LDAP Sync parameters can be found in the official documentation here: [https://www.ibm.com/docs/en/cmofm/10.5.0?topic=arslsync-notes ARSLSYNC Notes]

	== IBM CMOD SSO (Single Sign On) Parameters==		== IBM CMOD SSO (Single Sign On) Parameters==

Jderrick: /* IBM CMOD Server Parameters */

2024-10-30T12:57:03Z

IBM CMOD Server Parameters

← Older revision		Revision as of 12:57, 30 October 2024
Line 515:		Line 515:
	;ARS_DB_MAX_SQL_TABLES		;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]] or performing [https://cmod.cloud/professionalservices/table-consolidation/ CMOD Segment Table Consolidation] to improve performance, 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.		: 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]] or performing [https://cmod.cloud/professionalservices/table-consolidation/ CMOD Segment Table Consolidation] to improve performance, 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_GROUP_USER_FILTER_USE_DN
			: Instructs CMOD to use Distinguished Name in Group and User Filters. Only to be used with the advice of IBM's support team. Also, using this parameter with CMOD v10.5.0.8 or lower, regardless of value it is set to, may cause undesired behaviour.
	;ARS_LDAP_REFERRALS		;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.		: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.

Jderrick: Added more information on ARS_DB_MAX_SQL_TABLES

2024-08-20T18:13:41Z

Added more information on ARS_DB_MAX_SQL_TABLES

← Older revision		Revision as of 18:13, 20 August 2024
Line 514:		Line 514:
	: 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.		: 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		;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.		: 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]] or performing [https://cmod.cloud/professionalservices/table-consolidation/ CMOD Segment Table Consolidation] to improve performance, 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		;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.		: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.

Jderrick: CMOD User Group link updated.

2024-08-20T18:11:44Z

CMOD User Group link updated.

← Older revision		Revision as of 18:11, 20 August 2024
Line 537:		Line 537:
	: 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]		: 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]		: 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]		: ODUG Forums post on Unicode Characters & ARS_USE_OLD_STYLE_CASE: [https://ODUG.net/index.php/topic,3343.0 Failure with special character]
	;ARS_USER_EXITS_DIR		;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.		: Custom user exits need to live in a directory separate from those provided by IBM. Specify the directory with this parameter.

Jderrick: Added section on ARS_LOAD_IGN_DB_NAME_MATCH mentioned in ODNews 2023 Q4

2024-01-08T18:24:29Z

Added section on ARS_LOAD_IGN_DB_NAME_MATCH mentioned in ODNews 2023 Q4

← Older revision		Revision as of 18:24, 8 January 2024
Line 521:		Line 521:
	: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.		: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		;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]		: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] Usage and history of this parameter was described in [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf ODNews 2023 Q4]
	;ARSSOCK_RCVBUF_SIZE		;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.		: Set the size of the TCP Receive Buffers for arssockd. The recommended value is 262144. Use in combination with ARSSOCK_TCP_NODELAY.

Jderrick: /* IBM CMOD SSO (Single Sign On) Parameters */

2023-09-28T12:20:51Z

IBM CMOD SSO (Single Sign On) Parameters

← Older revision		Revision as of 12:20, 28 September 2023
Line 383:		Line 383:
	== IBM CMOD SSO (Single Sign On) Parameters==		== IBM CMOD SSO (Single Sign On) Parameters==
	;ARS_TRUSTED_SSO_HOSTS		;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.		: 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. The easiest way to identify the ICN servers to the CMOD server is to attempt a login, then find the failed login message in CMOD's System Log.
	: This parameter is REQUIRED to enable access Content Manager OnDemand with Single Sign On. Without this parameter, OnDemand SSO will not work.		: This parameter is REQUIRED to enable access Content Manager OnDemand with Single Sign On. Without this parameter, OnDemand SSO will not work.

Jderrick: /* IBM CMOD LDAP Configuration */

2023-08-30T08:15:48Z

IBM CMOD LDAP Configuration

← Older revision		Revision as of 08:15, 30 August 2023
Line 355:		Line 355:
	: 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.		: 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.		: 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 ===		=== IBM CMOD LDAP Sync Parameters ===

Jderrick: Added ARS_LOAD_IGN_2GB_DOCUMENT_LIMIT_ERROR

2023-04-11T13:30:08Z

Added ARS_LOAD_IGN_2GB_DOCUMENT_LIMIT_ERROR

← Older revision		Revision as of 13:30, 11 April 2023
Line 494:		Line 494:

	== IBM CMOD Unlisted Configuration Parameters ==		== IBM CMOD Unlisted Configuration Parameters ==
	These parameters aren't listed in the Content Manager OnDemand Configuration File ~~by default~~.		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 ===		=== IBM CMOD Server Parameters ===
Line 516:		Line 516:
	: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.		: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]		: 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		;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]		: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]

Jderrick: Added link to ODUG for ARS_USE_OLD_STYLE_CASE.

2023-03-03T15:04:48Z

Added link to ODUG for ARS_USE_OLD_STYLE_CASE.

← Older revision		Revision as of 15:04, 3 March 2023
Line 533:		Line 533:
	: 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]		: 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]		: 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		;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.		: Custom user exits need to live in a directory separate from those provided by IBM. Specify the directory with this parameter.