CMOD.wiki - User contributions [en]

ARS1129E

2025-03-05T17:27:28Z

Jderrick: Added a note to remove extra space characters or tabs around the date fields for ARS1129E.

{{TOCright}}
== What was the error? ==
'''Message Number''': 1129

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS1129E

'''Message Text''': Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d

== Example ==
ARS1129E Row 1: The string "20190125" could not be converted to a date from the format of %Y-%m-%d

== Related Errors ==
[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

== What were you doing? ==
You were trying to load data into CMOD using [[arsload]], possibly for the first time since the Application Group or Application was configured.

== What happened? ==
The date format that was inside the file didn't match the date format that was expected by CMOD, in the Application configuration.

In the example above, CMOD was expecting dashes between the year and month and day of the month. In order for OnDemand to be able to properly parse the date, it must match the format defined in the Application.

== Troubleshooting ==
Using the Row number in the error message, check the Generic Index file to determine which field the error relates to. Then, using the IBM CMOD Administrator Client to update the date format to match the format of the data itself. In the case of this example, remove the dash ("-") characters from the date format string, and attempt the load again.

Also, check the Application definition, under Load Parameters - select the date field that is causing problems, and check the date field parameters -- ensure there are no spaces or tab characters ''before'' or ''after'' the date field specification (like %m/%d/%Y). As a reminder, the 'Character Removal' fields only remove characters from the INPUT fields, not the date field specification itself!

== Articles Related to this message ==
[http://www.odusergroup.org/forums/index.php?topic=1906.0 OnDemand User Group Forums Post]

[[Date and Time formats in Content Manager OnDemand]]

ARS0199E

2025-01-15T17:10:12Z

Jderrick: /* What happened? */

{{TOCright}}
== What was the error? ==
Message Number: ARS0199E

Message Severity: Error (Corrective action is required to continue)

Message Name: Unexpected empty directory in cache >directory<

Message Text:
Unexpected empty directory in cache >/arscache/cache1/12345/ABC/<

== Related Errors ==
[[ARS0198E|ARS0198E - Invalid Ownership and/or permissions on cache file/directory]]

== What were you doing? ==
Running arsmaint -v to validate the contents of the cache filesystems.

== What happened? ==
[[arsmaint]] found an empty directory while it was validating the Content Manager OnDemand cache filesystems. Normally, CMOD doesn't leave empty directories during regular maintenance -- it removes them when the last known object is deleted. It may be that there was an unexpected file in the directory that prevented the removal of the directory, a permissions issue at the operating system level, or the storage device may have disallowed the operation (for example, a filesystem mounted 'read only' due to an error).

== Example ==

Unexpected empty directory in cache >/arscache/cache1/retr/ABC/DOC<

== Troubleshooting ==
This error is very simple to correct. Simply delete the empty directory.

rmdir /arscache/cache1/retr/ABC/DOC

It may be necessary to delete the parent directory as well, if it is also empty.

rmdir /arscache/cache1/retr/ABC

== APARs Related to this message ==

[http://www-01.ibm.com/support/docview.wss?uid=swg1PM80684 ARSMAINT can leave behind empty directories]

ARS1400E

2025-01-15T17:07:50Z

Jderrick: /* Crashed load */

{{TOCright}}
== What was the error? ==
'''Message Number''': 1400

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS1400E

'''Message Text''': Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded. Failed LoadId >5301-18-0-100FAA-20160112000000-20160112000000-5306< was attempted to be loaded at approximately 2016-01-13 15:13:56

== Related Errors ==

None.

== What were you doing? ==

Probably loading files into Content Manager OnDemand with the arsload command, running as a daemon.

== What happened? ==

More than one arsload daemon was launched for the same directory & Application Group -- now the two processes are 'fighting' over files.

== Example ==

ARS1400E Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.
Failed LoadId >5316-29-0-100454FAA-20161012000000-20161012000000-5318< was attempted to be loaded at approximately 2016-10-13 15:13:56

== Troubleshooting ==
There are two main causes for ARS1400E - either you are running multiple arsload processes that are interfering with each other, or arsload experienced an unrecoverable error and exited without cleaning up after itself, or 'crashed'.

It's also possible that you tried to load a file with arsload, but didn't use the <code> -f </code> option, which 'forces unload' in the case of a failure during the load.

=== Find multiple arsload processes ===
It may be possible that you're running more than one arsload daemon at a time:

Find the Process ID numbers for the arsload processes with:

On AIX:
ps -ef |grep arsload

On Linux:
ps auxw |grep arsload

Then issue a kill command for both of the processes:

kill <process-id-number> <process-id-number>

And restart only one instance of the IBM CMOD arsload command.

=== Crashed load ===
If a load was running, and the arsload processes crashed, you will need to unload the failed file. Normally, the [arsload] utility would perform this clean-up work automatically (by adding the -f option to arsload to 'force unload of failed loads'), but can itself fail if the load process was killed or otherwise terminated abnormally, like a network connection being unexpectedly cut, a server reboot, or CMOD or DB2 going offline unexpectedly.

arsadmin unload -I ARCHIVE -u ADMIN -p PASSWORD -g APPGROUP -Q -L LOADID

;Where...
: ARCHIVE is the name of the CMOD instance that the file was being loaded into
: ADMIN is a User ID with the the Delete privilege for the App Group
: PASSWORD is the account password or name of the stash file containing the password for the account
: APPGROUP is the name of the Application Group that the data was being loaded into
: LOADID is the Load ID reported by arsload.

== Articles Related to this message ==

[https://www.ibm.com/docs/en/cmofm/10.5.0?topic=messages-ars1400e CMOD Messages and Codes: ARS1400E]

Migrating From Filenet to Content Manager OnDemand

2025-01-15T16:22:09Z

Jderrick: /* Name output files in AG.Date.App format */

{{TOCright}}
== Scope ==

These are some recommendations and tips from my experiences migrating Filenet data to Content Manager OnDemand - since I'm not a Filenet admin, Filenet is outside the scope of this article -- this only deals with the OnDemand-specific tips and tricks to make your migration easier.

=== A Warning ===

<blockquote>
"Abandon all hope, ye who enter here"
-- Dante's Inferno
</blockquote>

Large migration projects are always painful. They take more time & money than anticipated (or more importantly, budgeted) because of one simple, honest truth: You are re-living all of the mistakes, problems, errors, and previously undiscovered issues with potentially '''decades''' of information. A lot of the 'institutional knowledge' surrounding specific data, reports, or use-cases is long gone. Especially frustrating are the conversations that end in "So, why did you think they did ''THAT'' ?!?!?", because it's not always obvious what the situation was when critical (and possibly bad) decisions were made.

Patience is a virtue, and any sufficiently large migration project will test your determination, and at times, your sanity. The advice below comes from one of the largest migration projects I've ever participated in.

== Nomenclature ==

This is the worst part of migrating between Filenet and CMOD, as some terms are used in both systems, but have different contexts and meanings. The process is complex enough without the added headaches of misunderstandings brought about by ambiguous terms.

=== Filenet Nomenclature ===
; Document Class (aka "DocClass")
: Defines the metadata used to find individual reports.

=== Content Manager OnDemand Nomenclature ===

; Application Group (aka "App Group" or simply "AG")
: A way of combining many different reports into a single group of data, organized by business need. Accounting reports for accounting, and operations reports for your operations teams. Reports that are bundled into Application Groups need to have the same index fields, storage hierarchy, and retention (ie, expiration) handling.

; Application (aka "App")
: Defines the type of document (AFP, Line data, PDF, Image), and how to automatically collect metadata (aka 'indexes') that will be used as search criteria by end users, for storage in the database.
: Multiple Applications of any data type (ie, AFP for customer statements, Line data reports generated by a mainframe, special letters or notices in PDF format, and incoming faxes stores as TIFF images).

; Folder
: The Folder in OnDemand abstracts the internal complexities of Application Groups and Applications, and presents users with the fields that they can search (which were populated into the database by the Application) and sets limits on their queries (maximum number of returned hits, fields required for searches, etc.)

== Considerations ==
Consider the following items before starting your migration. Getting it right at this stage will mean a faster, easier, cheaper transition to CMOD at the end of the day.

=== Converting Document Classes ===

IBM Content Manager OnDemand ("CMOD") has an entirely different architecture than the Filenet products. In IBM CMOD vernacular, an 'Application' is analogous to an individual report. But in CMOD, the top of the hierarchy is the 'Application Group' -- a grouping of Applications (aka 'reports') where the index fields, storage, and retention requirements are all the same. Properly defined Application Groups can have multiple Applications (again, 'reports') that belong to it. The most rational way to design Application Groups is to combine reports together that fulfill a specific business need. Human Resources reports shouldn't intermingle with Accounts Payable (even if they have the same index fields), and are kept logically separate by keeping their reports in separate Application Groups.

=== Quantify index usage ===

OnDemand doesn't like to have indexes defined in the Application Group without a corresponding value appearing in the reports it processes -- it also wastes space inside the database. It seems common in the Filenet world to assign a report to a Document Class that has indexes configured that simply don't exist anywhere in the report. Yes, you can assign default values to the empty fields to get ACIF to stop complaining, but if you want to do this right, you'll want to look into your index usage. Not just which fields you're populating most often, but also which fields your end users are searching on. Eliminating unused fields from Application Group definitions will streamline indexing, reduce storage costs, and reduce complaints from end users at the end of the day.

=== Perform quality checks on existing metadata ===

Over the years, and substantial amount of junk can accumulate inside database tables. Bad data that passes a very rudimentary check at the time it was loaded starts accumulating in databases, and is often discovered during the migration process. A common example is a bad date value -- someone meant to type in a date for 2013, but entered 2031 instead, or there's a mix-up between the month and day fields. (February 12th as 02/12 vs. December 2nd as 12/02). There needs to be an additional 'sanity check' on data before performing the migration, to identify and correct these issues before importing them into the new IBM CMOD server.

=== Check for field re-use ===

As is human nature, some shortcuts may have been taken in the distant past that are now your problem to resolve. One common annoyance is the 're-use' of a particular field for a new data type. The time saved in putting a value in a pre-existing field with an unrelated name is likely to be a recurring theme. For American companies, using Social Security Numbers ("SSNs") for customers or employee records used to be common. With the advent of large-scale identity fraud, companies ripped out SSNs from databases, and replaced them with different numbering systems. In order to save time and money, many companies simply re-used their old "Social" field with new "Employee" numbers, often causing chaos when new systems try and do any validation. Also, watch out for real metadata squeezed into generic fields, like 'Description' or 'Comment' or 'Notes'. You'll have to determine what exactly that data is, and where it truly belongs in order to complete the migration successfully.

=== Transfer in Original Formats ===

For some Filenet installations, upstream servers (or intermediate file transfer systems) convert report data (from EBCDIC to ASCII) and change the formatting of the report. IBM Content Manager OnDemand doesn't need any data transformation, and can ingest EBCDIC reports (of fixed record length, stream, or variable record lengths) directly and without conversion. Some conversion tools (I'm looking at you, MQ Series File Transfer Edition) can be configured to change the report so drastically, that IBM CMOD can't properly index it.

Wherever possible, remove any data conversion and deliver report data to OnDemand in its original format.

This means that you may require two different Applications ("Report Defintions") for each report -- one for the report in its original format (EBCDIC) and one for the converted version (ASCII). For this reason alone, you should always define an Application ID Field in EVERY Application Group.

=== Image Overlays for Reports ===

If a report has a graphic "overlay" (like, an image with boxes around columns, or shaded bars, or graphic logos) this should be documented as early in the process as possible. In order for these overlays to be displayed on all platforms, line data reports will need to be converted to AFP. This will require any overlay graphics not in AFP format to be converted -- a process which can take a considerable amount of time to complete, especially if there is not someone available to do the translation 'in-house'.

=== Review Report Types & Audience ===

There's no better time to review the contents of reports, and refer with end users to determine which reports should be stored, indexed, managed, and disposed of in the same manner. Put on your Business Analyst cap and strap on your most comfortable telephone headset, because this is the most time consuming and manual part of the whole process.

=== Annotations ===

If you're using in Filenet, you'll need to extract them, and integrate them into IBM CMOD. Annotations can be added to individual documents in OnDemand at load time, through the Generic Index files.

=== Reconciliation ===
In order to reconcile the documents after the migration is complete, you'll want to have a unique identifier for each document that needs to be moved out of FileNet and into CMOD. Thankfully, FileNet provides a unique 'Document Indentifier' or "DocID" -- which can be loaded into IBM CMOD by adding a corresponding field in the Application Group definition. The DocID field doesn't need to be added to OnDemand folders, so it can remain invisible to end users, or exposed to a different folder to be used with existing tools that use them.

=== Don't create unnecessary directories ===
When exporting data from Filenet, don't create a directory unless it's absolutely necessary. A number of empty directories will slowly drive you mad, as you try to determine if the directories are **supposed** to be empty, or if some data was lost, or if they were missed during a file copy or move operation.

== Differences in Functionality ==

=== Blank Fields ===

In Filenet systems, metadata fields can be blank -- including date fields. In the OnDemand world, fields are NEVER allowed to be blank -- the rationale is that you can't find a document that doesn't have all of the index values properly populated in the database. In the cases where fields are empty, there are a few options:
* Remove the field from the Application Group definition
* 'Retrofit' the index file with the missing data from another source
* Discard the metadata from Filenet and run the reports through one of the CMOD Indexers like ACIF.

=== PDF Indexing ===

PDFs are indexed differently in CMOD than they are in Filenet. Filenet breaks PDF documents into bundles of pages, but the entire PDF document remains available to the end user. In Content Manager OnDemand, when a PDF is indexed, it is broken into individual documents, and the individual PDF file becomes multiple individual PDF files. There is no clear way to reverse this process in CMOD.

== Ingesting the exported data ==

You'll want to make sure that during the export process that you consider the information you'll need to get the exported data into Content Manager OnDemand quickly and easily.

=== Provide report names ===
In order to get specific reports into OnDemand, you need to provide the name of an report (likely as an Application). Make life easier for yourself by including the name of the report in the file names you output.

=== Group reports in chronological order ===
Due to the way table segmentation works in OnDemand, you'll want to load the data in chronological order. When you name files, consider including a date field in YYYY-MM-DD format, so it can be sorted numerically at load time. This ensures that when the production server goes live, that end users will get speedy and fast database queries.

=== Use Expiration Type of "Load" ===
In Content Manager OnDemand, there are three options for expiring data loaded into Application Groups:
;Document: examines each row of metadata to determine if it's eligible for expiration, and deletes individual rows from the database
;Load: examines the arsload table to find loads in which ALL documents are eligible for expiration, and preforms an 'unload'
;Segment: examines each database table (also know as a "Segment") to determine if ALL the documents in the table are eligible, then it simply drops the database table.

For historical migrations, using the 'Load' expiration types, minimizing the date range inside a single load file, and loading in chronological order will prevent issues with the deletion or disposition of data in the future.

=== Name output files in AG.Date.App format ===

Write your report files with the following prefix: ApplicationGroup.DateFormat.Application

This will allow you to load by Application Group, Date, and Application easily when you sort the files. By having the date as your second 'field' in the file name, you make loading in Chronological order easy and straightforward. Regardless of your locale, using the YYYY-MM-DD format (with leading zeros) is wise, as most UNIX/Linux operating systems will natively sort file lists (like ls, or wildcards like "*" -- but not the 'find' command which outputs data in the order they appear in the filesystems inodes) which optimizes the way database tables for each individual App Group (known as 'segment tables' in CMOD lingo) are created.

=== Concatenate Reports ===

Concatenating reports together means fewer loads (and less overhead, as each load can represent up to 10k in metadata). It also means you'll get better compression for storage. Depending on the volume of data for a particular report, you may be able to group reports together by month -- and this also works perfectly with the point above, keeping groups of data with similar dates together inside database tables.

=== Produce output in manageable batches ===

When producing output, remember that you'll likely need to transfer this data between systems, possibly across the network, and onto different operating systems. There are limitations to different archiving and compression tools (32678 files for .zip archives, and 2GB file size limits for older versions of gzip and bzip2), and you don't want to lose too much time or effort if a file transfer is interrupted. It's best to produce managable, similarly-sized batches that you can use to develop Applications, test loads, and promote from your Development to Quality Assurance ("QA") and Production Servers.

== Order of Operations ==
In order to find problems with reports as quickly as possible, follow these steps in order:

* Build a test / development Content Manager OnDemand Server
** Make sure you have some extra temporary storage space to queue up incoming report data

* Begin delivering duplicates of the report data to CMOD, in its original format.
** Make some test Application Groups and get some practise indexing these reports, and figuring out any strange or non-standard report types.

* Do you research -- everything under 'Initial Considerations'.
* Document your new structure - create new Application Groups, select the reports that will belong to them, and identify your sample data.

LDAP Error: Invalid credentials

2024-11-21T20:55:08Z

Jderrick: /* Verify your stash file */

{{TOCright}}
== What was the error? ==
Message Number: 384

Message Severity: Error (Corrective action is required to continue)

Message Name: ARS0384E

Message Text:
LDAP Error: Invalid Credentials -- ldap_rc=<RC> -- extended+rc=<RC>, Success -- ldap_errno=<RC>, extra_rc=<RC> File=arsldap.c, Line=<LineNo>

where <RC> is the return code, and <LineNo> is the line in the source code where the error was caught. See below for more information on common return codes and their meanings.

== Related Errors ==
[[Unable to find an assigned userid for LDAP from stash file|ARS0436E]]

== What were you doing? ==
Probably attempting to configure LDAP on Content Manager OnDemand for the first time, or a user attempted to authenticate with a bad user id or password on an LDAP-enabled CMOD server.

== What happened? ==
The LDAP server couldn't authorize the user to perform an action, because the User ID or password they provided was not correct. It may also indicate an error in your LDAP configuration.

== Example ==
arssockd (ARCHIVE): 2015-04-29 10:54:03.274673 42422 CMODUSER 2 384 ARS0384E LDAP Error: Invalid credentials -- ldap_rc=49, -- extended_rc=0, Success -- ldap_errno=0, extra_rc=0, File=arsldap.c, Line=1308

== Troubleshooting ==
You may need to [[Manually disabling LDAP authentication|Disable IBM CMOD LDAP Authentication]] in order to return the server to operation.

=== Ensure you are using the correct User ID or password ===
*Content Manager OnDemand uses non-case sensitive passwords by default, while LDAP servers store passwords in a case-sensitive manner.
*In order to do this, CMOD converts the passwords to uppercase ("PassWord" is changed to "PASSWORD") before hashing them and storing them in the database.
*Inside the Administrative Client, under System Parameters -> Login Details, in the top-right pane, select "Passwords Case Sensitive". Any accounts that are excluded from password authentication (ie, the 'admin' account) will need to have their passwords entered in uppercase until they're reset.

=== Verify your stash file ===
* You may have incorrect configuration data in your stash file. See [[arsstash]] for an explanation of stash files, or [[LDAP and Content Manager OnDemand]] for a tutorial.
* Work with your LDAP administrators to determine the proper LDAP string to use in your stash file configuration.

The return code 49 indicates that you likely have an incorrect User ID or password, or possibly a restriction on the LDAP account which is causing the authentication request to fail. If you're using Microsoft Active Directory, you will need to change your [[ars.cfg]] file to include:

ARS_LDAP_BIND_ATTRIBUTE=sAMAccountName
ARS_LDAP_MAPPED_ATTRIBUTE=USERID

=== Activate System Trace on CMOD ===
[[File:Trace LDAP.png|right|thumb|500px|Enabling System Trace to troubleshoot LDAP issues]]

Change the trace.settings configuration file to include the following string:

TRACE_FILE_LEVELS=ALL=3,LDAP=15

And make the change to tracing through the Content Manager OnDemand Administrative Client.

=== LDAP Return Codes ===

{| class="wikitable"
|+Common Active Directory return codes:
| 525||user not found
|-
| 52e||invalid credentials
|-
| 530||not permitted to logon at this time
|-
| 531||not permitted to logon at this workstation
|-
| 532||password expired
|-
| 533||account disabled
|-
| 534||The user has not been granted the requested logon type at this machine
|-
| 701||account expired
|-
| 773||user must reset password
|-
| 775||user account locked
|-
|}

ars.ini

2024-11-20T20:30:09Z

Jderrick: /* Unlisted CMOD Configuration Parameters */

{{TOCright}}
The ars.ini configuration file defines one or more IBM Content Manager OnDemand ("IBM CMOD") instances on a server. While most systems only contain a single IBM CMOD server, it is possible to combine multiple OnDemand instances onto a single server -- usually for combining development and test instances.

== Default ars.ini configuration parameters ==
[@SRV@_ARCHIVE]
HOST=cmod.example.com
PROTOCOL=2
PORT=0
SRVR_INSTANCE=archive
SRVR_INSTANCE_OWNER=archive
SRVR_OD_CFG=/opt/ibm/ondemand/V10.5/config/ars.cfg
SRVR_DB_CFG=/opt/ibm/ondemand/V10.5/config/ars.dbfs
SRVR_SM_CFG=/opt/ibm/ondemand/V10.5/config/ars.cache

; [@SRV@_ARCHIVE]
: This is the header that defines a server. Any of the parameters below refer to this server - ARCHIVE.

; HOST=cmod.example.com
: The fully qualified domain name of the server.

; PROTOCOL=2
: The protocol to use between the server and client. Leave the default value for the version of CMOD you've installed. Communications between Content Manager OnDemand Clients and Servers works over TCP/IP.

; PORT=0
: The TCP/IP port number to use for CMOD. 0 uses the default, 1445.
: Each server must have it's own port number, servers cannot share a port.
: This port number must be entered in the client software when defining a server.

; SRVR_INSTANCE=archive
: Name of the instance.

; SRVR_INSTANCE_OWNER=archive
: The operating system User ID that owns / controls this instance. This parameter may be case sensitive depending on your Operating System.

; SRVR_OD_CFG=/opt/ibm/ondemand/V10.5/config/ars.cfg
: Defines the location of your configuration file for the server.

; SRVR_DB_CFG=/opt/ibm/ondemand/V10.5/config/ars.dbfs
: Defines the location of your configuration file for the database manager.

; SRVR_SM_CFG=/opt/ibm/ondemand/V10.5/config/ars.cache
: Defines the locatio nof your configuration file for defining cache filesystems.

== arsstash related ars.ini configuration parameters ==

SRVR_OD_STASH=/opt/IBM/ondemand/V10.5/config/ars.stash

; SRVR_OD_STASH=/opt/IBM/ondemand/V10.5/config/ars.stash
: This parameter defines the location of the default stash file to use for database connections, arsload, and LDAP authentication.

== SSL / TLS related ars.ini configuration parameters ==

SSL_PORT=1446
SSL_KEYRING_FILE=/opt/IBM/ondemand/V10.5/config/ondemand.kdb
SSL_KEYRING_STASH=/opt/IBM/ondemand/V10.5/config/ondemand.sth
SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
SSL_CLNT_USE_SSL=1

; SSL_PORT=1446
: Defines the port number for encrypted connections to CMOD.
: There is no default port number, common choices are 1443 and 1446, but may be any number between 1024 and 65535 not already in use on your server by other services like TSM (1500, 1501) or DB2 (50000-50006, 60000-60006).

; SSL_KEYRING_FILE=/opt/IBM/ondemand/V10.5/config/ondemand.kdb
: Defines the location of the key database that contains all the requisite certificates and keys.

; SSL_KEYRING_STASH=/opt/IBM/ondemand/V10.5/config/ondemand.sth
: Defines the location of the stash file that contains passwords to the keys and certificates in the key database.
: This file should have very restrictive permissions.

; SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
: Defines the label of the SSL Certificate to be used to identify the IBM CMOD server.

; SSL_CLNT_USE_SSL=1
: Determines if utility clients like arsload should use SSL to connect to IBM CMOD.
: This is not necessary if you're not performing remote loads (via arsload), or queries or retrievals (via arsdoc).

== Unlisted CMOD Configuration Parameters ==
;ARSSOCK_TLSV12_ONLY
: When set to '1', this parameter disables all prior levels of TLS - improving security by disabling older, less secure cryptographic methods.
: When setting SSL/TLS parameters for CMOD, you can also add environment variables to modify the behavior of IBM Global Security Kit like <code>GSK_PROTOCOL_TLSV1_2=1</code>.

;ARSSOCK_STRICT_SHA2_ONLY_CERTS
: When set to '1', this flag instructs Content Manager OnDemand to only allow certificates that use the SHA2 hashing method in CMOD server certificates. This increases security, as certificates signed with SHA1 are considered vulnerable to 'collision' attacks, and as a result, are not secure.

;ARSSOCK_FIPS
:The default is for CMOD to start up with FIPS compliance enabled.
:If you are trying to upgrade to TLS v1.3, you need to disable FIPS support with <code>ARSSOCK_FIPS=0</code>.

;SRVR_FLAGS_SECURITY_EXIT
: This is the flag to enable the Content Manager OnDemand User Security Exit. The IBM CMOD Security Exit, <code> arsusec</code> is used to extend and customize user authentication in CM OnDemand. When set to 1, CMOD will call the user exit when a user connects to CMOD and attempts to authenticate. <code> arsusec</code> is normally used for providing alternate authentication methods to OnDemand, like Single Sign On ("SSO") and in previous versions, Lightweight Directory Access Protocol ("LDAP").
: When enabled, the compiled <code> arsusec</code> binary must be located in the 'exits' directory under the 'bin' directory in your IBM CMOD installation directory, for example, <code> /opt/IBM/ondemand/V9.5/bin/exits</code>. If the parameter is enabled, and the <code> arsusec</code> compiled binary is missing from the 'exits' directory, the server may be unable to start, and cause <code> arssockd </code> to report a [[Unable_to_determine_the_database_engine|ARS4013E - Unable to determine the database engine]] error.

;SRVR_OD_STASH
: Specifies the location of the Content Manager OnDemand Server's configuration stash file - passwords for DB2, LDAP, Oracle, ZooKeeper, etc.
: This parameter should contain the FULL path to the stash file: <code>SRVR_OD_STASH=/opt/ibm/ondemand/V10.5/ars.stash</code>
: NOTE: For security, this file should be protected at the filesystem level with very restrictive permissions: <code> chmod 600 ars.stash</code>   to prevent the password data from being leaked.

== Related Articles ==

[https://www.ibm.com/docs/en/cmofm/10.5.0?topic=services-configuring-arsldapini-file LDAP Configuration File]

ars.cfg

2024-11-20T19:56:07Z

Jderrick: /* IBM CMOD Miscellaneous Configuration */

{{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  
|-
|
#
# 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  
|-
|
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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  
|-
|
#
# 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: 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 ===
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  
|-
|
###########################################
# 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.

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

== IBM CMOD Storage Management Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand TSM Configuration Parameters  
|-
|
######################################################
# 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]] 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
: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] Usage and history of this parameter was described in [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf ODNews 2023 Q4]
;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: [https://ODUG.net/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.

Main Page

2024-11-07T15:05:45Z

Jderrick: Updated links to IBM CMOD Documentation

{{TOCright}}

== ODUG is back online! ==
[https://ODUG.net ODUG.net] is the new address of the Content Manager OnDemand User Group Forums. We managed to save nearly all the data from the old site, plus we upgraded almost every aspect of the site.

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
April 24th, 2024 - IBM Content Manager OnDemand v10.5 Fix Pack 8 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.7&platform=All&function=all IBM CMOD v10.5.0.8] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://ODUG.net/

The OnDemand User Group changed domains in the summer of 2024 due to a lack of interest by the existing administrator. The interim administrators are Jeff Squier and Justin Derrick.

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/products/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[https://www.ibm.com/mysupport/s/topic/0TO0z0000006VixGAE/content-manager-ondemand IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/docs/en/cmofm/10.5.0 v10.5] | [https://www.ibm.com/docs/en/cmofm/10.1.0 v10.1] | [https://www.ibm.com/docs/en/cmofm/9.5.0 v9.5] | [https://www.ibm.com/docs/en/cmofm/9.0.0 v9.0]

Still running an older version of IBM Content Manager OnDemand? You can find the documentation in PDF Format here:

    [https://cmod.wiki/dox/CMODv8.5/ IBM CMOD v8.5]   [https://cmod.wiki/dox/CMODv8.4/ IBM CMOD v8.4]   [https://cmod.wiki/dox/CMODv8.3/ IBM CMOD v8.3]   [https://cmod.wiki/dox/CMODv7.1/ IBM CMOD v7.1] [https://cmod.wiki/dox/CMODv2.2/ IBM CMOD v2.2])

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

ODNews 2024: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2024Q1.pdf 1st Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

Main Page

2024-11-07T14:58:30Z

Jderrick: Updated link to IBM CMOD Support Page

{{TOCright}}

== ODUG is back online! ==
[https://ODUG.net ODUG.net] is the new address of the Content Manager OnDemand User Group Forums. We managed to save nearly all the data from the old site, plus we upgraded almost every aspect of the site.

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
April 24th, 2024 - IBM Content Manager OnDemand v10.5 Fix Pack 8 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.7&platform=All&function=all IBM CMOD v10.5.0.8] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://ODUG.net/

The OnDemand User Group changed domains in the summer of 2024 due to a lack of interest by the existing administrator. The interim administrators are Jeff Squier and Justin Derrick.

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[https://www.ibm.com/mysupport/s/topic/0TO0z0000006VixGAE/content-manager-ondemand IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

ODNews 2024: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2024Q1.pdf 1st Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

Unable to create ARCHIVE database

2024-10-30T18:35:58Z

Jderrick: Major overhaul - consolidated troubleshooting tasks, plus reformatting to make the individual steps more distinct. Added DB2 reference links for v11.1 and v11.5, removed v9.5.

{{TOCright}}

== What was the error? ==
Message Number: 4067

Message Severity: Error (Corrective action is required to continue)

Message Name: ARS4067E

Message Text: Unable to create the archive database. err=<sqlcode>

== Related errors ==
arsdb: [[ARS4019E]] Unable to create the DB2 ARCHIVE database

== What were you doing? ==

Probably trying to create the database after installing Content Manager OnDemand.

== Example ==
ARS4067E Unable to create the archive database. err=<sqlcode>

== Troubleshooting ==

This is a frustratingly generic and non-descript error message generated when the <code> [[arsdb]] -cv </code> command can't create the database. There's no single thing to check for, except reviewing all your configuration steps for the correct information.

Here are some of the most basic things to review...

=== CMOD Configuration Diagnostics ===

* Check that you have permission to read the configuration files in the 'config' directory

/usr/lpp/ars/config
/opt/ondemand/config
/opt/IBM/ondemand/V9.5/config
/opt/ibm/ondemand/V10.1/config
/opt/ibm/ondemand/V10.5/config

; Ensure SRVR_INSTANCE OWNER and DB2INSTANCE are the same!
: Inside [[ars.ini]] the SRVR_INSTANCE_OWNER needs to be the local user name defined to the operating system, usually 'archive' but often 'odadmin' or 'cmodadm' or 'arsadm' or 'cmodprod'.
: Inside [[ars.cfg]] the DB2INSTANCE parameter needs to be the SAME as what you used in the prior step!
: In installations where the database owner and CMOD Admin account are different, use the DATABASE owner's account (db2inst1, cmoddba, etc.)

; Check for typographical errors in the [[ars.ini]] and [[ars.cfg]] files
: Specifically, check the spelling of <code>/arsdb</code>, <code>/arsdb_primarylog</code>, and <code>/arsdb_archivelog</code> or equivalent directories.

; Check <code>ars.dbfs</code> configuration
: Ensure this filesystem file exists, and have the correct permissions -- your database engine may not create these directories for you!
: Check the filesystem itself -- if there are leftover directories and files in /arsdb, or your primary and archive log filesystems, database creation will fail.

; Don't trust your environment variables!
: If you run <code>echo $DB2INSTANCE</code> in your login shell, this is NOT the variable that gets used -- the DB2INSTANCE parameter in [[ars.cfg]] will take precedence.

=== DB2 Diagnostics ===
This is a repeat, but it's important! Before running the <code>arsdb -crtv</code> command, ensure that the database filesystems (listed in [[ars.dbfs]]) and log filesystems (listed in [[ars.cfg]]) are empty -- delete any remnants of previous databases if you're rebuilding a new IBM Content Manager OnDemand database.

If the above hints for configuring CMOD don't help, consider checking the db2diag.log file. You can find db2diag.log inside your instance directory, inside the db2dump subdirectory. On a standard install, it should be located here:

/home/archive/sqllib/db2dump/db2diag.log

Try searching for the SQL return code in the Messages & Codes References, or use the online help:

At a UNIX shell prompt:
$ db2 "? sql-1390"

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

IBM DB2 v11.1 Messages Reference [https://www.ibm.com/docs/en/db2/11.1?topic=reference-messages Messages Reference]

IBM DB2 v11.5 Messages Reference [https://www.ibm.com/docs/en/db2/11.5?topic=content-messages Messages Reference]

Try searching in the format SQL#### - where #### is the zero-padded return code, like "SQL0326".

ars.cfg

2024-10-30T12:58:36Z

Jderrick: /* IBM CMOD LDAP Sync Parameters */

{{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  
|-
|
#
# 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  
|-
|
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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.

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

== IBM CMOD Storage Management Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand TSM Configuration Parameters  
|-
|
######################################################
# 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]] 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
: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] Usage and history of this parameter was described in [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf ODNews 2023 Q4]
;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: [https://ODUG.net/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.

ars.cfg

2024-10-30T12:57:03Z

Jderrick: /* IBM CMOD Server Parameters */

{{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  
|-
|
#
# 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  
|-
|
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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. 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.

== IBM CMOD Storage Management Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand TSM Configuration Parameters  
|-
|
######################################################
# 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]] 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
: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] Usage and history of this parameter was described in [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf ODNews 2023 Q4]
;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: [https://ODUG.net/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.

Ten Reasons to use IBM Content Manager OnDemand

2024-10-21T21:10:19Z

Jderrick: Removed dead links, fixed some grammar errors.

{{TOCright}}
Some of IBM's competitors think it's a good idea to spread a lot of Fear, Uncertainty, and Doubt ("FUD") around the future of IBM CMOD. Here's ten answers to their suggestions that you need to replace CMOD with their solution:

# IBM has been recognized as a leader in the ECM space by Gartner for as long as they've been producing their Magic Quadrants for Enterprise Content Management. The competitors that have resorted to disparaging CMOD aren't even on the list!
# OnDemand's compression is best-in-class. By offering built-in system-wide de-duplication & advanced compression algorithms, IBM CMOD has saved customers billions of dollars in reduced storage costs over its 20+ year lifetime.
# IBM's CMOD Cloud offerings allow organizations to leverage skilled IBM technicians and [https://www.forbes.com/sites/bobevans1/2018/01/19/ibm-joins-microsoft-amazon-atop-cloud-world-booming-cloud-business-ends-long-revenue-decline/ IBM's expansive cloud infrastructure] to serve more users, at a lower price point than on-premise solutions.
# The [https://ODUG.net Content Manager OnDemand User's Group ("ODUG")] is a vibrant user community with a history going back to the mid-90's -- almost as long as CMOD's been a product!
# [[Main_Page#CMOD_Webinars_.26_Workshops|ODUG's IBM Content Manager OnDemand Webinars]] & annual ODUG Technical Conference feature OnDemand's senior development and architecture teams to gather feedback and take questions from the Content Manager OnDemand customers.
# IBM has been offering free CMOD Workshops for the past 10 years (including virtual sessions during the pandemic), and has announced another round of [[Main_Page#Content_Manager_OnDemand_News_.26_Events|workshops in cities around the world]] for CMOD customers. Did I mention they're free? Because they're FREE!
# Despite outsourcing development of CMOD to UNICOM in January 2016, the development team has been expanded, and new features are regularly added to CMOD -- data encryption, active-active redundancy, plus support for storing data in Amazon S3, Hadoop HDFS, Openstack Swift Object Store, Azure Cloud, and [https://www.theregister.co.uk/2018/02/02/gartner_object_storage_report/?linkId=47896773 IBM Cloud Object Storage], LDAP Group syncing, document hashing for data security & reconciliation, support for external encryption key management, and [https://cmod.wiki/dox/RESTapiDoc/CMOD_10_5_REST_API_Documentation.html ODWEK REST API] support in the release of CMOD 10.5 in 2020 for Multiplatforms and z/OS.
# Speaking of enhancements... IBM has been excellent at delivering on new features, functionality, and usability improvements to Content Manager OnDemand in [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|FixPacks]] through co-operation with ODUG, and its regular enhancement requests.
# And back to the topic of developers... some of CMOD's competition has lost their core developers -- who are now working on building solutions to migrate customers onto '''other''' ECM products. Ouch!
# There's also a vibrant community of IBM Business Partners and consultants providing sales & services, plus developing 'bolt-on' products that enhance Content Manager OnDemand even further, adding data mining, workflow, and integration features.

And an extra one for good measure...

Since 2014, IBM has completed over *36* migrations to CMOD ''away'' from the competitor solutions. If the competition actually had a better product -- wouldn't they be hosting webinars singing about their virtues? No wonder they're resorting to Fear, Uncertainty, and Doubt in order to try and scare up new business!

ARS1196E

2024-10-16T22:49:15Z

Jderrick: /* Articles Related to this message */

{{TOCright}}
== What was the error? ==
'''Message Number''': 1196

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS1196E

'''Message Text''': Invalid generic index file format: >GROUP_FIELD_VALUE;987654321<

== Example ==
ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;987654321<

== Related Errors ==
[[ARS1133I|ARS1133I The last row successfully loaded was X]]

== What were you doing? ==
You were loading documents into Content Manager OnDemand with a CMOD Generic Index File.

== What happened? ==
There was an error in the file that caused the load to fail.

== Troubleshooting ==
Check the [[arsload]] log for the informational message ARS1133I, which shows the last record that was successfully processed. The error should appear in the next record inside the Content Manager OnDemand Generic Index file.

It's likely that the system that generated the Generic Index file didn't produce the file properly, and errors in data or formatting stopped the load.

Specifically, check for blank rows, repeated rows, out-of-sequence lines, or extra spaces or tab characters at the end of a row. Each record should have GROUP_FIELD_NAME records (with the name of an Application Group field), followed on the next line by a GROUP_FIELD_VALUE record with valid data for that field. At the start of a Generic Index File, before any other parameters, the CODEPAGE parameter must be specified so that CMOD knows what type of data it will find in the Generic Index file. Then, the GROUP_FIELD_NAME and GROUP_FIELD_VALUE parameters are repeated for each piece of document, followed by three parameters, in this order: GROUP_OFFSET, GROUP_LENGTH, and GROUP_FILENAME.

It's probably most convenient to open the Generic Index file in your favourite text editor, and use the 'Search' or 'Find' function to find the string from the error message. Remember that the string reported by the ARS1196E error may appear multiple times in the Generic Index file. If the string provided by the CMOD error message is too vague, look for the ARS1133I message to get an indication of where the error occurs inside the file, and the error may appear in the rows above or below the data you're searching for. Using your text editor's 'Next' button in the 'Search' or 'Find' function may allow you to skip to the correct record number.

== Exercise ==

There are three errors in this sample generic index file. See if you can find them.

GROUP_FIELD_NAME:CUST_NUM
GROUP_FIELD_VALUE;987654321
GROUP_FIELD_NAME:RPT_DATE
GROUP_FIELD_VALUE:2020-03-05
GROUP_FIELD_VALUE:STMT_LANG
GROUP_FIELD_VALUE:ENG
GORUP_OFFSET:5758158
GROUP_LENGTH:144843
GROUP_FILENAME:CUSTSTMT_20200305_RETAILBK_BaxterBay.out

On line 2, the character separating GROUP_FIELD_VALUE and the customer number is a semicolon (;) instead of a regular colon character (:).
On line 5, the record should read 'GROUP_FIELD_NAME', not 'GROUP_FIELD_VALUE'.
On line 7, the GROUP_OFFSET parameter is misspelled.

== Articles Related to this message ==
OnDemand User Group (ODUG) Forums: [https://odug.net/index.php?topic=3481.0 Issue with Generic Indexer]

Main Page

2024-09-17T19:39:30Z

Jderrick: Added banner for OnDemand User Group Forums.

{{TOCright}}

== ODUG is back online! ==
[https://ODUG.net ODUG.net] is the new address of the Content Manager OnDemand User Group Forums. We managed to save nearly all the data from the old site, plus we upgraded almost every aspect of the site.

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
April 24th, 2024 - IBM Content Manager OnDemand v10.5 Fix Pack 8 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.7&platform=All&function=all IBM CMOD v10.5.0.8] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://ODUG.net/

The OnDemand User Group changed domains in the summer of 2024 due to a lack of interest by the existing administrator. The interim administrators are Jeff Squier and Justin Derrick.

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[http://www-947.ibm.com/support/entry/portal/product/enterprise_content_management/content_manager_ondemand_for_multiplatforms?productContext=-816420431 IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

ODNews 2024: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2024Q1.pdf 1st Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

Glossary

2024-08-22T18:57:32Z

Jderrick: Updated link to ODUG the CMOD User Group

{{TOCright}}
== Acronyms & Initialisms ==

; AFP
: Advanced Function Presentation, a print-stream format made popular by IBM. AFP Streams can contain 'resources' - data that defines the size of a page, segments, fonts, and graphics like logos and bar-codes. IBM Content Manager OnDemand saves these AFP Resources separately, and compresses the remaining data, with compression ratios that regularly exceed 90%. When Content Manager OnDemand retrieves an individual document, the resources are added to the data file, to create a document that can be recreated with perfect fidelity.

; AIX
: Advanced Interactive eXecutive. IBM's UNIX operating system for servers containing POWER processors. AIX was one of the first platforms supported by IBM Content Manager OnDemand.

; ARS
: The prefix for all CMOD commands. Rumoured to stand for 'Archive Retrieval System'. You can find information on IBM Content Manager OnDemand commands like [[arssockd]] and [[arsdoc]] elsewhere on the wiki.

; AWS
: Amazon Web Services. Probably the world's largest Cloud Computing provider. Allows access to Servers, Storage, and Software for a monthly fee. (See 'S3' below.)

; CMOD
: IBM Content Manager OnDemand, IBM's Enterprise Report Management software. CMOD has consistently been the #1 ERM software product as ranked by Gartner since shortly after it's release. It offers the highest compression ratios and highest reliability for print streams, XML, and PDF data.

; COLD
: Computer Output to Laser Disc - a generic term that referred to data storage systems that stored digital files on Laser Disc, for example, Magneto-Optical or WORM discs. This acronym has been successively replaced by "Enterprise Content Management" and "Enterprise Report Management" over the years. The concept has remained the same -- store print data where it can be compressed and stored efficiently, and retrieved easily via an organization's internal network, or over the Internet through the [[IBM CMOD ODWEK|IBM Content Manager OnDemand Web Enablement Kit]].

;DBA(s)
: DataBase Administrator(s). These are the people (or team) that are responsible for ensuring the usability and security of information stored in database products like IBM DB2, Microsoft SQL Server, or Oracle. You should refer to them when you have questions about the underlying database used by IBM Content Manager OnDemand, or request their assistance when it comes to critical tasks like taking backups and testing restores.

; DMS
: Database Managed Space - an older method for allocating storage to databases. In DB2, a system administrator would allocate a raw device (a 'logical volume' in AIX, a 'slice' in Solaris, or a 'partition' in Linux) for DB2's exclusive use. Databases now largely use the SMS method for the increased reliability offered my modern file systems, with features like journaled file systems, redundancy, compression, expandability.

; ECM
: Enterprise Content Management - a newer, more generic term than COLD, recently giving way to the more descriptive and accurate "Enterprise Report Management" or ERM. ECM broadly refers to a variety of content management solutions, all with different features (Workflow, Records Management, Archiving, etc.)

; ERM
: Enterprise Report Management - specifically, the storage of reports and records for an organization. The narrower focus of ERM is the long-term archiving, retention, searching, retrieval, and eventual disposition or deletion of documents, primarily for legal or regulatory compliance, but more frequently to improve customer experience and reducing support costs by allowing customers to access their information through web-based portals, or smartphone applications.

; FORMDEF / PAGEDEF
: Form Definition / Page Definition. A component of an AFP data stream, defining the parameters of a form or page. FORMDEFS and PAGEDEFS can either be included inside an AFP data stream, or stored in a 'library' on the CMOD server or high-volume printers.

; FTP
: File Transfer Protocol. A standard method for transferring files across TCP/IP networks. FTP is insecure, and should only be used on protected internal networks. Use a secure method for file transfers, like SFTP, NDM, MQ Series File Transfer Edition.

; HDFS
: Hadoop Distributed File System. A filesystem provided by the open source Apache Hadoop project. [https://hadoop.apache.org/]

; ICN
: IBM Content Navigator - a highly flexible, customizable, and modern front-end for many IBM Products in the ECM space, including FileNet P8, Content Manager v8, and Content Manager OnDemand. IBM Content Navigator is built to be modular, to allow for programmers to easily reuse sections of the interface in their own code, or for the Content Navigator interface to be customized and 'branded' with customer logos and colors.

; ICOS
: IBM Cloud Object Storage. IBM's publicly available pay-as-you-go cloud storage service.

; GIF
: Graphic Interchange Format - a rather old image format with limited colors (256) and relatively poor compression by today's standards. As long as an image contains less than 256 colors, the image compression is lossless, unlike JPEG.

; JPEG
: Joint Photographic Experts Group - a method of 'lossy' compression, primarily used for full colour photographs. JPEG saves storage space by discarding information in a way intended to be imperceptible to humans. The compression ratio can be adjusted to keep more data (at the cost of larger files) or save more space, which results in visible 'compression artifacts' leading to a loss of detail.

; JES
: [http://www-01.ibm.com/support/knowledgecenter/zosbasics/com.ibm.zos.zconcepts/zconc_whatisjes.htm Job Entry Subsystem.] In CMOD, JES is a source of mainframe output data from reports "the JES spool". This output data can be downloaded directly from a mainframe using arsjesd. arsjesd has become rather unpopular as a method for transferring files, as it does not support encryption to keep data private, is not restartable, and offers no ability to report on the success or failure of loading the received file.

; LDAP
: Lightweight Directory Access Protocol - a centralized system for authenticating users to a variety of systems, and conveying entitlements to those users through group membership. IBM Content Manager OnDemand supports authenticating users via LDAP, and provides entitlements via membership in groups. Starting in Content Manager OnDemand v10.1.0.2, CMOD supports LDAP Sync - which offers the ability to synchronize users and groups from an Enterprise LDAP server to CMOD's internal User & Group tables.

; NAS
: Network Attached Storage - a class of storage devices, primarily accessed over a standard network connection. Often, NAS devices are referred to as "Cheap and Deep" storage, as they tend to use larger capacity, but slower SATA hard drives in the 2TB to 14TB range. This allows for high storage density at the cost of speed and reliability.

; ODWEK
: OnDemand Web Enablement Kit - a series of interfaces to create world-wide-web friendly interfaces into the data stored in Content Manager OnDemand. Various technologies include Common Gateway Interface (CGI) scripts, Enterprise Java Beans, Java Servelets, [https://cmod.wiki/dox/ODapiDoc/v10.5/ Java API], and new for CMOD v10.5 in 2020, [https://en.wikipedia.org/wiki/Representational_state_transfer REpresentational State Transfer] or [https://cmod.wiki/dox/RESTapiDoc/CMOD_10_5_REST_API_Documentation.html REST API].

; PDF
: Portable Document Format. Adobe's popular format for creating, viewing, and printing documents that maintain their fidelity (look and feel) across many different types of platforms (i.e. Mac, Windows, Linux, UNIX)
: IBM Content Manager OnDemand's PDF Indexer now has the ability to 'de-duplicate' the contents of PDFs, in much the same way as Content Manager OnDemand does for AFP documents with the ACIF indexer.

; POWER
: Performance Optimized With Enhanced RISC. IBM's custom-designed server-grade Central Processing Units (CPUs). IBM's POWER CPUs focus on providing the maximum amount of computing power, at the cost of energy efficiency and therefore heat dissipation. IBM's POWER servers are known for being power hungry and requiring substantial cooling -- meaning they are often very loud.

; PSEG
: Page Segment. A component of an AFP data stream, defining a portion of a page. Page Segments are AFP Resources, and as such, are extracted from AFP data streams and grouped into a 'resource bundle', which is one of the ways IBM Content Manager OnDemand saves storage space through de-duplication.

; RISC
: Reduced Instruction Set Computing. Refers to a concept in processor design where the CPU has less-complex individual instructions, but more of them. Opposite of CISC, Complex Instruction Set Computing. The current generation of CPUs is a combination of both RISC and CISC -- including large numbers of parallel RISC-style cores, plus 'extensions' that provide fast CISC functions useful for intensive tasks like data compression and encryption, or processing audio & video.

; S3
: Simple Storage Service. A product of Amazon Web Services (See 'AWS' Above), the Simple Storage Service allows software to store virtually unlimited amounts of data into the 'cloud' quickly and easily for a relatively low price per gigabyte. IBM Content Manager OnDemand S3 support was enabled in v9.5.0.4. See [[ars.cfg]] for information on configuring Content Manager OnDemand for Cloud Storage with Amazon S3.

; SFTP
: Secure File Transfer Protocol. Similar to FTP only in name. SFTP assures strong authentication ("I am who I say I am"), privacy (contents are encrypted in transit), and integrity (contents are verified for fidelity). All current systems should remove FTP and replace it with SFTP or another secure file transfer method. Authentication can be performed through the use of passwords (which are cryptographically hashed before being sent over the network) or through Symmetric Public Key Encryption - a method by which two keys (one private, and one public) are used to exchange information (like authentication credentials) securely.

; SMS
: System Managed Space - in DB2, SMS Tablespaces exist on regular filesystems. Your operating system may provide features like journals, compression, redundancy, or caching, making SMS preferable to the older DMS method. See DMS above for the older storage method, Database Managed Space.

; TCP/IP
: Transmission Control Protocol / Internet Protocol. The network protocol used in the overwhelming majority of organizations, and the internet at large. TCP/IP version 4 is common and extremely popular. TCP/IP v6 has been available for nearly a decade, but adoption of v6 is slow due to the perceived complexity and incompatibility with legacy software. IBM Content Manager OnDemand operates by default on TCP port 1445 for unencrypted communications, and administrators frequently use TCP Port 1446 for SSL/TLS encrypted connections.

; TIFF
: Tagged Image File Format - a graphic image format primarily used to store black and white or grey-scale scanned images. Originally developed by Adobe, TIFF has become an international standard. TIFF is actually a container format, which means that it can use many different image compression methods to store documents efficiently. The latest standards are JBIG and JBIG2, but due to patent issues, these standards are not widely supported across platforms and tools.

; TSM
: Tivoli Storage Manager (or TSM) is used to connect OnDemand to a wide variety of storage technologies, such as tape, tape libraries, optical drives, optical jukeboxes, or proprietary devices like EMC Centera. TSM has three main uses - Archive, Backup, and HSM. CMOD utilizes the 'Archive' component to provide long-term management of data loaded into CMOD. In 2017, Tivoli Storage Manager was renamed "Spectrum Protect" after version v7.1.4. The features, functionality, and compatibility are preserved across versions.

;WORM
: Write-Once, Read-Many - a type of unalterable, permanent storage, primarily optical disks in the years prior to 2005, but also magnetic tape and magnetic hard disc drives. WORM storage is often required for various regulatory agencies and many local and national government regulations. The main criticism of WORM storage is that once the data on the device has expired, it cannot be re-used, and must often be certifiably destroyed to comply with privacy laws. Since IBM Content Manager OnDemand v10.1 supports both document encryption and cryptographic hashing, the requirement for WORM storage devices may be relaxed, as any tampering with the encrypted data would render it irrecoverable, and any alteration of the underlying document would be detected through a change to the cryptographic hash at retrieval time.

; XML
: eXtensible Markup Language. A flexible data structure for storing data. See the [https://ODUG.net/index.php?topic=2421.0 IBM CMOD XML Indexer presentation on ODUG] (Login Required, new registrations approved within 48 hours, use your corporate eMail account) Not only can XML data be quickly and easily ingested into IBM Content Manager OnDemand, the XML data can be displayed in different ways for different devices or users, by altering the style sheets. Content Manager OnDemand de-duplicates and compresses XML data in the same way it stores AFP and PDF data, leading to reduced storage costs for customers.

== Terms Specific to Content Manager OnDemand ==

;Application
: An Application is a defines a specific report or type or documents to Content Manager OnDemand. The definition include things like the format of the data (Line data, AFP, PDF, or an Image like JPEG / GIF / TIFF / PNG), how it should be displayed (code page for text, rotation of the page, or definitions for headers and columns in line data reports), and how CMOD should obtain the index metadata to load into the database - ACIF is the default Indexer for AFP and Line data, ARSPDOCI for the PDF indexer, or the Generic Indexer. ACIF and PDF indexers interpret the data inside the report itself, finding defined fields to create an index file with. The Generic Indexer, primarily used for graphic formats, or other types of data that can't be read directly, reads a formatted index file to collect the metadata. Applications must belong to an Application Group.

;Application Group
: A Group of Applications. An Application Group ('AppGroup' or 'AG') defines index, storage management, retention, and expiration criteria. All Applications that belong to a specific Application Group will have the same metadata fields used for searching for documents, have their Application data managed in the same way (how long they are cached, and where they will be stored after the caching has expired), and expire in the same fashion. As implied by the name, an Application Group can contain more than one type of data - Applications can be defined for various types of data (for example AFP for customer statements, PDF for letters sent to customers, and TIFF images for scanning incoming mail from customers) but belong to a single Application Group -- making accessing all types of documents for a customer fast and easy.
: Application Groups and Applications are usually structured to combine data with the same business use case (Customer Service, Human Resources, Accounts Payable, etc.), followed closely by the metadata, indexing, storage management, and disposition requirements. Defining an Application Group for each Application is not recommended -- binding too many Application Groups into a single folder negatively affects performance.

;Folder
: A Folder determines how the data inside Application Groups will be presented to the user or a custom-built web application through the Java API. It allows an administrator to define search fields, the order that those fields appear in, any default values and/or required fields for searches, the fields that are displayed when a search is completed, and allows you to assign user-friendly names to index fields (like "Customer Number" rather than Cust_Num").
: Multiple Application Groups can be added to a single folder, allowing users to perform searches across multiple reports or data types with one search, although relying too heavily on this feature can lead to poor performance, as each query on the folder turns into many queries for each Application Group connected, and if a connected Application Group contains a large number of documents, it can further affect performance by performing one query per table.

;Storage Set
: A Storage Set connects Content Manager OnDemand to storage nodes using a variety of storage technologies. Application Groups are required to have a Storage Set defined so that CMOD can manage the archived data.
: Before IBM CMOD v9.5.0.6, Tivoli Storage Manager ("TSM") or Object Access Method ("OAM") were the only supported storage managers. Tivoli Storage Manager was popular on the Content Manager OnDemand for Multiplatforms systems, for the purpose of providing access to long-term archival storage devices like Magneto-Optical or WORM optical discs, tape libraries, or pools of hard disc storage.
: Starting in Content Manager OnDemand v9.5.0.6, new Storage Set Types were supported, including Amazon Simple Storage Service ("S3"), Hadoop Distributed File System (HDFS), and OpenStack Swift. In IBM CMOD v10 and higher, Content Manager OnDemand supports IBM Cloud Object Storage, and Filesystem (aka Network-Attached-Storage or NAS). For more information about configuring IBM Content Manager OnDemand Cloud Storage, see [[ars.cfg#IBM_CMOD_Cloud_Storage_Options|IBM CMOD Cloud Storage Options]].

;Cabinet
: A Cabinet is a group of folders.
: Cabinets are useful for providing easy access to a number of folders to users. In Content Manager OnDemand, cabinets are often created to help end users perform a specific job function where they need access to different types of data.
: In the case of an employee of a Customer Service department, users may need access to monthly statements, correspondence, internal notes or call recordings which may be stored in different folders. In the case of an employee of a corporate Accounts Payable department, they may only need access to one folder, whereas an internal auditor may need access to Folders for Accounts Receivables, Accounts Payable, as well as Financial Reports, Inventory, and Human Resources.

;Printer
: A printer definition is used to provide access to server-side printing. Very few customers actually define these sorts of printers, instead choosing to redirect print jobs to electronic formats that can be displayed on computer monitors, smartphones and tablets.
: In the context of IBM CMOD, printers are usually large industrial-scale laser printers fed by large spools of paper.
: Historically, line data could be sent to large "chain printers" to produce reports on 'greenbar' paper.

;User
: A user is, well, a CMOD user. Users must be defined in order to log into the CMOD server.
: Starting in IBM CMOD v8.5, password authentication for users defined in Content Manager OnDemand could be performed by Lightweight Directory Access Protocol, or LDAP.
: In OnDemand v10 and higher, Content Manager OnDemand now supports synchronizing Users and Groups with LDAP servers, adding more flexibility, and releasing CMOD admins from duplicating the effort of managing CMOD users and groups.

;Group
: A Group is a collection of users. Groups can define access permissions to specific Application Groups (including limiting access to searches in Application Groups with Query Restrictions), Folders, Cabinets, or Printers.
: As mentioned above, CMOD v10 now supports LDAP Sync.

;Cache
: "Cache Storage" is a local filesystem of fast magnetic disk (hard drives) for the purpose of storing the most frequently accessed data, so that retrievals are extremely fast.
: CMOD data that isn't stored in the cache is stored in nodes, defined in Storage Sets. Data stored inside a Storage Node is generally a MINIMUM of 10x slower to retrieve, due to the overhead of communicating with the various storage methods, and the slower devices they often use for "Cheap and Deep" storage.

;Segment
: In order to keep database queries fast, OnDemand uses database table segmentation. Table segmentation organizes data into separate tables, and in the case of CMOD, segments are determined by the number of rows configured at the Application Group level. CMOD tracks segments by the minimum and maximum dates found inside each database segment. By requiring each query contain a date, OnDemand can quickly eliminate tables from being searched by excluding those tables that don't contain the dates being searched for.
: Before DB2 supported table segmentation natively, the Content Manger OnDemand developers decided to split index data into tables of 10 million rows each. Using this method keeps search performance linear, as only the tables containing documents in the date range you're looking for ( for example, 3 months, or 1 year) are actually searched.
: In some of the largest IBM Content Manager OnDemand customer sites, they've modified the Application Group definitions to include up to 250 million rows per database table segment in order to keep performance brisk.

; Resources
: In the context of AFP or PDF data, the category of data used to render the data on the page. For example, fonts, images, overlays, lines, boxes, or barcodes. OnDemand splits resources from data in order to maximize the compression of actual report data.
: By creating 'resource bundles' from data being loaded, CMOD de-duplicates the data, optimizing storage. These resource bundles can be re-used if data loaded in the future contains identical sets of resources in an Application Group. For example, a credit card company might load statements into CMOD in AFP format. Items like logos, graphics, fonts, and page definitions are likely to stay the same from month to month - meaning that a resource bundle may be used for millions or billions of documents - saving storage space each time!

;User Exit
: A User Exit is a way for advanced users to customize the behavior of OnDemand, by writing custom programs ("exits") that modify data as it flows through CMOD.

; User Defined Data Type
: Content Manager OnDemand supports several types of data natively -- AFP, PDF, XML, Line Data, and Images. If you want to store a different type of data, you can configure CMOD to use a "User Defined" data type. User Defined data types allow OnDemand to store almost anything.
: In the vast majority of cases where User Defined Data Types are used (to store things like recordings of phonecalls to an organization's customer service centre) the Generic Index type is used to provide metadata to CMOD.
: When creating Applications with a User Defined data type, pay special attention to the compression settings. Some data, like MP3 audio files, are already compressed, and the Compression setting should be set to 'disable'.

== OnDemand Indexing Tools ==
;ACIF
: ACIF stands for AFP Control and Indexing Facility. Originally a mainframe tool, ACIF can convert Line Data to AFP for storage inside CMOD, or extract index data automatically from reports.

;Generic Index
: For data types that can't be indexed automatically, Content Manger OnDemand supports 'Generic' index files, which are specially-formatted text files that contain the index values for individual documents. Generic Index files are used primarily for loading Image format files (TIFF, PNG, GIF, JPEG), but can be used in combination with User Defined data types to load almost any type of digital data into CMOD.

;PDF Indexer
: In order to load PDF files automatically, the PDF Indexer defines areas inside PDF files that contain the index values for documents.

;XML Indexer
: A new feature in CMOD v9.5, the XML indexer allows you to select data from inside XML data, and load it into CMOD.

;Full Text Indexer
: Introduced in OnDemand v9.0, the Full Text Indexer is a component that creates full text indexes for data stored in CMOD.

== OnDemand Command-Line Tools ==
;arsacif
: The ACIF Indexer, which parses input files for index information, and optionally converts line data into AFP format.

;arsadmin
: A tool used primarily for unloading data inserted into the OnDemand server by arsload. Other features allow you to compress/decompress data, or save/retrieve individual storage objects.

;arsjesd
: A daemon that listens for mainframe output via a TCP/IP socket. This is a fast, efficient way to transfer mainframe reports or print streams directly into files on the CMOD server, to be loaded at a later date by arsload.

;arsload
: The utility that loads data into Content Manager OnDemand. 'arsload' gets configuration data from the Application definition, and indexes, compresses, and stores index, data, and resources.

;arsmaint
: The maintenance utility for OnDemand. 'arsmaint' can expire data, indexes, perform cache maintenance, or reorganize database tables.

;arssockd
: This is the main OnDemand process -- if arssockd isn't running, then CMOD isn't available for end users, or loading data.

;arstblsp
: A utility for altering table spaces within Content Manager OnDemand.

;arsxml
: 'arsxml' allows you to add, update, or export configuration data inside CMOD.

== General Information Technology Terms Related to Content Manager OnDemand ==

;Centera
: EMC's WORM solution using custom software and commodity hard drives. WORM is enforced by software, not by any irreversible physical change, which allows the re-use of storage space once data has reached its retention period and deleted.

;Content Management
: A generic term referring to the storage and retrieval of data with centralized control and fixed methodology.

;Magneto Optical
: A storage technology that uses both lasers and magnetic fields to create an optical disc that is both re-writable, and impervious to magnetic fields. Magneto-Optical discs have been known to survive catastrophic events like floods and smoke damage.

; Secondary Storage
: Refers to storage for Content Manager OnDemand that is not the cache storage. Since IBM CMOD 9.5.0.3, there have been many options in addition to Spectrum Protect (formerly: Tivoli Storage Manager). These include Simple Storage Service (S3), IBM Cloud Object Storage (ICOS), Hadoop Distributed Filesystem (HDFS), and OpenStack Swift, and a standard filesystem.

; SnapLock & SmartLock
: Proprietary technologies that lock files from modification on NAS devices by setting the modification timestamp on a file to a point in the future.

;Tape
: Magnetic Tape Storage - similar to Audio Cassettes and Video Tape, Tape drives use a long, thin ribbon of plastic coated in magnetic particles to store data. Tape has traditionally had much higher storage capacity than hard drives or optical storage. Around 2005, long-term storage on hard drives became more appealing as the capacity of a single device increased, and power consumption decreased.

ars.cfg

2024-08-20T18:13:41Z

Jderrick: Added more information on ARS_DB_MAX_SQL_TABLES

{{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  
|-
|
#
# 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  
|-
|
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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. 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.

== IBM CMOD Storage Management Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand TSM Configuration Parameters  
|-
|
######################################################
# 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]] 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
: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] Usage and history of this parameter was described in [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf ODNews 2023 Q4]
;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: [https://ODUG.net/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.

ars.cfg

2024-08-20T18:11:44Z

Jderrick: CMOD User Group link updated.

{{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  
|-
|
#
# 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  
|-
|
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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. 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.

== IBM CMOD Storage Management Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand TSM Configuration Parameters  
|-
|
######################################################
# 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] Usage and history of this parameter was described in [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf ODNews 2023 Q4]
;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: [https://ODUG.net/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.

arsmaint

2024-08-20T18:10:16Z

Jderrick: /* Related Articles */

{{TOCright}}

The IBM Content Manager OnDemand arsmaint command performs routine maintenance on CMOD servers. Maintenance can consist of migrating document data from the [[IBM CMOD Cache Filesystems]] to secondary storage, removing data from the cache to make room for new data, or deleting expired documents and metadata.

==arsmaint command usage==

The CMOD arsmaint utility must be run by the instance owner - an operating system account, usually named 'archive' or 'odadmin'. There are several command line options for CMOD's arsmaint utility:

== CMOD arsmaint commands ==

=== Special arsmaint commands ===
There are some arsmaint options that change the behaviour of the other arsmaint commands:

;-g
: Specifies the Application Group to process. You may specifiy this option multiple times in the same command. This option limits the other command options to be applied to the listed Application Group names. Application Groups that contain spaces must be quoted with a single double-quotation-mark. When using the -g option, you may only use the -c, -d, -e, -i, -m & -r commands.

;-t
: The -t ("time") arsmaint option will perform the requested commands as if they were being executed on the specified date. Specifying a time period in the future will lead to the expiration of data ahead of schedule. DO NOT use this command in a production environment without having first completed substantial testing in development or test environments.

=== arsmaint commands for expiration ===
;-c
:The -c option for the arsmaint command deletes document data from the cache filesystem.

;-d
:The -d option for the arsmaint command deletes metadata from the database.

;-e
:The -e option for the arsmaint command migrates index data to long-term archival storage. This option is rarely used because of the relatively low cost of disk storage, and the negative performance impact on queries.

;-n
:The minimum percentage capacity that arsmaint will try to empty the cache filesystem to. Use this command to clear out the arscache filesystems in preparation for an unusually large load of documents into Content Manager OnDemand, for example, year end financial reporting, or tax season.

;-x
:The maximum percentage capacity of the arscache filesystems that arsmaint will allow to remain empty.

NOTE: The -n and -x options are performed on a 'best effort' basis, and won't delete data that isn't ready for expiration, or hasn't already been moved to secondary storage. It's best to run <code>arsmaint -m</code> by itself first, to ensure that any data eligible for migration to long-term storage has already been moved.

The CMOD arsmaint command should be run with both the -c, -d, and -e options at the same time to prevent the database and cache and long-term storage from getting out of sync.

=== arsmaint commands for migration ===
;-f
:This option records an alert message in the Content Manager OnDemand System Log, and prints an error message to the terminal (for UNIX/Linux) or the console (on Windows system) when the cache filesystem exceeds the specified percentage. An alert from this option indicates that the arsmaint command was not able to remove enough data from the cache to make additional space for new data. You'll either need to adjust the caching settings for your Application Groups, or add more storage to the Cache Filesystem.

;-m
:The -m option migrates data from cache to long term archival storage if your IBM CMOD server has secondary storage defined, and your Application Group is configured to use it.

=== arsmaint commands for database maintenance ===
;-r
:This arsmaint command runs database statistics. Collecting (or updating) database statistics helps improve IBM CMOD query performance. Since Content Manager OnDemand is an archival product, running statistics once per week is usually more than enough to help keep CMOD queries fast. In addition, you may want to run database maintenance with the CMOD [[arsdb]] command before collecting statistics with the arsmaint command.

=== Other arsmaint commands ===
;-s
:Produces a report on CMOD cache filesystems ("arscache"), which is stored in the System Log.

;-v
:Validates the IBM CMOD cache ("arscache") filesystems, and reports back any unexpected problems.

;-u
:Specifies the IBM CMOD User ID which will be used to authenticate to IBM Content Manager OnDemand.

;-p
:Specifies the password, or path to the IBM CMOD stash file. Using passwords on the command line may expose passwords to other users on the server, and as a result, you'll receive a warning. Update your arsmaint commands to use a stash file in order to avoid the warning.

;-1 (hyphen-number-one)
:Specifies the trace file. Contents of the trace will be written to this file and path.

;-2 (hyphen-number-two)
:Specifies the trace level. See the trace.settings file in your CMOD config directory for more information on how to specify the trace level.

=== arsmaint Performance Considerations ===

A common complaint about CMOD's arsmaint command is the amount of time that is takes in order to run. Often, the configuration of CMOD Application Groups and the steady growth of the system are the causes of slow performance.

==== Application Group Configuration ====

Application Group settings that will lead to long arsmaint run times are:

;Expiration Type of Document
:Inside the Content Manager OnDemand Application Group configuration, there is a field called 'Expiration Type'. Choosing 'Document' is guaranteed to slow down performance of the arsmaint command, as this instructs IBM CMOD to review each and every document inside the Application Group tables to determine if the document is eligible for deletion.
:Even if the Expiration Type is set to 'Load', which would normally perform better than the 'Document' setting, if you have an extremely large number of loads of small documents into the Application Group (in the millions), then the arsmaint expiration process is very similar to Document expiration instead.
:If you are loading tens of millions of documents per day into your CMOD server, consider performing an [https://cmod.cloud/extraction/ Extraction] of your CMOD data, and loading it into an Application Group configured to use the Segment expiration type.

;Small Object Sizes
:The default stored object size in CMOD is 10MB. This relatively small size means that there may be billions of files inside CMOD. It may make sense to consider tuning this value to a larger number, to reduce the total number of objects, and to decrease the amount of files that the arsmaint command needs to inspect in order to complete.

;CMOD cache filesystem configuration
:If your system has an extremely large cache filesystem, or has a large number of very small files, then the CMOD arsmaint command can take a very long time to complete, as each file in the cache filesystem must be examined to determine if it's eligible for deletion. In many systems, this problem gets worse as a server ages, and more cache filesystems are added.

;Large numbers of expiring documents
:If your system has a large number of documents to expire from IBM CMOD, then the arsmaint command may run for an extended period of time, as it performs the work required. If your Content Manager OnDemand server includes a Tivoli Storage Manager server or other secondary storage for data, the expiration process may run more slowly as CMOD sends requests for the documents to be deleted.

== arsmaint command errors ==

If an error is encountered during database maintenance, then arsmaint may return an [[ARS0013E]] error. For example, the ARS0013E error may be encountered while trying to reorganize a time, or collecting statistics on a table that is having data loaded with the arsload command, or the System Log table is recording server activity. Try running the command again during a period of low activity, or take CMOD offline and ask your local Database Administrator to perform a reorg on the offending table.

== Links to IBM CMOD arsmaint command documentation ==

[https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v10.5]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v10.1]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v9.5]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v9.0]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_8.5.0/com.ibm.ondemand.administeringmp.doc/dodma003.htm IBM CMOD arsmaint Parameters for IBM CMOD v8.5]

== Related Articles ==

[https://cmod.cloud/ibm-cmod-cache-optimization/ Optimizing IBM Content Manager OnDemand Cache Filesystems]

[[ARS0013E|ARS0013E - DB Error]]

[https://ODUG.net/index.php?topic=2165.0 ARSMAINT discussion on the ODUG Forums]

arsstash

2024-08-20T18:09:59Z

Jderrick: /* Related Articles */

{{TOCright}}
The IBM CMOD arsstash command allows for the storage of user credentials (User ID & Password) in an encrypted format, which meets many organizations requirement for storing authentication information securely (i.e., non-plain text files like shell scripts or files protected only by Operating Systems permissions). Stash files replace the arsload.cfg configuration file used in versions of IBM Content Manager OnDemand prior to V9.0.

arsstash can be used to store credentials for the [[arsload]] utility, OnDemand Distribution Facility, LDAP, or database passwords. This allows automated scripts (like scheduled jobs) to access Content Manager OnDemand without having to store passwords in clear-text inside shell scripts or files.

== Related Articles ==
[http://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.administeringmp.doc/arsstash.htm IBM Knowledge Center - arsstash]

[https://ODUG.net/index.php?topic=1168.0 ODUG Forums - OnDemand User Group - ars.stash usage]

[https://developer.ibm.com/answers/questions/192390/what-is-the-stash-file-used-for-in-cmod.html What is the stash file used for in IBM CMOD?]

[[ars.cfg| IBM CMOD Configuration Parameters Reference]]

== Criticism ==
The cryptographic method(s) used to protect the stash file aren't clearly documented in the IBM CMOD V9.0 documentation. It's unknown if an attacker that was able to obtain a copy of the stash file (either by obtaining access through a user account, or by a side-channel such as stolen backup tapes) could decrypt the stash file and use the credentials to access the CMOD server. Most production installs simply assign IBM CMOD System Administrator privileges to an 'ARSLOAD' user, or store the admin password in the stash file -- making any potential compromise of the IBM CMOD stash file providing an attacker with total and complete control of the Content Manager OnDemand server.

== Upgrading from arsload.cfg to ars.stash ==
In IBM CMOD V9.0 and higher, using the arsload.cfg file is deprecated, and will produce warnings on the system console, and in the OnDemand System Log. Simply delete the existing arsload.cfg file, and follow the instructions for creating a new stash file.

== arsstash parameters ==
Here is the online help for arsstash:

ARS1600I Usage: arsstash [-a <action>] [-c] -s <stash_file> -u <userid>
Version: 9.5.0.6
-a <action> Action to perform
1 - Store the OnDemand userid and password (default)
2 - Delete the OnDemand userid and password
3 - Store the OnDemand userid and password for ARSLOAD
4 - Store the OnDemand userid and password for ODF
5 - Store the OnDemand userid and password for RDF
6 - Store the OnDemand userid and password for PDD
7 - Store the LDAP userid and password
8 - Store the DB2 userid and password
9 - Store the Oracle userid and password
If no userid (-u) is given for actions 3 thru 9, then
the currently assigned userid for the corresponding
OnDemand command or database will be displayed
-c Create stash file
-s <stash_file> Stash file name
-u <userid> Userid
-1 <trace_file> Trace file
-2 <trace_level> Trace level

=== arsstash -a parameter ===
The -a parameter defines the action to be taken.

; 1
: Stores an IBM CMOD User ID and password for usage with [[arsdoc]], [[arsadmin]], and other Content Manager OnDemand commands.

; 2
: Deletes a previously stored User ID and password combination from the arsstash file.

; 3
: Stores an IBM CMOD User ID and password pair for usage with the [[arsload]] command.
: It is STRONGLY RECOMMENDED that you do not use the IBM CMOD Admin password with this option. Instead, create a new user, and assign it permission to add documents to specific Application Groups.

; 4
: Stores a User ID & password for use with the IBM OnDemand Distribution Facility ("ODF").

; 5
: Stores a User ID & password for use with the IBM CMOD Report Distribution Facility.
: The functionality of RDF has been integrated into ODF starting in Content Manager OnDemand v9.0.

; 6
: Stores a User ID & password for use with PDD

; 7
: Stores a User ID & password for use with Lightweight Directory Access Protocol
: LDAP intergration with CMOD allows you to authenticate passwords from a central respository.

; 8
: On systems with remote databases or forced password authentication, store the DB2 database User ID & password.

; 9
: On systems with remote databases or forced password authentication, store the Oracle database User ID & password.

If you don't specify the -u option with an action, OnDemand will display the currently assigned User ID stored in the stash file, and update the password.

== Configuring ars.ini for ars.stash ==

After the stash file is creates and contains the required credentials, you must configure IBM CMOD to use the stash file by modifying the ars.ini configuration file to specify which stash file to use.

SRVR_OD_STASH=/opt/IBM/ondemand/V9.5/config/ars.stash

For more information about configuring stash files for multiple CMOD servers, see the [[ars.ini]] page.

=== arsstash environment variables ===

All of the parameters defined in the OnDemand [[ars.ini]] and [[ars.cfg]] files are used as 'Environment Variables'. You can replace these environment variables at any time by 'exporting' them from your UNIX/Linux shell:
export SRVR_OD_STASH=/home/odadmin/config/ars.stash

This way, you can use an alternate User ID and password for any commands issued by the CMOD Administrator account on the interactive command line. This is useful for complying with regulatory and audit requirements for specific industries.

Collecting Return Codes from CMOD utilities

2024-08-20T18:09:32Z

Jderrick: /* IBM CMOD arsdoc Return Codes */

{{TOCright}}
== Background ==

In almost all operating systems, in addition to processing data and providing output (either processed data, or a log of the work that was performed) processed provide what is called a 'Return Code' or 'Result Code' to quickly and easily indicate the status of the program at the time it stopped processing -- and Content Manager OnDemand is no different. All of the utilities provide 'return codes' or 'exit codes' when a utility stops processing. The return code is normally a single integer number, whose meaning is determined by the author of the utility, and normally available as part of the documentation. The only real standard is that 0 means a successful completion, and any other integer indicates a warning or error condition. Think of a '0' return code as "nothing to report" value.

== IBM CMOD arsdoc Return Codes ==
{| class="wikitable"
|+IBM Content Manager OnDemand's ARSDOC Return Codes
!style="text-align:center;"|Return Code
!style="text-align:center;"|Description
|-
|style="text-align:center;"|0
|Success - There was no error.
|-
|style="text-align:center;"|1
|No hits. There were no documents that met the search criteria.
|-
|style="text-align:center;"|2
|Syntax error. For example, the parameter or value is invalid.
|-
|style="text-align:center;"|3
|Generic Error. An error occurred with the specified request. For example: the user ID has an incorrect permission level, the specified folder does not exist, or the specified database field does not exist.
|-
|style="text-align:center;"|4
|Unrecoverable error. For example, the operation failed, or the user cannot connect to the server due to it being down, or being unable to authenticate.
|-
|style="text-align:center;"|768
|Warning - A limited number of results were returned. You probably used the <code> -L # </code> parameter to limit the number of returned hits from your query. See: [https://ODUG.net/index.php/topic,3346.0 ODUG Forums Post]
|}
Unfortunately, utilities like arsdb, arsload, arssockd, and arsxml don't have documented return codes in IBM's Content Manager OnDemand official documentation. However, it's safe to assume that a non-zero exit code means there was a warning or error encountered, and the results should be investigated.

== IBM CMOD arsload Return Codes ==
The Return Codes for Content Manager OnDemand's [[arsload]] utility are not well documented.

{| class="wikitable"
|+IBM Content Manager OnDemand's ARSLOAD Return Codes
!style="text-align:center;"|Return Code
!style="text-align:center;"|Description
|-
|style="text-align:center;"|0
|
;Success
:There was no error.
|-
|style="text-align:center;"|2
|
;Server is offline, unavailable, or unreachable.
:Check to see that your IBM OnDemand Server is operational, or that you can connect across the network if you are attempting to load remotely.
|-
|style="text-align:center;"|6
|
One of:

;Syntax Error
:The parameters you entered on the command line are incomplete or invalid. The [[arsload]] command parameter help was likely displayed.

;Processing error
:There was an error during processing, which lead to the failure of the [[arsload]] command, like [[ARS1127E]].
|-
|style="text-align:center;"|13
|
;Invalid User ID or Password.
:See [[ARS1105E]] for troubleshooting.
|}

== Capturing the Return Code from IBM CMOD ARSLOAD command on UNIX / Linux ==

To use the return code from a utility in a CMOD script, use the following process:

Execute the command you want to check on:

arsload -h localhost -u arsload -p /path/to/stash.file -g ApplicationGroup -a Application File.To.Load

Immediately afterwards, assign the 'return code' built-in variable to a variable you can re-use:

ARSLOAD_RC=$?

The $? special built-in variable is overwritten after each and every command that is executed in a shell, so don't insert any commands between it and the command you want the return code for!

Now that you have the return code, you can print the result...

echo "ARSLOAD returned: $ARSLOAD_RC"

... or use the 'if' command to decide to do something, like paging an administrator to alert them when a load failed.

if <nowiki>[[ $ARSLOAD_RC == 0 ]]</nowiki> ; then
echo "The load was successful!"
else
echo "There was a warning or error!"
/path/to/Page_Administrator_Script "There was an error loading a file into CMOD!"
fi

ARS0023E

2024-08-20T18:08:20Z

Jderrick: /* Articles Related to this message */

{{TOCright}}
== What was the error? ==
'''Message Number''': 23

'''Message Severity''':
Error (Corrective action is required to continue)

'''Message Name''': ARS0023E

'''Message Text''': Object >'''object'''< in Application Group >'''AppGroup'''< not found in cache, no other storage defined Srvr->'''server'''<-

== Example ==
Object >123FAAAB< in Application Group >Customer Statements< not found in cache, no other storage defined Srvr->cmod.example.com<-

== Related Errors ==
[[ARS0024E|ARS0024E - Object >object< in Application Group >AGP< not found in node]]

[[The server failed while retrieving a document]]

[[The server failed while retrieving from Storage Set]]

== What were you doing? ==
A user was likely requesting a document, and the retrieval of that document failed on the server, because the file could not be accessed in the cache filesystem.

== What happened? ==
The Application Group was defined with the 'Cache Only' Storage Set. During the retrieval, the Content Manager OnDemand object file couldn't be found in the cache filesystems. A search of TSM or Cloud Storage wasn't conducted, because it wasn't configured.

== Troubleshooting ==
There is likely an issue with your cache filesystems. If you are seeing many of these errors, it's possible that one of the cache filesystems listed in the [ars.cache] config file in not accessible, damaged, corrupted, or otherwise offline.

Check with your System Administrator to ensure that all of the CMOD cache filesystems that are configured are actually mounted. If any of the caches are missing, correct the problem and attempt the retrieval again.

If all cache filesystems are accounted for, consider running the [arsmaint|arsmaint -v] command to validate the cache filesystems. Check the System Log for any errors, and perform the necessary repairs. You may need the assistance of IBM or a [https://TenaciousConsulting.com/ CMOD Consultant] to correct the issue.

== Articles Related to this message ==
[https://ODUG.net/index.php?topic=2640.0 ODUG Webinar on CMOD Cache Filesystem Internals with Alessandro Perucchi] (Registration required, new registrations are usually approved within 24h.)

ARS1109E

2024-08-20T18:08:05Z

Jderrick: Updated link to the ARS1109E thread on the IBM Content Manager OnDemand User Group forums.

{{TOCright}}
== What was the error? ==
'''Message Number''': 1109

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS1109E

'''Message Text''': Unable to allocate enough memory. File=X, Line=Y

== Example ==
ARS1109E Unable to allocate enough memory. File=CustomerStatements.CreditCard.20190101

== What were you doing? ==
You were trying to load a file into Content Manager OnDemand using the [[arsload]] utility.

== What happened? ==
During the load process, the [[arssockd]] process wasn't able to allocate enough memory to load the file. The load fails, and the file may need to be unloaded with the [[arsadmin]] utility.

== Troubleshooting ==
On UNIX platforms, accounts on the server have limits associated with them, which can be managed by the 'ulimit' command. You can see the limits that are in effect with the <code> ulimit -a</code> command. For production CMOD servers, the user account that runs the [[arssockd]] command should have very high limits, or be set to unlimited. Your system administrator can change the limits assigned to the account by editing the /etc/security/limits.

== Articles Related to this message ==
Use your favourite search engine to learn more about the <code> ulimit </code> command.

[https://cmod.wiki/dox/ODNewsletter/ODNewsletter2014Q3.pdf ODNewsletter Q3 2014]

[https://www.ibm.com/support/pages/ibm-content-manager-ondemand-server-issues-message-ars0188e-unable-create-thread-return-code-x-and-exits Low ulimits prevent Content Manager OnDemand from starting up]

[https://ODUG.net/index.php?topic=2727.0 ODUG Forum thread on ARS1109E]

Security

2024-08-20T18:07:17Z

Jderrick: Updated link to the OnDemand User Group.

=IBM CMOD Security=

== April 2018==

April 27th, 2018 - IBM CMOD Security Bulletin - [http://www.ibm.com/support/docview.wss?uid=swg22014722 IBM CMOD Security Bulletin] [https://ODUG.net/index.php?topic=2489.0 ODUG Forum Discussion]

== April 2015==

=== Websphere ===
A security vulnerability in Websphere Application Server (WAS) was announced that affects multiple versions, and allows the remote exploitation of the management interface of WAS, up to and including remote code execution. This may affect IBM Content Manager OnDemand customers using IBM Content Navigator, which uses WAS as a requisite.

http://www-01.ibm.com/support/docview.wss?uid=swg21883573

----

=== IBM Content Navigator ===
There were two security bulletins issued April 2nd for Content Navigator ("ICN"), and ICN 2.0.3 FixPack 3 released April 1st (no joke!).

Security Bulletin: IBM Content Navigator is potentially vulnerable to cross-site scripting, caused by improper validation of user-supplied input

http://www-01.ibm.com/support/docview.wss?uid=swg21700205

Security Bulletin: IBM Content Navigator affected by dojox/form/resources/*.swf and dojox/av/resources/*.swf XSS vulnerability

http://www-01.ibm.com/support/docview.wss?uid=swg21696244

Here's the FixPack announcement:

http://www-01.ibm.com/support/knowledgecenter/SSEUEX_2.0.3/readme/icn_fixpack2.0.3.300_readme.html

----

List of Past Events

2024-08-20T18:06:36Z

Jderrick: Content Manager OnDemand User Group forums link was updated.

{{TOCright}}

Past events may still be of interest -- many events were recorded, and replays or presentation materials are often available. Items are listed in reverse-chronological order, that is, most recent events are listed first.
=== October 2021 ===
October 20th, 2021: CMOD Workshop hosted by IBM: Content Manager OnDemand Process Automation with CMOD - [https://ibm.webex.com/ibm/onstage/g.php?MTID=e707cb9d8c8bd9abeb7b432138393f94e Register]

=== September 2021 ===
September 15th, 2021: CMOD Workshop hosted by IBM: Content Manager OnDemand Useful Tips and Tricks - [https://ibm.webex.com/ibm/onstage/g.php?MTID=e707cb9d8c8bd9abeb7b432138393f94e Register]

=== August 2021 ===
August 4th, 2021: CMOD Workshop hosted by IBM: Content Manager OnDemand: The future of ePresentment - [https://ibm.webex.com/ibm/onstage/g.php?MTID=e9747be77c08c89fa3705422d8a14f17c Register]

=== June 2021 ===
June 23rd, 2021: CMOD Workshop hosted by IBM: Content Manager OnDemand Hybrid Deployment & Cloud Storage - [https://ibm.webex.com/ibm/onstage/g.php?MTID=e6836132bdaf3bff6b82f40aaed708cd0 Register]

=== May 2021 ===
May 12th, 2021: CMOD Workshop hosted by IBM: Content Manager OnDemand REST Services API - [https://ibm.webex.com/ibm/onstage/g.php?MTID=e5b39e7534d5a27b7d876e9aa80a4cd43 Register]

=== March 2021 ===
March 17th, 2021: CMOD Webinar - Content Manager OnDemand Enhancement Requests for 2021 [http://CMOD.co/enhance ODUG Enhancement Requests 2021]

=== IBM CMOD 2020 ===
The year 2020 will be an exciting year for IBM Content Manager OnDemand. CMOD v9.5 reached end of life support on April 30th 2020, and CMOD version 10.5 was announced on March 10th, 2020.

Due to the ongoing COVID-19 pandemic, CMOD Workshops for 2020 have been cancelled, and 2021 are on hold. There will be a number of CMOD Webinars hosted by the [https://ODUG.net OnDemand User Group], as well as free [https://CMOD.training/ Content Manager OnDemand Training & Education].

=== April 2020 ===
April 29th 2020 - IBM Content Manager OnDemand User Group ("ODUG") [https://ODUG.net/index.php?topic=2880.0 Webinar on CMOD v10.5 with Greg Felderman and Rob Russell] - Registration with the [https://ODUG.net ODUG Forums] is required - new registrations are approved within 24 to 48 hours. '''ODUG Webinar Recording now available!!!'''

April 30th 2020 - [https://www-01.ibm.com/support/docview.wss?uid=swg3b378125j64612j07 IBM Content Manager OnDemand v9.5 support ends.] Start your upgrade projects now! [https://cmod.cloud/upgrades/ Get help with your CMOD upgrade here!]

=== June 2020 ===

The Content Manager OnDemand 2020 Workshops will be replaced by a CMOD Webinar with the OnDemand User Group. See above: [[Main_Page#April_2020|ODUG CMOD v10.5 Webinar]]

June 2nd & 3rd - <s>IBM CMOD Workshop - Raleigh, NC</s> - Postponed due to COVID-19 outbreak.

June 9th - <s>IBM CMOD Workshop in Zurich, Switzerland</s> - Postponed due to COVID-19 outbreak.

June 11th - <s>IBM CMOD Workshop in Ljubljana, Slovenia</s> Postponed due to COVID-19 outbreak.

=== April 2022 ===
April 30th, 2022 - [https://www-01.ibm.com/common/ssi/ShowDoc.wss?docURL=/common/ssi/rep_ca/9/897/ENUS920-049/index.html&request_locale=en IBM DB2 v11.1 End of Support (EoS)]. Mark your calendars and plan your budgets!

=== March 2020 ===
March 13th 2020 - CMOD v10.5 will be available for download by licensed customers with support agreements through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer Passport Advantage Online]

March 3rd & 4th - IBM CMOD Workshop - Palisades, NY - [https://www-01.ibm.com/events/wwe/grp/grp311.nsf/Registration.xsp?openform&seminar=BC8N85OE&locale=en_US Register]

=== February 2020 ===
February 25th & 26th - IBM CMOD Workshop - Chicago, IL - [https://www-01.ibm.com/events/wwe/grp/grp311.nsf/Registration.xsp?openform&seminar=56BUVNOE&locale=en_US Register]

=== IBM CMOD 2020 ===
Content Manager OnDemand will see a few major events in 2020. CMOD v9.5 support will be withdrawn as of April 30th, 2020, and CMOD v10.5 is expected to be announced in the first quarter. The [https://ODUG.net OnDemand User Group] is anticipating to host a number of webinars throughout the year.

=== December 2019 ===
December 31st - The quarterly IBM ODNewsletter focusing on Content Manager OnDemand was released - [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf ODNewsletter 2019 Q4]

=== October 2019 ===
October 23-24th 2019 - IBM CMOD Workshop - Bethesda, Maryland, USA [https://www-01.ibm.com/events/wwe/grp/grp311.nsf/Registration.xsp?openform&seminar=96QUDROE&locale=en_US Register]

=== September 2019 ===
September 17-18th 2019 - IBM CMOD Workshop - Austin, Texas, USA [https://www-01.ibm.com/events/wwe/grp/grp311.nsf/Registration.xsp?openform&seminar=523KTKOE&locale=en_US Register]

=== June 2019 ===
June 4-5th 2019 - IBM CMOD Workshop - Vancouver, Canada [https://ibmhybridcloud.lookbookhq.com/cmod-workshops/upcoming-workshops Register]

=== April 2019 ===
April 15th 2019 - IBM CMOD SSO for IBM Content Navigator - the whitepaper was updated with important corrections: [https://www-01.ibm.com/support/docview.wss?uid=ibm10713479 IBM CMOD SSO for ICN]

April 16th 2019 - IBM CMOD Workshop - Cape Town, South Africa [https://ibmhybridcloud.lookbookhq.com/cmod-workshops/upcoming-workshops Register]

April 18th 2019 - IBM CMOD Workshop - Johannesburg, South Africa [https://ibmhybridcloud.lookbookhq.com/cmod-workshops/upcoming-workshops Register]

=== October 2018 ===

Oct 16-17 - Phoenix, AZ   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

=== July 2018 ===

July 6th - IBM's Content Manager OnDemand Newsletter - ODNews released -- [https://www-01.ibm.com/support/docview.wss?uid=ibm10716617 ODNews Q2 2018]

=== June 2018 ===

June 18th - London, England   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

June 21st & 22nd - Copenhagen, Denmark   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

June 26th & 27th - Paris, France   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

=== May 2018 ===
May 1st & 2nd - Chicago, IL - 71 South Wacker Road -   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

May 8th & 9th - Littleton, MA - 550 King Street -   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

May 30th & 31st - Tampa, FL - 3031 Rockypoint Drive -   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

=== April 2018 ===
April 3rd & 4th - Paris, France   -- [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html#dates Registration]

=== February 2018 ===
February 21st - ODUG's IBM Content Manager OnDemand Webinar - IBM CMOD & XML - with Bud Paton -- [https://ODUG.net/index.php?topic=2421.0 IBM OnDemand User Group Forums] REPLAY NOW AVAILABLE! Registration required.

=== November 2017 ===
November 15th, 2017 - RESCHEDULED - ODUG's IBM Content Manager OnDemand Webinar on IBM Content Navigator & CMOD See the [https://ODUG.net/index.php?topic=2297.0 ODUG Forum Post] for more information and to provide feedback. You will need to log in or register a new account to view the post.

=== September 2017 ===
September 13th & 14th - IBM Content 2017 IBM CMOD Workshop in Stockholm, Sweden [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/content2017.html#agenda Agenda] [https://www.ibm.com/events/wwe/grp/grp308.nsf/Registration.xsp?openform&seminar=3Z3UAUES&locale=en_ZZ Register]

September 30th - IBM Content Manager OnDemand ("CMOD") v9.0 [http://www-01.ibm.com/common/ssi/cgi-bin/ssialias?subtype=ca&infotype=an&appname=iSource&supplier=897&letternum=ENUS916-117 End of Support]

=== June 2017 ===
June 14th & 15th - IBM Content 2017 IBM CMOD Workshop in Chicago, IL [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/content2017.html#agenda Agenda] [https://www.ibm.com/events/wwe/grp/grp304.nsf/Registration.xsp?openform&seminar=CD4UMBES&locale=en_US Register]

June 20th & 21st - IBM Content 2017 IBM CMOD Workshop in London, UK [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/content2017.html#agenda Agenda] [https://www.ibm.com/events/wwe/grp/grp312.nsf/Registration.xsp?openform&seminar=ZZ5QV5OE&locale=en_ZZ Register]

June 27th & 28th - IBM Content 2017 IBM CMOD Workshop in Ehningen, Germany [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/content2017.html#agenda Agenda] [https://www.ibm.com/events/wwe/grp/grp312.nsf/Registration.xsp?openform&seminar=2EDRBBOE&locale=en_ZZ Register]

=== May 2017 ===
May 17th & 18th - IBM Content 2017 IBM CMOD Workshop in Minneapolis, MN [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/content2017.html#agenda Agenda] [https://www.ibm.com/events/wwe/grp/grp304.nsf/Registration.xsp?openform&seminar=A8ESECES&locale=en_US Register]

May 24th & 25th - IBM Content 2017 IBM CMOD Workshop in New York, NY [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/content2017.html#agenda Agenda] [https://www.ibm.com/events/wwe/grp/grp304.nsf/Registration.xsp?openform&seminar=AEQKXYES&locale=en_US Register]

=== April 2017 ===
April 19th, 2017 - ODUG's IBM Content Manager OnDemand Webinar - [https://ODUG.net/index.php?topic=2223.0 IBM CMOD v10.1 Introduction Replay] (Login Required - new registrations approved within 72 hours)

=== November 2016 ===
November 8th & 9th - IBM Workshop - Content Manager OnDemand Workshop in Palisades [https://www.ibm.com/events/swgeer/swgeer06.nsf/signin?openform&seminar=kwogaria7gurg&lang=en&locale=en_US Register here]

November 15th & 16th - IBM Workshop - Content Manager OnDemand Workshop in Toronto, Ontario, Canada [https://www.ibm.com/events/swgeer/swgeer06.nsf/signin?openform&seminar=kwogaria7gv6w&lang=en&locale=en_US Register Here]

=== September 2016 ===
September 14th & 15 - Content Manager OnDemand workshop hosted by IBM Business Partner 10m - [https://10m.de/odworkshop.html Register here]

=== July 2016 ===
July 13th & 14th - IBM Workshop - Content Manager OnDemand Workshop in Johannesburg, South Africa [https://www.ibm.com/events/swgeer/swgeer06.nsf/signin?openform&seminar=kwogaria7qk2y&lang=en&locale=en_US Register here]

=== June 2016 ===
June 8th - IBM's ODNews newsletter for Q2 2016 was released. [http://www-01.ibm.com/support/docview.wss?uid=swg27048276&aid=1 Download ODNews 2016 Q2]

June 9th & 10th - IBM Workshop - Content Manager OnDemand Workshop in Prague, Czech Republic [https://www.ibm.com/events/swgeer/swgeer06.nsf/signin?openform&seminar=kwogaria7pnb8&lang=en&locale=en_US Register here]

=== May 2016 ===
May 11th, 2016 - IBM Content 2016 - Content Manager OnDemand Workshop in Chicago, Illinois [https://www-950.ibm.com/events/wwe/grp/grp009.nsf/v17_enrollall?openform&seminar=3ZAQETES&locale=en_US&S_TACT=CMODwiki Register here]

=== April 2016 ===
April 21st, 2016 - IBM Content 2016 - Content Manager OnDemand Workshop in Austin, Texas [https://www-950.ibm.com/events/wwe/grp/grp009.nsf/v17_enrollall?openform&seminar=EEDPV8ES&locale=en_US&S_TACT=CMODwiki Register here]

April 30th, 2016 - Content Manager OnDemand v8.5 will transition to End of Support status for [http://www-01.ibm.com/common/ssi/rep_ca/2/897/ENUS914-242/ Multiplatforms] and [http://www-01.ibm.com/common/ssi/rep_ca/1/897/ENUS914-241/ z/OS] on April 30th, 2016. Upgrade now!

=== March 2016 ===
2016 Q1 ODNews - [http://www.ibm.com/support/docview.wss?uid=swg27047790 Content Manager OnDemand Newsletter Released]

March 23rd, 2016 - IBM Content 2016 - Content Manager OnDemand Workshop in Long Beach, California [https://www-950.ibm.com/events/wwe/grp/grp009.nsf/v17_agenda?openform&seminar=AA5QQHES&locale=en_US&S_TACT=CMODwiki Register here]

=== January 2016 ===
Development and support of Content Manager OnDemand has been [http://ibmecmblog.com/2016/01/18/exciting-changes-for-content-manager-ondemand/ outsourced to UNICOM].

=== November 2015 ===
A free seminar on Content Manager OnDemand will be held in Montréal, Québec, Canada on November 4th, 2015. All CMOD Users in Québec are invited, but seating is limited. The seminar will be conducted primarily in English. Send an eMail to [mailto:MTL2015@odug.ca MTL2015@odug.ca] for additional info or to reserve your spot.

=== October 2015 ===
IBM is hosting a seminar entitled SWIFT Component Alternatives & ISO20022 Message Archiving & Analysis on Wednesday October 21st at 10 Eastern Time. [https://event.on24.com/eventRegistration/EventLobbyServlet?target=registration.jsp&eventid=1051685&sessionid=1&key=521D5F320F4DD992AE9B247F78ACE55D&partnerref=CL102115-IBM-03&sourcepage=register Register Here]

Content Manager OnDemand User Group ("ODUG") Technical Conference will be held on Thursday, October 29th, 2015, in conjunction with [http://www-01.ibm.com/software/events/insight/ IBM Insight 2015] in Las Vegas, NV. As of August 3rd, 2015, the [http://www.odusergroup.org/forums/index.php?topic=1721.0 Call for Speakers] is now open and a draft agenda has been announced.

=== September 2015 ===
Content Manager OnDemand User Group ("ODUG") [https://ODUG.net/index.php?topic=1724.0 Webinar: PDF Indexing with CMOD 9.5 with Bud Paton] on September 16th, 2015 at 2pm Eastern Time. ''Registration is required to access the ODUG Forums -- new registrations are approved within 24 hours.'' UPDATE: A recording of the webinar has been posted, along with a copy of the presentation materials.

Content Manager [http://www-01.ibm.com/common/ssi/rep_ca/5/897/ENUS914-255/ OnDemand for iSeries v6.1] will transition to 'End of Support' status on September 30th, 2015.

Tivoli Storage Manager (an optional component of CMOD) will be renamed to "Spectrum Archive" starting with version 7.1.3.

Ten Reasons to use IBM Content Manager OnDemand

2024-08-20T18:03:44Z

Jderrick: Updated link to CMOD User Group.

{{TOCright}}
Some of IBM's competitors think it's a good idea to spread a lot of Fear, Uncertainty, and Doubt ("FUD") around the future of IBM CMOD. Here's ten answers to their suggestions that you need to replace CMOD with their solution:

# IBM has been recognized as a leader in the ECM space by Gartner for as long as they've been producing their Magic Quadrants for Enterprise Content Management. The competitors that have resorted to disparaging CMOD aren't even on the list!
# OnDemand's compression is best-in-class. By offering built-in system-wide de-duplication & advanced compression algorithms, IBM CMOD has saved customers billions of dollars in reduced storage costs over its 20+ year lifetime.
# IBM's CMOD Cloud offerings allow organizations to leverage skilled IBM technicians and [https://www.forbes.com/sites/bobevans1/2018/01/19/ibm-joins-microsoft-amazon-atop-cloud-world-booming-cloud-business-ends-long-revenue-decline/ IBM's expansive cloud infrastructure] to serve more users, at a lower price point than on-premise solutions.
# The [https://ODUG.net Content Manager OnDemand User's Group ("ODUG")] is a vibrant user community with a history going back to the mid-90's -- almost as long as CMOD's been a product!
# [[Main_Page#CMOD_Webinars_.26_Workshops|ODUG's IBM Content Manager OnDemand Webinars]] & annual ODUG Technical Conference feature OnDemand's senior development and architecture teams to gather feedback and take questions from the Content Manager OnDemand customers.
# IBM has been offering free [https://www.ibm.com/analytics/us/en/technology/enterprise-content-management/on-demand.html CMOD Workshops] for the past 6 years, and has announced another round of [[Main_Page#Content_Manager_OnDemand_News_.26_Events|workshops in cities around the world]] for CMOD customers in 2020. Did I mention they're free? Because they're FREE!
# Despite [https://www.ibm.com/blogs/ecm/2016/01/18/exciting-changes-for-content-manager-ondemand/ outsourcing development of CMOD to UNICOM] in January 2016, the development team has been expanded, and new features are regularly added to CMOD -- data encryption, active-active redundancy, plus support for storing data in Amazon S3, Hadoop HDFS, Openstack Swift Object Store, Azure Cloud, and [https://www.theregister.co.uk/2018/02/02/gartner_object_storage_report/?linkId=47896773 IBM Cloud Object Storage], LDAP Group syncing, document hashing for data security & reconciliation, support for external encryption key management, and [https://cmod.wiki/dox/RESTapiDoc/CMOD_10_5_REST_API_Documentation.html ODWEK REST API] support in the release of CMOD 10.5 in 2020 for [https://www-01.ibm.com/common/ssi/ShowDoc.wss?docURL=/common/ssi/rep_ca/0/897/ENUS220-060/index.html&lang=en&request_locale=en Multiplatforms] and [http://www-01.ibm.com/common/ssi/ShowDoc.wss?docURL=/common/ssi/rep_ca/9/897/ENUS220-059/index.html&lang=en&request_locale=en z/OS] and more.
# Speaking of enhancements... IBM has been excellent at delivering on [https://www.youtube.com/watch?v=jvOa7_BfPzc&t=377s new features, functionality, and usability improvements] to Content Manager OnDemand in [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|FixPacks]] through co-operation with ODUG, and it's regular enhancement requests.
# And back to the topic of developers... some of CMOD's competition has lost their core developers -- who are now working on building solutions to migrate customers onto '''other''' ECM products. Ouch!
# There's also a vibrant community of IBM Business Partners and consultants providing sales & services, plus developing 'bolt-on' products that enhance Content Manager OnDemand even further, adding data mining, workflow, and integration features.

And an extra one for good measure...

Since 2014, IBM has completed over *36* migrations to CMOD ''away'' from the competitor solutions. If the competition actually had a better product -- wouldn't they be hosting webinars singing about their virtues? No wonder they're resorting to Fear, Uncertainty, and Doubt in order to try and scare up new business!

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-08-20T14:34:33Z

Jderrick: /* Background */

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that quantum computing enables. These changes are being made out of an abundance of caution, as there are no current encryption methods at risk of being cracked by state-of-the-art quantum computers.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.28 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit version AFTER 8.0.55.28, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USE_CLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.
: If you run a server trace on arssockd, you will find a return code 407 from GSKit also known as <code>GSK_ERROR_BAD_KEYFILE_LABEL</code>.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue is not resolved by the latest [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]] (v10.5.0.8) but the documentation has been updated:
[https://www.ibm.com/docs/en/cmofm/10.5.0?topic=clients-setting-up-ssl-windows Setting up SSL with Windows Clients]

In order to generate the key database WITHOUT Post-Quantum Cryptographic methods, add <code>-pqc false</code> to the GSKit <code> -keydb -create</code> command:

gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

If you created a key database with the upgraded GSKit version, the key database for the client will need to be replaced with a 'non-pqc' key database as well.
Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

Main Page

2024-08-20T14:31:00Z

Jderrick: /* The OnDemand User Group */

{{TOCright}}

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
April 24th, 2024 - IBM Content Manager OnDemand v10.5 Fix Pack 8 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.7&platform=All&function=all IBM CMOD v10.5.0.8] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://ODUG.net/

The OnDemand User Group changed domains in the summer of 2024 due to a lack of interest by the existing administrator. The interim administrators are Jeff Squier and Justin Derrick.

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[http://www-947.ibm.com/support/entry/portal/product/enterprise_content_management/content_manager_ondemand_for_multiplatforms?productContext=-816420431 IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

ODNews 2024: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2024Q1.pdf 1st Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

Apache Log4j & CMOD ODWEK ICN

2024-06-17T14:33:18Z

Jderrick: Removed Q&A section.

{{TOCright}}
This article discusses IBM Content Manager OnDemand (CMOD), the OnDemand Web Enablement Kit (ODWEK), IBM Content Navigator (ICN) and the Apache Log4j library, for which a Remote Code Execution (RCE) vulnerability is actively being exploited, which can give attackers elevated access, or effective control of the affected servers.

This issue has been assigned the following designation: CVE-2021-44228 and scores a 10 out of 10 on the Common Vulnerability Scoring System (CVSS)

There are now official TechNotes from IBM on the CMOD / Log4j issue:

[https://www.ibm.com/support/pages/node/6525888 Is IBM Content Manager OnDemand (CMOD) Version 10.5 impacted by the log4j security vulnerabilities related to CVE-2021-44228?]

[https://www.ibm.com/support/pages/node/6525892 Is IBM Content Manager OnDemand (CMOD) Version 10.1 impacted by the log4j security vulnerabilities related to CVE-2021-44228?]

If your CMOD / ODWEK / ICN solution includes WebSphere, please review the following TechNote: [https://www.ibm.com/support/pages/security-bulletin-multiple-vulnerabilities-apache-log4j-affect-ibm-websphere-application-server-and-ibm-websphere-application-server-liberty-cve-2021-4104-cve-2021-45046 Multiple vulnerabilities in Apache log4j affect the IBM WebSphere Application Server]

UPDATE: CMOD 10.5 FixPack 4 updates Log4j in all components. See [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|Content Manager OnDemand FixPacks and Security Bulletins]] for links to IBM Fix Central

== Announcements ==
Here are some announcements from trusted sources of information on software vulnerabilities:

[https://exchange.xforce.ibmcloud.com/collection/Apache-Log4j-Zero-Day-Vulnerability-4daa3df4f73a51590efced7fb90bc949 IBM's X-Force assessment of log4j bug]

[https://logging.apache.org/log4j/2.x/security.html Announcement of the issue on the developer website]

[https://nvd.nist.gov/vuln/detail/CVE-2021-44228 National Institute of Standards and Technology]

[https://github.com/apache/logging-log4j2/pull/608#issuecomment-990494126 Discussion of log4j v1.x susceptibility to this exploit on GitHub]

== Affected Versions of Log4j ==

Versions from v2.0 beta9 through 2.14.x are vulnerable to this exploit.

Your systems should be patched to log4j 2.16 or higher - a second vulnerability was discovered, and the latest versions disables the features by default.

== Versions Shipped with CMOD ==

'''''NOTE:''''' CMOD Fixpacks with the Log4j patch have been released: [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpacks for Log4j]]

{| class="mw-collapsible wikitable" style="text-align: center;
!CMOD Version||Apache Log4j version(s)||Vulnerable version? ||Comment
|-
|CMOD & ODWEK v9.0|| N/A || N/A
|style="text-align: left;|Log4j isn't used in CMOD v9.
|-
|CMOD & ODWEK v9.5|| N/A || N/A
|style="text-align: left;|Log4j isn't used in CMOD v9.
|-
|CMOD & ODWEK v10.1|| v2.6.x || YES
|style="text-align: left;|Log4j is only included with CMOD v10.1 FP6 and higher.
|-
|CMOD & ODWEK v10.5|| v2.13.x|| YES
|style="text-align: left;|Log4j is included in the base level and all Fixpacks of CMOD v10.5.
|-
|ICN v2.0.3 || TBD || TBD
|-
|ICN v3|| v1.2.x || NO
|style="text-align: left;|ICN v3 is not vulnerable in the default configuration, but sites that have enabled the JMSAppender feature could be exploited.
|}

== Impact ==
The largest impact is to systems that have publicly-facing IBM Content Navigator (ICN) installations where the ODWEK Java API is also publicly accessible, or line-of-business (LoB) apps (like client/customer portals) that rely on Log4j to provide logging. In most (reasonable) system architectures, ODWEK itself is not exposed to the public internet, and instead, is used as an intermediate API between LoB applications that are internet-accessible and Content Manager OnDemand. In the overwhelming majority of system designs, there are firewalls and other access controls on both the external and internal sides of a web server. However, if an attacker was able to obtain an elevated level of access to a web server, they may be able to use that elevated access to attempt to exploit ODWEK.

; Which CMOD components use Apache log4j?
: The three components that use the log4j library are the ODWEK Java API, the REST API (new in CMOD v10.5) and the Full Text Search engine. The CMOD server itself doesn't use log4j, so none of the standard operations a CMOD server performs are vulnerable to this exploit, this includes, loading data with arsload, indexing documents with ACIF or the PDF Indexer, migrating data between cache & secondary storage, etc.

; How does ODWEK Java API / REST API / FTS use the log4j library?
: They are referenced through a classloader.

; Is a standalone CMOD server (without IBM HTTP / Websphere / ODWEK / REST API / FTS configured) vulnerable?
: No, CMOD itself does not call or use log4j.

; Where do I need to install the new version of the Apache log4j library?
: Anywhere that you have installed CMOD - this includes: all CMOD servers, WebSphere/Tomcat/HTTP servers with CMOD, ODWEK, or the REST API components, and development servers for line-of-business applications that use ODWEK/REST APIs.

''Given that ODWEK is a niche API for a proprietary product, the risk to the data in a CMOD server is low.''

Here are a list of scenarios, and the likely level of risk to this vulnerability: (Last updated Dec 13th, 10am)

* An organization with CMOD on their internal network using Windows 'Thick' Clients: ''Very Low''
* CMOD and IBM Content Navigator or Line-of-Business apps that reply on ODWEK: ''Low''
* Line-of-Business apps using CMOD that are exposed to the public internet with proper firewalls & access controls: ''Low ''
* Line-of-Business apps using CMOD that are exposed to the public internet with unrestricted access to the CMOD server: ''Low''
* CMOD and ODWEK running on the same server instance / operating system & accessible to the internet: ''Medium''

== Upgrading log4j v2.16.x ==
You can download the latest version of Apache log4j here: https://logging.apache.org/log4j/2.x/download.html

Please refer to IBM's Technotes for [https://www.ibm.com/support/pages/node/6525892 v10.1] and [https://www.ibm.com/support/pages/node/6525888 v10.5] for instructions on upgrading log4j on your CMOD and ODWEK installations.

ARS4014E

2024-06-14T00:30:42Z

Jderrick: Fixed incomplete sentence.

{{TOCright}}
== What was the error? ==
'''Message Number''': 4014

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS4014E

'''Message Text''': Unable to load >''database engine''<

== Related Errors ==
None.

== What were you doing? ==
After completing an IBM Content Manager OnDemand upgrade, or building a new CMOD instance, you were probably running [[arsdb]] or [[arssockd]].

== What happened? ==
CMOD couldn't establish a connection to DB2, likely because your configuration parameters are incorrect.

; Are you on AIX?
: If you just completed an [https://CMOD.cloud/upgrade IBM CMOD Upgrade] on AIX, OnDemand v9.5 (and higher) requires version 13.1 or higher of the IBM XLC Compiler Runtime.

== Example ==

$ arsdb -uv
arsdb: ARS4014E - Unable to load >DB2<
Illegal Instruction(coredump)
$

== Troubleshooting ==

;All Platforms
: Ensure your CMOD configuration files are correct.
: Check the SRVR_INSTANCE and SRVR_INSTANCE_OWNER parameters in the IBM OnDemand [[ars.ini]] config file.
: Check the DB2_INSTANCE parameter in the IBM OnDemand [[ars.cfg]] configuration file.

Under AIX, check the version of the IBM XL C/C++ Compiler Runtime:

$ lslpp -l |grep -i "IBM XL"

xlC.aix61.rte 12.1.0.1 COMMITTED IBM XL C++ Runtime for AIX 6.1
xlC.msg.en_US.rte 12.1.0.1 COMMITTED IBM XL C++ Runtime
xlC.rte 12.1.0.1 COMMITTED IBM XL C++ Runtime for AIX

If the version number reported is LESS THAN 13.1, you'll need to download the latest version from IBM Fix Central: [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=ibm%7ERational&product=ibm/Rational/XL+C,C%2B%2B+Compiler&release=13.1.0.11&platform=AIX&function=all&source=fc IBM XLC 13.1.0.11 (November 2018)]

From this package, you only need to install three components:

xlC.aix61.rte 13.1.x.x # IBM XL C++ Runtime for AIX 6...
xlC.msg.en_US.rte 13.1.x.x # IBM XL C++ Runtime Messages-...
xlC.rte 13.1.x.x # IBM XL C++ Runtime for AIX

== Articles related to this message ==

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.messages.doc/dodm4014.htm CMOD v9.5 Knowledgebase - Messages & Codes - ARS4014E]

[https://www-01.ibm.com/support/docview.wss?uid=swg21698334 ARS4014E unable to load >DB2< error is shown when running arsdb -I -gcv after Content Manager OnDemand 9.5 upgrade.]

[http://www-01.ibm.com/support/docview.wss?uid=ibm10792615 XL C/C++ for AIX Fix Pack 11 (November 2018 PTF) for 13.1]

ARS4014E

2024-06-13T23:08:48Z

Jderrick: Added diagnostic and troubleshooting information for Content Manager OnDemand Multiplatforms.

{{TOCright}}
== What was the error? ==
'''Message Number''': 4014

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS4014E

'''Message Text''': Unable to load >''database engine''<

== Related Errors ==
None.

== What were you doing? ==
After completing an IBM Content Manager OnDemand upgrade, or building a new CMOD instance, you were probably running [[arsdb]] or [[arssockd]].

== What happened? ==
CMOD couldn't establish a connection to DB2, likely because your configuration parameters are incorrect.

; Are you on AIX?
: If you just completed an [https://CMOD.cloud/upgrade IBM CMOD Upgrade] on AIX, OnDemand v9.5 (and higher) requires version 13.1 or higher.
: The Content Manager OnDemand utility couldn't run, because the version of the IBM XLC Compiler Runtime is out of date.

== Example ==

$ arsdb -uv
arsdb: ARS4014E - Unable to load >DB2<
Illegal Instruction(coredump)
$

== Troubleshooting ==

;All Platforms
: Ensure your CMOD configuration files are correct.
: Check the SRVR_INSTANCE and SRVR_INSTANCE_OWNER parameters in the IBM OnDemand [[ars.ini]] config file.
: Check the DB2_INSTANCE parameter in the IBM OnDemand [[ars.cfg]] configuration file.

Under AIX, check the version of the IBM XL C/C++ Compiler Runtime:

$ lslpp -l |grep -i "IBM XL"

xlC.aix61.rte 12.1.0.1 COMMITTED IBM XL C++ Runtime for AIX 6.1
xlC.msg.en_US.rte 12.1.0.1 COMMITTED IBM XL C++ Runtime
xlC.rte 12.1.0.1 COMMITTED IBM XL C++ Runtime for AIX

If the version number reported is LESS THAN 13.1, you'll need to download the latest version from IBM Fix Central: [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=ibm%7ERational&product=ibm/Rational/XL+C,C%2B%2B+Compiler&release=13.1.0.11&platform=AIX&function=all&source=fc IBM XLC 13.1.0.11 (November 2018)]

From this package, you only need to install three components:

xlC.aix61.rte 13.1.x.x # IBM XL C++ Runtime for AIX 6...
xlC.msg.en_US.rte 13.1.x.x # IBM XL C++ Runtime Messages-...
xlC.rte 13.1.x.x # IBM XL C++ Runtime for AIX

== Articles related to this message ==

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.messages.doc/dodm4014.htm CMOD v9.5 Knowledgebase - Messages & Codes - ARS4014E]

[https://www-01.ibm.com/support/docview.wss?uid=swg21698334 ARS4014E unable to load >DB2< error is shown when running arsdb -I -gcv after Content Manager OnDemand 9.5 upgrade.]

[http://www-01.ibm.com/support/docview.wss?uid=ibm10792615 XL C/C++ for AIX Fix Pack 11 (November 2018 PTF) for 13.1]

Main Page

2024-05-13T22:29:52Z

Jderrick: /* IBM ODNews / OnDemand Newsletter */ 2024Q1

{{TOCright}}

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
April 24th, 2024 - IBM Content Manager OnDemand v10.5 Fix Pack 8 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.7&platform=All&function=all IBM CMOD v10.5.0.8] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://www.odusergroup.org/forums

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[http://www-947.ibm.com/support/entry/portal/product/enterprise_content_management/content_manager_ondemand_for_multiplatforms?productContext=-816420431 IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

ODNews 2024: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2024Q1.pdf 1st Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

ars.ini

2024-05-13T19:58:25Z

Jderrick: Updated version number to CMOD v10.5.

{{TOCright}}
The ars.ini configuration file defines one or more IBM Content Manager OnDemand ("IBM CMOD") instances on a server. While most systems only contain a single IBM CMOD server, it is possible to combine multiple OnDemand instances onto a single server -- usually for combining development and test instances.

== Default ars.ini configuration parameters ==
[@SRV@_ARCHIVE]
HOST=cmod.example.com
PROTOCOL=2
PORT=0
SRVR_INSTANCE=archive
SRVR_INSTANCE_OWNER=archive
SRVR_OD_CFG=/opt/ibm/ondemand/V10.5/config/ars.cfg
SRVR_DB_CFG=/opt/ibm/ondemand/V10.5/config/ars.dbfs
SRVR_SM_CFG=/opt/ibm/ondemand/V10.5/config/ars.cache

; [@SRV@_ARCHIVE]
: This is the header that defines a server. Any of the parameters below refer to this server - ARCHIVE.

; HOST=cmod.example.com
: The fully qualified domain name of the server.

; PROTOCOL=2
: The protocol to use between the server and client. Leave the default value for the version of CMOD you've installed. Communications between Content Manager OnDemand Clients and Servers works over TCP/IP.

; PORT=0
: The TCP/IP port number to use for CMOD. 0 uses the default, 1445.
: Each server must have it's own port number, servers cannot share a port.
: This port number must be entered in the client software when defining a server.

; SRVR_INSTANCE=archive
: Name of the instance.

; SRVR_INSTANCE_OWNER=archive
: The operating system User ID that owns / controls this instance. This parameter may be case sensitive depending on your Operating System.

; SRVR_OD_CFG=/opt/ibm/ondemand/V10.5/config/ars.cfg
: Defines the location of your configuration file for the server.

; SRVR_DB_CFG=/opt/ibm/ondemand/V10.5/config/ars.dbfs
: Defines the location of your configuration file for the database manager.

; SRVR_SM_CFG=/opt/ibm/ondemand/V10.5/config/ars.cache
: Defines the locatio nof your configuration file for defining cache filesystems.

== arsstash related ars.ini configuration parameters ==

SRVR_OD_STASH=/opt/IBM/ondemand/V10.5/config/ars.stash

; SRVR_OD_STASH=/opt/IBM/ondemand/V10.5/config/ars.stash
: This parameter defines the location of the default stash file to use for database connections, arsload, and LDAP authentication.

== SSL / TLS related ars.ini configuration parameters ==

SSL_PORT=1446
SSL_KEYRING_FILE=/opt/IBM/ondemand/V10.5/config/ondemand.kdb
SSL_KEYRING_STASH=/opt/IBM/ondemand/V10.5/config/ondemand.sth
SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
SSL_CLNT_USE_SSL=1

; SSL_PORT=1446
: Defines the port number for encrypted connections to CMOD.
: There is no default port number, common choices are 1443 and 1446, but may be any number between 1024 and 65535 not already in use on your server by other services like TSM (1500, 1501) or DB2 (50000-50006, 60000-60006).

; SSL_KEYRING_FILE=/opt/IBM/ondemand/V10.5/config/ondemand.kdb
: Defines the location of the key database that contains all the requisite certificates and keys.

; SSL_KEYRING_STASH=/opt/IBM/ondemand/V10.5/config/ondemand.sth
: Defines the location of the stash file that contains passwords to the keys and certificates in the key database.
: This file should have very restrictive permissions.

; SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
: Defines the label of the SSL Certificate to be used to identify the IBM CMOD server.

; SSL_CLNT_USE_SSL=1
: Determines if utility clients like arsload should use SSL to connect to IBM CMOD.
: This is not necessary if you're not performing remote loads (via arsload), or queries or retrievals (via arsdoc).

== Unlisted CMOD Configuration Parameters ==
;SRVR_FLAGS_SECURITY_EXIT
: This is the flag to enable the Content Manager OnDemand User Security Exit. The IBM CMOD Security Exit, <code> arsusec</code> is used to extend and customize user authentication in CM OnDemand. When set to 1, CMOD will call the user exit when a user connects to CMOD and attempts to authenticate. <code> arsusec</code> is normally used for providing alternate authentication methods to OnDemand, like Single Sign On ("SSO") and in previous versions, Lightweight Directory Access Protocol ("LDAP").
: When enabled, the compiled <code> arsusec</code> binary must be located in the 'exits' directory under the 'bin' directory in your IBM CMOD installation directory, for example, <code> /opt/IBM/ondemand/V9.5/bin/exits</code>. If the parameter is enabled, and the <code> arsusec</code> compiled binary is missing from the 'exits' directory, the server may be unable to start, and cause <code> arssockd </code> to report a [[Unable_to_determine_the_database_engine|ARS4013E - Unable to determine the database engine]] error.

;ARSSOCK_TLSV12_ONLY
: When set to '1', this parameter disables all prior levels of TLS - improving security by disabling older, less secure cryptographic methods.
: When setting SSL/TLS parameters for CMOD, you can also add environment variables to modify the behavior of IBM Global Security Kit like <code>GSK_PROTOCOL_TLSV1_2=1</code>.

;ARSSOCK_STRICT_SHA2_ONLY_CERTS
: When set to '1', this flag instructs Content Manager OnDemand to only allow certificates that use the SHA2 hashing method in CMOD server certificates. This increases security, as certificates signed with SHA1 are considered vulnerable to 'collision' attacks, and as a result, are not secure.

;ARSSOCK_FIPS
:The default is for CMOD to start up with FIPS compliance enabled.
:If you are trying to upgrade to TLS v1.3, you need to disable FIPS support with <code>ARSSOCK_FIPS=0</code>.

== Related Articles ==

[https://www.ibm.com/docs/en/cmofm/10.5.0?topic=services-configuring-arsldapini-file LDAP Configuration File]

ars.ini

2024-05-13T19:57:45Z

Jderrick: Updated version numbers, added ARSSOCK_FIPS option and updated link to CMOD LDAP Configuration file.

{{TOCright}}
The ars.ini configuration file defines one or more IBM Content Manager OnDemand ("IBM CMOD") instances on a server. While most systems only contain a single IBM CMOD server, it is possible to combine multiple OnDemand instances onto a single server -- usually for combining development and test instances.

== Default ars.ini configuration parameters ==
[@SRV@_ARCHIVE]
HOST=cmod.example.com
PROTOCOL=2
PORT=0
SRVR_INSTANCE=archive
SRVR_INSTANCE_OWNER=archive
SRVR_OD_CFG=/opt/ibm/ondemand/V10.5/config/ars.cfg
SRVR_DB_CFG=/opt/ibm/ondemand/V10.5/config/ars.dbfs
SRVR_SM_CFG=/opt/ibm/ondemand/V10.5/config/ars.cache

; [@SRV@_ARCHIVE]
: This is the header that defines a server. Any of the parameters below refer to this server - ARCHIVE.

; HOST=cmod.example.com
: The fully qualified domain name of the server.

; PROTOCOL=2
: The protocol to use between the server and client. Leave the default value for the version of CMOD you've installed. Communications between Content Manager OnDemand Clients and Servers works over TCP/IP.

; PORT=0
: The TCP/IP port number to use for CMOD. 0 uses the default, 1445.
: Each server must have it's own port number, servers cannot share a port.
: This port number must be entered in the client software when defining a server.

; SRVR_INSTANCE=archive
: Name of the instance.

; SRVR_INSTANCE_OWNER=archive
: The operating system User ID that owns / controls this instance. This parameter may be case sensitive depending on your Operating System.

; SRVR_OD_CFG=/opt/ibm/ondemand/V10.5/config/ars.cfg
: Defines the location of your configuration file for the server.

; SRVR_DB_CFG=/opt/ibm/ondemand/V10.5/config/ars.dbfs
: Defines the location of your configuration file for the database manager.

; SRVR_SM_CFG=/opt/ibm/ondemand/V10.5/config/ars.cache
: Defines the locatio nof your configuration file for defining cache filesystems.

== arsstash related ars.ini configuration parameters ==

SRVR_OD_STASH=/opt/IBM/ondemand/V10.5/config/ars.stash

; SRVR_OD_STASH=/opt/IBM/ondemand/V10.5/config/ars.stash
: This parameter defines the location of the default stash file to use for database connections, arsload, and LDAP authentication.

== SSL / TLS related ars.ini configuration parameters ==

SSL_PORT=1446
SSL_KEYRING_FILE=/opt/IBM/ondemand/V10.5/config/ondemand.kdb
SSL_KEYRING_STASH=/opt/IBM/ondemand/V10.5/config/ondemand.sth
SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
SSL_CLNT_USE_SSL=1

; SSL_PORT=1446
: Defines the port number for encrypted connections to CMOD.
: There is no default port number, common choices are 1443 and 1446, but may be any number between 1024 and 65535 not already in use on your server by other services like TSM (1500, 1501) or DB2 (50000-50006, 60000-60006).

; SSL_KEYRING_FILE=/opt/IBM/ondemand/V9.5/config/ondemand.kdb
: Defines the location of the key database that contains all the requisite certificates and keys.

; SSL_KEYRING_STASH=/opt/IBM/ondemand/V9.5/config/ondemand.sth
: Defines the location of the stash file that contains passwords to the keys and certificates in the key database.
: This file should have very restrictive permissions.

; SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
: Defines the label of the SSL Certificate to be used to identify the IBM CMOD server.

; SSL_CLNT_USE_SSL=1
: Determines if utility clients like arsload should use SSL to connect to IBM CMOD.
: This is not necessary if you're not performing remote loads (via arsload), or queries or retrievals (via arsdoc).

== Unlisted CMOD Configuration Parameters ==
;SRVR_FLAGS_SECURITY_EXIT
: This is the flag to enable the Content Manager OnDemand User Security Exit. The IBM CMOD Security Exit, <code> arsusec</code> is used to extend and customize user authentication in CM OnDemand. When set to 1, CMOD will call the user exit when a user connects to CMOD and attempts to authenticate. <code> arsusec</code> is normally used for providing alternate authentication methods to OnDemand, like Single Sign On ("SSO") and in previous versions, Lightweight Directory Access Protocol ("LDAP").
: When enabled, the compiled <code> arsusec</code> binary must be located in the 'exits' directory under the 'bin' directory in your IBM CMOD installation directory, for example, <code> /opt/IBM/ondemand/V9.5/bin/exits</code>. If the parameter is enabled, and the <code> arsusec</code> compiled binary is missing from the 'exits' directory, the server may be unable to start, and cause <code> arssockd </code> to report a [[Unable_to_determine_the_database_engine|ARS4013E - Unable to determine the database engine]] error.

;ARSSOCK_TLSV12_ONLY
: When set to '1', this parameter disables all prior levels of TLS - improving security by disabling older, less secure cryptographic methods.
: When setting SSL/TLS parameters for CMOD, you can also add environment variables to modify the behavior of IBM Global Security Kit like <code>GSK_PROTOCOL_TLSV1_2=1</code>.

;ARSSOCK_STRICT_SHA2_ONLY_CERTS
: When set to '1', this flag instructs Content Manager OnDemand to only allow certificates that use the SHA2 hashing method in CMOD server certificates. This increases security, as certificates signed with SHA1 are considered vulnerable to 'collision' attacks, and as a result, are not secure.

;ARSSOCK_FIPS
:The default is for CMOD to start up with FIPS compliance enabled.
:If you are trying to upgrade to TLS v1.3, you need to disable FIPS support with <code>ARSSOCK_FIPS=0</code>.

== Related Articles ==

[https://www.ibm.com/docs/en/cmofm/10.5.0?topic=services-configuring-arsldapini-file LDAP Configuration File]

CMOD.wiki:About

2024-05-08T01:31:33Z

Jderrick:

CMOD.wiki is a source of information and guidance for users and Administrators of IBM's Content Manager OnDemand product, also known as IBM CMOD, or simply OnDemand.

CMOD.wiki is administered by Justin Derrick, a Content Manager OnDemand consultant, and contributor to the OnDemand User's Group for nearly 30 years.

Information from this Wiki can be republished non-commerically at no cost, provided the following attribution is included with each quote:

Source: http://CMOD.wiki/
Duplicated Under Creative Commons Attribution Non-Commercial Share Alike License

Main Page

2024-04-26T19:02:07Z

Jderrick: Cleaned up IBM Content Manager OnDemand FixPacks

{{TOCright}}

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
April 24th, 2024 - IBM Content Manager OnDemand v10.5 Fix Pack 8 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.7&platform=All&function=all IBM CMOD v10.5.0.8] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://www.odusergroup.org/forums

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[http://www-947.ibm.com/support/entry/portal/product/enterprise_content_management/content_manager_ondemand_for_multiplatforms?productContext=-816420431 IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-04-26T18:39:27Z

Jderrick: Minor corrections and additions

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that are becoming feasible with developments in quantum computing.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.28 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit version AFTER 8.0.55.28, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USE_CLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.
: If you run a server trace on arssockd, you will find a return code 407 from GSKit also known as <code>GSK_ERROR_BAD_KEYFILE_LABEL</code>.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue is not resolved by the latest [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]] (v10.5.0.8) but the documentation has been updated:
[https://www.ibm.com/docs/en/cmofm/10.5.0?topic=clients-setting-up-ssl-windows Setting up SSL with Windows Clients]

In order to generate the key database WITHOUT Post-Quantum Cryptographic methods, add <code>-pqc false</code> to the GSKit <code> -keydb -create</code> command:

gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

If you created a key database with the upgraded GSKit version, the key database for the client will need to be replaced with a 'non-pqc' key database as well.
Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-04-26T18:34:54Z

Jderrick: Corrected version number

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that are becoming feasible with developments in quantum computing.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.28 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit version AFTER 8.0.55.28, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USE_CLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.
: If you run a server trace on arssockd, you will find a return code 407 from GSKit also known as <code>GSK_ERROR_BAD_KEYFILE_LABEL</code>.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue should be resolved in a newer [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]]
gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

If you created a key database with the upgraded GSKit version, the key database for the client will need to be replaced with a 'non-pqc' key database as well.
Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

Main Page

2024-04-26T01:34:53Z

Jderrick: /* IBM CMOD Fixpacks & Security Bulletins */

{{TOCright}}

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
April 24th, 2024 - IBM Content Manager OnDemand v10.5 Fix Pack 8 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.7&platform=All&function=all IBM CMOD v10.5.0.8] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

February 13th, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.29 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.29*&includeSupersedes=0 IBM GSKit v8.0.55.29]

January 27th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 6 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.5&platform=All&function=all IBM CMOD v10.5.0.6] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

July 24th, 2022 - IBM Content Manager OnDemand v10.5 Fix Pack 5 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.4&platform=All&function=all IBM CMOD v10.5.0.5] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

January 27th, 2022 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.26 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.*&includeSupersedes=0 IBM GSKit v8.0.55.26]

January 21st, 2021 - IBM Content Manager OnDemand v10.5 Fix Pack 4 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.3&platform=All&function=all IBM CMOD v10.5.0.4] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components.

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://www.odusergroup.org/forums

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[http://www-947.ibm.com/support/entry/portal/product/enterprise_content_management/content_manager_ondemand_for_multiplatforms?productContext=-816420431 IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-04-01T13:22:47Z

Jderrick: Added note about IBM CMOD Client key database.

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that are becoming feasible with developments in quantum computing.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.26 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit version AFTER 8.0.55.26, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USE_CLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.
: If you run a server trace on arssockd, you will find a return code 407 from GSKit also known as <code>GSK_ERROR_BAD_KEYFILE_LABEL</code>.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue should be resolved in a newer [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]]
gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

If you created a key database with the upgraded GSKit version, the key database for the client will need to be replaced with a 'non-pqc' key database as well.
Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-03-28T14:52:33Z

Jderrick: Minor clarification about Content Manager OnDemand GSKit versions with PQC support.

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that are becoming feasible with developments in quantum computing.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.26 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit version AFTER 8.0.55.26, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USE_CLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.
: If you run a server trace on arssockd, you will find a return code 407 from GSKit also known as <code>GSK_ERROR_BAD_KEYFILE_LABEL</code>.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue should be resolved in a newer [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]]
gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-03-28T14:51:00Z

Jderrick: Fixed the CMOD ars.ini SSL_USE_CLNT_SSL environment variable.

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that are becoming feasible with developments in quantum computing.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.26 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit 8.0.55.26, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USE_CLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.
: If you run a server trace on arssockd, you will find a return code 407 from GSKit also known as <code>GSK_ERROR_BAD_KEYFILE_LABEL</code>.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue should be resolved in a newer [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]]
gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-03-27T22:35:12Z

Jderrick: Added troubleshooting item rc 407 GSK_ERROR_BAD_KEYFILE_LABEL .

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that are becoming feasible with developments in quantum computing.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.26 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit 8.0.55.26, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USECLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.
: If you run a server trace on arssockd, you will find a return code 407 from GSKit also known as <code>GSK_ERROR_BAD_KEYFILE_LABEL</code>.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue should be resolved in a newer [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]]
gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography

2024-03-27T21:51:37Z

Jderrick: IBM CMOD v10.5 and GSKit v8.0.55 breaks SSL/TLS.

{{TOCright}}
== Introduction ==
If you are installing a new instance of Content Manager OnDemand, and have upgraded to the latest IBM Global Security Kit, you need to be aware of a new and currently undocumented feature that silently breaks CMOD from using encrypted ports. Other products that rely on the IBM GSKit (DB2, Tivoli Storage Manager / Spectrum Protect) may also be affected.

; What is the IBM Global Security Kit ("GSKit")?
: The IBM Global Security Kit is a cryptographic library used by a number of IBM products to improve security by providing cryptographic functions.

== Background ==
Quantum Computing has the potential to disrupt IT security by making it feasible to crack the current state-of-the-art in encryption technology. Recently, cryptographic libraries have started to implement 'post quantum' computing ("PQC") methods -- that is, encryption that is resistant to the types of attacks that are becoming feasible with developments in quantum computing.

== Changes ==
If you attempt to use recent FixPacks (v8.0.55.26 or v8.0.55.31) of the IBM GSKit with Content Manager OnDemand v10.5, you MAY encounter frustrating issues relating to configuring CMOD to use SSL/TLS certificates.

These are due to the addition of PQC methods, and, unfortunately, a poor decision to enable these methods by default (without notifying end users) and making no updates to the available documentation.

; What has changed?
: Starting in GSKit 8.0.55.26, any NEW key databases (.kdb) that are created are protected by PQC methods.

; What's the problem?
: IBM CMOD v10.5 doesn't support using these new methods for protecting key databases.

; What's the error message?
: There is no error message. CMOD starts up normally, without an error message or ANY indication that something is wrong.

; What are the symptoms?
: Attempting to connect to CMOD on the encrypted port fails silently.

; That sounds frustrating.
: That's not a question, but yes, it is.

; How do I know I'm affected?
: You configure CMOD to communicate over SSL/TLS, but it doesn't work and produces no error messages like failed logins.
: Checking your operating system's diagnostic tools like <code> netstat -tlnp</code> shows the ssl port as open/listening.
: Attempts to connect to the encrypted port with <code> openssl s_client</code> or <code> ncat -ssl</code> returns NOTHING. (No error, just ''no response''.)
: Using the <code> arssockd -I ARCHIVE -p</code> option when <code> SSL_USECLNT_SSL=1</code> is set in [[ars.ini]] results in a failed connection.
: Checking your KeyDB with <code> gsk8capicmd_64 -cert -verify</code> produces 'OK'.

== Solution ==
When creating the key database, use the '-pqc false' option, in order to use the older method. This issue should be resolved in a newer [[Main_Page#IBM_CMOD_Fixpacks_.26_Security_Bulletins|CMOD Fixpack]]
gsk8capicmd_64 -keydb -create -db ars-ssl.kdb -genpw -stash -pqc false

In this command, this is a description of the various options:
;keydb
: This tells the GSKit that we're going to perform an operation on a key database.

;create
: We want to create a new key database.

;db
: Specifies the name of the key database to create.

;genpw
: Automatically generate a password to protect the contents of the key database.

;stash
: Generate a stash file containing the password, stored in an obscured way.

;pqc
: This option determines if Post-Quantum-Computing methods are used. We are choosing 'false' to disable PQC methods.

Then proceed as normal with adding Root and Intermediate Certificates, generating your certificate request, and 'receiving' your signed certificate.

Main Page

2024-03-27T21:14:39Z

Jderrick: Added link to article about GSKit pqc operator

{{TOCright}}

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]   NOTE: [[IBM Content Manager OnDemand v10.5.0.7 and GSKit support for Post-Quantum Cryptography]]

February 13th, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.29 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.29*&includeSupersedes=0 IBM GSKit v8.0.55.29]

January 27th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 6 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.5&platform=All&function=all IBM CMOD v10.5.0.6] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

July 24th, 2022 - IBM Content Manager OnDemand v10.5 Fix Pack 5 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.4&platform=All&function=all IBM CMOD v10.5.0.5] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

January 27th, 2022 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.26 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.*&includeSupersedes=0 IBM GSKit v8.0.55.26]

January 21st, 2021 - IBM Content Manager OnDemand v10.5 Fix Pack 4 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.3&platform=All&function=all IBM CMOD v10.5.0.4] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components.

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://www.odusergroup.org/forums

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[http://www-947.ibm.com/support/entry/portal/product/enterprise_content_management/content_manager_ondemand_for_multiplatforms?productContext=-816420431 IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])

ARS0111E

2024-03-07T00:19:51Z

Jderrick: /* Troubleshooting */

{{TOCright}}
== What was the error? ==
'''Message Number''': 111

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS0111E

'''Message Text''': OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<. The error number is X Srvr->ondemand 10.0.0.1 non-SSL<-

== Example ==
OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<. The error number is 2 Srvr->ondemand 10.0.0.1 non-SSL<-

== Related Errors ==
Windows Client Message: [[The server failed while retrieving a document]].

== What were you doing? ==
Likely running IBM CMOD's arsmaint command with the "-v" option to validate the cache filesystems.

== What happened? ==
IBM Content Manager OnDemand encountered a file for which there is no link. Without a link inside the cache filesystem, the item cannot be retrieved in the cache. In fact, IBM CM OnDemand will try to retrieve the file from secondary storage (CMOD Storage Set or Storage Node) if one exists, as without a valid link, IBM Content Manager OnDemand will not know where the file exists in the cache filesystem(s).

== Troubleshooting ==
The troubleshooting is already done. The link needs to be created. You can create a new link using information from the error message, which should allow the file to be retrieved.

In terms of error numbers, there are a few common ones, which will give you a better idea of where the problem is:
; 2
: No such file or directory - the link points to a file that doesn't exist, or the link to the file doesn't exist.

; 13
: Permission denied - check your the permissions on the files/links and their parent directories to ensure you can access the files.

; 22
: Invalid Argument - something is broken with the link -- check to ensure that the link doesn't contain special characters or double slashes (//). Consider deleting the link and making a new one.

In the example above, the link could be re-created with the following command:
ln -s /arscache/cache2/12345/ABC/DOC/123FAAA /arscache/cache1/retr/ABC/DOC/123FAAA

Inside this command, these are the components:
;ln -s
: The UNIX / Linux command to create a symbolic ('soft') link from a file to a new location.

;/arscache/cache2/12345/ABC/DOC/123FAAA
: The location of the object in the cache filesystem that doesn't have an associated link. (Which we're building.)

;/arscache/cache2
: Presumably, the second cache filesystem.

;12345
: This is a CMOD internal date (number of days since January 1st, 1970 (also known as the UNIX epoch).
: Historically, this date was the date that the documents stored in this subdirectory would expire. In modern versions of IBM Content Manager OnDemand, this numbered directory has practically no meaning, as CMOD Document Objects are expired based on their cache retention period, and the capacity of the cache filesystem.

;ABC
: This is the 'Application Group ID Name' - a three letter code representing a specific Application Group. You can find this information inside the CMOD database table called arsag.

;DOC
: This directory name indicates that documents are stored inside. A directory called RES is also valid, it is used to store resources.

;123FAAA
: This is the CMOD Object Name -- at load time, individual documents are de-duplicated, compressed, then grouped into files called CMOD Objects.

;/arscache/cache1/retr/ABC/DOC/123FAAA
: This is the path where the link is to be created.
: Note that links are ALWAYS located in the first CMOD cache filesystem.
: While you can add and remove cache filesystems from ars.cache, you cannot move the FIRST cache filesystem.
: The 'retr' subdirectory is used as a 'map', to tell CMOD where it can find location of the the documents that users are requesting, across ALL of the cache filesystems.
: The structure is similar to the source, except it excludes the numbered 'expiration date' subdirectory.

If the creation of the link is successful, IBM Content Manager OnDemand should be able to retrieve the documents from the CMOD cache. Instead of trying to find the individual document in CMOD, run the arsmaint command again, and see if the message has disappeared.

== Articles Related to this message ==
[http://www.odusergroup.org/forums/index.php?topic=2629.0;topicseen IBM Content Manager OnDemand User Group Forums]

ARS0111E

2024-03-05T19:17:42Z

Jderrick: Fixed the link command. Added more detail to describe the file paths.

{{TOCright}}
== What was the error? ==
'''Message Number''': 111

'''Message Severity''': Error (Corrective action is required to continue)

'''Message Name''': ARS0111E

'''Message Text''': OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<. The error number is X Srvr->ondemand 10.0.0.1 non-SSL<-

== Example ==
OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<. The error number is 2 Srvr->ondemand 10.0.0.1 non-SSL<-

== Related Errors ==
Windows Client Message: [[The server failed while retrieving a document]].

== What were you doing? ==
Likely running IBM CMOD's arsmaint command with the "-v" option to validate the cache filesystems.

== What happened? ==
IBM Content Manager OnDemand encountered a file for which there is no link. Without a link inside the cache filesystem, the item cannot be retrieved in the cache. In fact, IBM CM OnDemand will try to retrieve the file from secondary storage (CMOD Storage Set or Storage Node) if one exists, as without a valid link, IBM Content Manager OnDemand will not know where the file exists in the cache filesystem(s).

== Troubleshooting ==
The troubleshooting is already done. The link needs to be created. You can create a new link using information from the error message, which should allow the file to be retrieved.

In the example above, the link could be re-created with the following command:
ln -s /arscache/cache2/12345/ABC/DOC/123FAAA /arscache/cache1/retr/ABC/DOC/123FAAA

Inside this command, these are the components:
;ln -s
: The UNIX / Linux command to create a symbolic ('soft') link from a file to a new location.

;/arscache/cache2/12345/ABC/DOC/123FAAA
: The location of the object in the cache filesystem that doesn't have an associated link. (Which we're building.)

;/arscache/cache2
: Presumably, the second cache filesystem.

;12345
: This is a CMOD internal date (number of days since January 1st, 1970 (also known as the UNIX epoch).
: Historically, this date was the date that the documents stored in this subdirectory would expire. In modern versions of IBM Content Manager OnDemand, this numbered directory has practically no meaning, as CMOD Document Objects are expired based on their cache retention period, and the capacity of the cache filesystem.

;ABC
: This is the 'Application Group ID Name' - a three letter code representing a specific Application Group. You can find this information inside the CMOD database table called arsag.

;DOC
: This directory name indicates that documents are stored inside. A directory called RES is used to store resources.

;123FAAA
: This is the CMOD Object Name -- at load time, individual documents are de-duplicated, compressed, then grouped into files called CMOD Objects.

;/arscache/cache1/retr/ABC/DOC/123FAAA
: This is the path where the link is to be created.
: Note that links are ALWAYS located in the first CMOD cache filesystem.
: While you can add and remove cache filesystems from ars.cache, you cannot move the FIRST cache filesystem.
: The 'retr' subdirectory is used as a 'map', to tell CMOD where it can find location of the the documents that users are requesting, across ALL of the cache filesystems.
: The structure is similar to the source, except it excludes the numbered 'expiration date' subdirectory.

If the creation of the link is successful, IBM Content Manager OnDemand should be able to retrieve the documents from the CMOD cache. Instead of trying to find the individual document in CMOD, run the arsmaint command again, and see if the message has disappeared.

== Articles Related to this message ==
[http://www.odusergroup.org/forums/index.php?topic=2629.0;topicseen IBM Content Manager OnDemand User Group Forums]

Troubleshooting Content Manager OnDemand

2024-02-27T02:28:56Z

Jderrick: Updated links to ODWEK Tracing & CMOD tracing.

{{TOCright}}
= Introduction =

IBM Content Manager OnDemand (IBM "CMOD") is a complex product that integrates the features of many different software components to build a fast, efficient, massively scalable Enterprise Report Management ("ERM") tool. By choosing to integrate with leading-edge tools like IBM DB2, Oracle, and Tivoli Storage Manager, IBM OnDemand benefits from the massive amount of development, features, and performance of these enterprise-class tools. However, this reliance on other tools means that finding the source of problems can be frustrating, as issues with individual components can produce strange errors in CMOD.

= Popular Troubleshooting Articles =
Some problems and error messages are so common that they have their own pages in the [[Main_Page#IBM_CMOD_Error_Messages_Reference|IBM CMOD Error Messages Reference]].

Specifically, the Content Manager OnDemand daemon, <code> arssockd</code> is known to be a regular source of problems, check these pages if the error message is familiar:

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory]]

[[ARS0160E|ARS0160E - <code> arssockd</code> - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4014E|ARS4014E - <code> arssockd</code> - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - <code> arssockd</code> - Unable to initialize environment. rc=158]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - <code> arssockd</code> - Unable to determine the database engine]]

[[Unable to initialize server environment|ARS0147E - <code> arssockd</code> - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

= Components =

These are the components of CMOD, and the functionality they provide.

== Content Manager OnDemand ==

Content Manager OnDemand has a built-in 'System Log' that you can query for information. As almost every action is logged into the OnDemand System Log, it can be difficult to find what you're looking for. By choosing from the pop up list for the 'Severity' field, you can quickly find the most important error messages stored in the System Log.

Also, in the most recent versions of Content Manager OnDemand, almost all command-line utilities (arssockd, arsload, arsadmin) have 'tracing' features that can be turned on by specifying the '''-1''' and '''-2''' parameters.

arssockd -I ARCHIVE -S -1 /tmp/arssockd.trace -2 ALL=15

... specifies maximal tracing for arssockd. It's highly recommended that you only run in this mode while specifically doing debugging, as enabling tracing in Content Manager OnDemand reduces performance of the server.

There are a lot of articles on the IBM CMOD support portal for enabling tracing:
[https://www.ibm.com/support/pages/how-do-i-enable-tracing-content-manager-ondemand-web-enablement-kit-odwek Enabling ODWEK Tracing]   [https://www.ibm.com/support/pages/how-enable-trace-ibm-content-manager-ondemand-server Enabling tracing in Content Manager OnDemand server]   [http://www.ibm.com/support/docview.wss?uid=swg21661918 Formatting trace files on Windows]   [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemand.ir.doc/dodig089.htm Trace Facility for PDF indexer]

If arssockd doesn't produce a trace file, on platforms that include the strace utility, prefixing your command with: <code> strace -s 256 -f </code> will produce diagnostically valuable output. Search the output for the word 'arslog' in order to find error messages that are unable to be written to the System Log or trace file.

strace -s 256 -f arssockd -I ARCHIVE -S

... then search the output for the word 'arslog', and view the error messages that occur after it, as in the example below:

[pid 900] execve("/opt/ibm/ondemand/V9.5/bin/arslog", ["/opt/ibm/ondemand/V9.5/bin/arslog", "ARCHIVE", "2017-11-27 11:38:06.247480", "0", "ARSMSG", "", "2", "216", "ARS0216E Unable to determine SMS/DMS tablespace type or filesystem is invalid >/arsdb/SMS<. The error number is 2", ""],

== Operating Systems ==
One of the common issues that manifests in [http://www.odusergroup.org/forums/index.php?topic=2496.0 strange], [http://www.odusergroup.org/forums/index.php?topic=1187.0 odd], and [https://www-01.ibm.com/support/docview.wss?uid=swg21618982 puzzling] ways is a lack of resources (CPU / Memory). On the UNIX-style platforms, this is controlled by the 'ulimit' command ([https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/com.ibm.aix.cmds5/ulimit.htm AIX] and [https://access.redhat.com/solutions/61334 Linux]). Given that IBM CMOD is installed on servers, the ulimits should be set to 'unlimited' for all parameters. The only reason to establish limits on OnDemand's access to server resources is if it's installed on a shared system -- but this generally only happens in the smallest of Content Manager OnDemand installations.

You can view your current ulimits with:
ulimit -a

=== AIX ===
Advanced Interactive eXecutive ("AIX") is IBM's unique flavor of the popular UNIX operating system. Common places to search for diagnostic information is the Error Report (errpt -a) or the standard logging directory, /var/log. Also, logging to the console is a popular option. If you have root access to the server, you can run:

swcons `tty`

... which '''SW'''itches the '''CONS'''ole to the currently session you're connected to. Pay special attention to the 'backticks', rather than quote characters that surround the "tty" command. The backticks tell AIX to run the command "tty", and place the output of the "tty" command into the command line as an argument to the swcons command.

After you've successfully switched the console to your local login session, try the command that is giving your problems again, and you may see an error message pop up on your display, which may provide some explanation as to what the problem is.

You can also get hardware and operating system level error messages from AIX's "Error Report" command, errpt.

errpt -a

If you don't have strace on your AIX server, you can use <code> truss </code> instead.

truss arssockd -I CMOD_DEV -S

Search the output in reverse order, looking for errors, permissions issues, or missing files.

=== Linux ===
Linux is a popular open source operating system. You can get system-level information or errors by running the 'dmesg' command -- but you'd be well-advised to use the 'more' or 'less' or 'pg' utilities to get a single page worth out output at a time, as the dmesg output can be thousands of lines long.

dmesg |more

Also, as Linux takes several of its concepts for system administration from UNIX, you can also find logging information in the /var/log directory.

== Database Engines: IBM DB2, Oracle, MSSQL ==

The database component of a Content Manager OnDemand installation provides for the storage of configuration data, as well as the storage and indexing of document-related metadata. OnDemand processes documents, and loads the index data for those documents into the database, so end users can query it later. The database is responsible for maintaining tables, building indexes (to make queries faster), and at a lower level, performing backups.

=== IBM DB2 ===

IBM DB2 is provided by default as a 'limited use' license with Content Manager OnDemand at no cost, and as such, is the most popular database for IBM CMOD. DB2 has a concept called 'instances', which is like a complete installation of DB2 that is unique and managed at the operating system's user account level. If users Alice and Bob both have accounts on a single server, they can each have their own instance, and that instance is complete and wholly functional and independent of each other. To facilitate this user-level instance, DB2 creates a directory called 'sqllib' inside the user's home directory (in our example, Alice would have /home/alice/sqllib, and Bob would have /home/bob/sqllib). Inside the sqllib directory is the 'db2dump' subdirectory, which contains a file called 'db2diag.log'. It contains the majority of the diagnostic information for DB2.

Log in as the database instance owner, then run these commands:

cd sqllib/db2dump # Change into the directory where log files are kept.
more db2diag.log # View the contents of the DB2 Diagnostic Log a page at a time.

If you can't find the db2diag.log, or the data in it is old, your organizations Database Administrator may have moved the diagnostic data files. You can find the new path with the following command:

$ db2 "get dbm cfg" |grep DIAGPATH
Diagnostic data directory path (DIAGPATH) = /db2/db2dump/
Alternate diagnostic data directory path (ALT_DIAGPATH) =

Alternately, you can see the last 500 lines of the log with tail:

tail -n 500 ~/sqllib/db2dump/db2diag.log # Show the last 500 lines -- may be different on other Operating Systems!

Or of you want to monitor messages as they're written into the file by the database:

tail -f ~/sqllib/db2dump/db2diag.log # Prints new messages as they're added to the log file.

In order to exit from the tail command, press Control-C.

==== Real time performance monitoring ====
All modern versions of IBM DB2 include a tool called 'db2top' that is a performance monitoring tool just like Linux's 'top' and AIX's 'topas'. Use it to monitor what DB2 is doing in near-real-time. Here are two articles to get you started using it: [http://db2commerce.com/2014/08/26/db2-basics-db2top/ Ember Crooks DB2 Basics]   [https://www.ibm.com/developerworks/data/library/techarticle/dm-0812wang/ IBM Developerworks]

== Tivoli Storage Manager ==

On all platforms, Tivoli Storage Manager ("TSM") is available to be utilized to store data for long-term archiving. In TSM, there is an internal 'activity log' that records all activity and errors. You can use the "query activity log" command with a variety of options to get information about any issues that TSM has experienced in the past.

query activity log

... will provide the last several hours of messages.

query activity log begintime=23:59

... will show all activity log messages starting at 11:59pm. The specified time my be formatted in 24-hour or "military" time.

query activity log begindate=12/31/2014

... will show all activity beginning on a particular date.

There are many more options to the "query activity log" command, which can be viewed online with:

help query activity

Additionally, if you want to view a 'console' of all messages in TSM as they happen, you can log in to the TSM Administrative Client in 'Console Mode':

dsmadmc -consolemode

... and after entering a valid User ID and password, you will see all messages in TSM, as they happen. To exit from Console Mode, simply press Control-C.

=== Return Codes ===

As with DB2, a lot of the IBM CMOD error messages are 'passed through' from Tivoli Storage Manager.

ARS0429E TSM Error: ANS0266I (RC2302) The dsmEndTxn vote is ABORT, so check the reason field., Return Code=2302, Reason=41, File=arssmsms.cpp

In addition to getting the TSM activity log data, you can look up the return code in the [https://www.ibm.com/docs/en/tsm/7.1.0?topic=api-return-codes-source-file-dsmrch TSM v7.1 API Return Codes] page, to give you a better understanding of where the error might be.

ars.cfg

2024-01-08T18:24:29Z

Jderrick: Added section on ARS_LOAD_IGN_DB_NAME_MATCH mentioned in ODNews 2023 Q4

{{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  
|-
|
#
# 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  
|-
|
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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  
|-
|
#
# 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  
|-
|
###########################################
# 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. 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.

== IBM CMOD Storage Management Configuration ==
{| class="mw-collapsible mw-collapsed wikitable"
! Sample IBM Content Manager OnDemand TSM Configuration Parameters  
|-
|
######################################################
# 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] Usage and history of this parameter was described in [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf ODNews 2023 Q4]
;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.

Main Page

2024-01-08T18:22:21Z

Jderrick: Added IBM OD News Newsletter for 2023 Q4

{{TOCright}}

== What does CMOD stand for? ==

What is CMOD? It stands for '''Content Manager OnDemand''', IBM's flagship product in the Enterprise Report Management (ERM) segment of Enterprise Content Management (ECM) software market. CMOD has consistently appeared in the upper-right-hand corner of the Gartner Magic Quadrant for archival systems since shortly after it's inception, largely because of it's rock-solid reliability, speed at ingesting data, data compression and de-duplication, and ability to easily scale to multi-petabyte sizes, and serve hundreds of thousands of users per day. For more information, about CMOD and its strengths, visit the '[[Introduction]]' or [[Frequently Asked Questions about Content Manager OnDemand|IBM CMOD FAQ]] pages.

[[Ten Reasons to use IBM Content Manager OnDemand]] for ECM & ERM

== IBM CMOD Fixpacks & Security Bulletins ==
August 25th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 7 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.6&platform=All&function=all IBM CMOD v10.5.0.7] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack adds support for TLS v1.3!

August 3rd, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.31 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.31*&includeSupersedes=0 IBM GSKit v8.0.55.31]

February 13th, 2023 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.29 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.29*&includeSupersedes=0 IBM GSKit v8.0.55.29]

January 27th, 2023 - IBM Content Manager OnDemand v10.5 Fix Pack 6 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.5&platform=All&function=all IBM CMOD v10.5.0.6] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

September 28th, 2022 - SECURITY BULLETIN - IBM Content Manager OnDemand for Multiplatforms is affected by a vulnerability CVE-2018-25032 - [https://www.ibm.com/support/pages/node/6824729 CMOD CVE-2018-25032]

July 24th, 2022 - IBM Content Manager OnDemand v10.5 Fix Pack 5 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.4&platform=All&function=all IBM CMOD v10.5.0.5] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README]

January 27th, 2022 - IBM Global Security Kit ("GSKit") Fix Pack v8.0.55.26 [https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Security+Systems&product=ibm/Tivoli/IBM+Global+Security+Kit&release=All&platform=All&function=fixId&fixids=8.0.55.*&includeSupersedes=0 IBM GSKit v8.0.55.26]

January 21st, 2021 - IBM Content Manager OnDemand v10.5 Fix Pack 4 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.5.0.3&platform=All&function=all IBM CMOD v10.5.0.4] [https://cmod.wiki/dox/CMOD-v10.5-README.txt CMOD v10.5 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components.

January 19th, 2021 - IBM Content Manager OnDemand v10.1 Fix Pack 10 Released [http://www.ibm.com/support/fixcentral/swg/quickorder?parent=Enterprise%20Content%20Management&product=ibm/Information+Management/Content+Manager+OnDemand+for+Multiplatforms&release=10.1.0.9&platform=All&function=all&source=fc IBM CMOD v10.1.0.10] [https://cmod.wiki/dox/CMOD-v10.1-README.txt CMOD v10.1 Server README] SECURITY: This FixPack replaces Log4j in all CMOD components. OnDemand Full Text Search Exporter (ODFTIExporter) now requires Java 8!

April 30th, 2020 - IBM Content Manager OnDemand 9.5 has reached end of support status! [https://CMOD.cloud/upgrades Click here if you need help upgrading...]

=== IBM CMOD Support & CMOD System Requirements ===

CMOD 10.5 requirements: [http://CMOD.co/reqs Content Manager OnDemand v10.5 System Requirements for Hardware and Software]

Is your version of Content Manager OnDemand supported? [https://www-01.ibm.com/software/support/lifecycleapp/PLCSearch.wss?q=Content+Manager+OnDemand&ibm-search=Search IBM CMOD Software Lifecycle]

Base levels of IBM Content Manager OnDemand (v10.1 and v10.5) can be downloaded through [https://www.ibm.com/software/howtobuy/passportadvantage/paocustomer IBM Passport Advantage Online]

Business Partners can get access to base levels of software throughthe [https://www.ibm.com/partnerworld/partnertools/eorderweb/ordersw.do IBM Software Access Catalog]

The latest Tivoli Storage Manager (a.k.a. Spectrum Protect) Fixpacks can be found here: [https://www-01.ibm.com/support/docview.wss?uid=swg21239415 Tivoli Storage Manager & Spectrum Protect FixPacks]

== CMOD Webinars & Workshops ==

=== September 2022 ===
IBM CMOD Workshop in Chicago, Illinois - [https://CMOD.co/chicago Presentation Materials & Labs]

[[List of Past Events]]

== Use Cases for Content Manager OnDemand ==

== Glossary ==

A list of terms specific to Content Manager OnDemand can be found in the [[Glossary]].

[[Glossary#Acronyms|Acronyms]] | [[Glossary#Terms_Specific_to_Content_Manager_OnDemand|Terms Specific to CMOD]] | [[Glossary#OnDemand_Indexing_Tools|Indexing Tools]] | [[Glossary#OnDemand_Command-Line_Tools|Command Line Tools]] | [[Glossary#General_Information_Technology_Terms_Related_to_Content_Manager_OnDemand|General IT Terms Relating to CMOD]]

== Introductory Topics ==

[[Frequently Asked Questions about Content Manager OnDemand]]

[[IBM CMOD System Log]]

[[Date and Time formats in Content Manager OnDemand]]

[[Table Segmentation in Content Manager OnDemand]]

[[IBM CMOD Cache Filesystems]]

== Designing CMOD Systems ==

A summary of things the things the Installation Guide won't tell you.

== IBM CMOD Troubleshooting ==

[[Troubleshooting Content Manager OnDemand]]

[[Command Line Options for the CMOD Client]]

[[Exporting Application Groups to another Library Server]]

Configuration File Guides: [[ars.ini]] [[ars.cfg]]

==Common Command Reference==
[[arsadmin]] [[arsdate]] [[arsdb]] [[arslog]] [[arsmaint]] [[arsload]] [[arssockd]] [[arsstash]] [[arstblsp]] [[arsxml]]

===arsdoc===
IBM Content Manager OnDemand's arsdoc utility allows administrators to perform user-related tasks through a command line interface.

[[arsdoc parameters]]   [[arsdoc query]]   [[arsdoc get]]   [[arsdoc update]]


== Content Manager OnDemand Advanced Topics ==

Here are some advanced topics, special instructions & fixes for unique situations, provided exclusively here on CMOD.wiki.

[[IBM CMOD Composite Indexes]]

[[Content Manager OnDemand Native Encryption]]

[[Manually disabling LDAP authentication]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Loading into a remote CMOD server with SSL enabled]]

[[Content Manager OnDemand Database Tables]]

[[DOC_NAME|Content Manager OnDemand DOC_NAME field]]

[[Default Values and the Generic Indexer]]

[[Useful SQL Queries for Content Manager OnDemand]]

[[Collecting Return Codes from CMOD utilities]]

[[DB2 with SAMBA winbind]]

== Best Practises ==
== Best Practises for CMOD Administrators ==

[[Case Insensitive Search]]

[[Uploading Files to CMOD]]

[[Query Restrictions]]

[[Migrating From Filenet to Content Manager OnDemand]]

[[Improving Content Manager OnDemand Performance]]


== IBM CMOD Error Messages Reference ==
Here is a list of error message numbers from CMOD, a description, and helpful advice on how to correct them, most recently added messages are first:

[[ARS0000E|ARS0000E Initialization of ICU for directory]]

[[nx_window_open|Symbol nx_window_open was referenced]]

[[CMOD server failed while retrieving a resource group]]

[[ARS1133I|ARS1133I The last row successfully loaded was X]]

[[ARS1196E|ARS1196E Invalid generic index file format: >GROUP_FIELD_VALUE;1234567890<]]

[[ARS1111E|ARS1111E The application >< does not exist within the application group >AppGroup<]]

[[ARS1129E|ARS1129E Row X: The string "20190125" could not be converted to a date from the format of %Y-%m-%d]]

[[ARS1315W|ARS1315W Warning: The date string "20190125" with date format "%Y%m%d" does not match a specific date.]]

[[ARS1109E|ARS1109E - Unable to allocate enough memory. File=X, Line=Y]]

[[ARS7732E|ARS7732E - A parsing error occurred in file <filename> Line X, Column Y]]

[[ARS7807E|ARS7807E - No objects were found]]

[[ARS7795E|ARS7795E - ARSXML - The input file contains objects that are specified in the wrong order.]]

[[ARS0185E|ARS0185E - OnDemand license limit has been exceeded, currently X running only Y are entitled.]]

[[ARS0111E|ARS0111E - OnDemand is unable to determine the link for the file >/arscache/cache2/12345/ABC/DOC/123FAAA<]]

[[ARS0160E|ARS0160E - Unable to load module /opt/IBM/ondemand/V9.5/bin/exits/arssmtsm]]

[[ARS4305E|ARS4305E - Generic Indexer requires the data to have already been indexed. Index the data or verify your input file and resubmit the job.]]

[[ARS0238W|ARS0238W - The tokenized query string has a nonnumeric value at marker position (2), value (#####). Use a numeric value instead.]]

[[ARS1107E|ARS1107E - An error occurred. Contact your system administrator and/or consult the System Log.]]

[[ADM1822W|ADM1822W - The active transaction log is being held by dirty pages. Database performance may be impacted.]]

[[ARS1400E|ARS1400E - Loading was unable to continue due to encountering a previously failed load of the same name that has yet to be unloaded.]]

[[ARS4014E|ARS4014E - Unable to load >DB2<]]

[[ARS4012E|ARS4012E - Unable to initialize environment. rc=158]]

[[ARS1407W|ARS1407W - Warning: A document with >0< pages and size of >63678662< bytes was processed.]]

[[ARS1607E|ARS1607E - The OnDemand stash file >< either does not exist or is not valid]]

[[ARS1108E|ARS1108E - User >user< does not have permission to perform the specified action]]

[[ARS0198E|ARS0198E - Invalid ownership and/or permissions on cache file/directory]]

[[ARS0199E|ARS0199E - Unexpected empty directory in cache]]

[[ARS0141E|ARS0141E - Ran out of load-id naming conventions]]

[[ARS1105E|ARS1105E - Userid or password is invalid]]

[[LDAP Error: Invalid credentials|ARS0384E - LDAP Error: Invalid credentials]]

[[Unable to determine the database engine|ARS4013E - Unable to determine the database engine]]

[[ARS0013E|ARS0013E - DB Error]]

[[ARS0014I|ARS0014I - DB Info]]

[[ARS0015E|ARS0015E - Unable to find SMS tablespace filesystems]]

[[ARS0016E|ARS0016E - Unable to allocate enough DMS filesystem space for table]]

[[ARS0106E|ARS0106E - Unlink failed for file]]

[[Unable to initialize server environment|ARS0147E - Unable to initialize server environment]]

[[The command arssockd can only be run by the owner of the command|ARS0152E - The command arssockd can only be run by the owner of the command]]

[[Unable to create ARCHIVE database|ARS4067E - Unable to create ARCHIVE database]]

== CMOD Documentation & Other Resources ==

=== The OnDemand User Group ===
The official IBM Content Manager OnDemand User's Group Forums can be found here:
http://www.odusergroup.org/forums

Ed Arnold of IBM started a thread with links to IBM Content Manager OnDemand on z/OS documentation here: [http://www.odusergroup.org/forums/index.php?topic=287.0 Ed Arnold's IBM CMOD on z/OS Links to Documentation]

=== IBM CMOD Technotes & Whitepapers ===

Here are some popular IBM Technotes:

[http://www-01.ibm.com/support/docview.wss?uid=swg21392275 IBM Content Manager OnDemand Client Compatibility Chart]

[http://www-01.ibm.com/support/docview.wss?uid=swg21686051 Upgrading from 8.4.x, 8.5, or 9.0 to Content Manager OnDemand v9.5]

[https://www.ibm.com/support/pages/sites/default/files/inline-files/Content%20Manager%20OnDemand%20Single%20Sign-On%20for%20Content%20Navigator%202020-06-10.pdf IBM CMOD SSO for ICN / IBM Content Manager OnDemand Single Sign On for IBM Content Navigator -- Updated June 2020!]

=== Links to the IBM Website ===

==== IBM CMOD Product Page ====

[https://www.ibm.com/ca-en/marketplace/ibm-content-manager-ondemand Content Manager OnDemand for Multiplatforms ]

==== IBM CMOD Support Page ====

[http://www-947.ibm.com/support/entry/portal/product/enterprise_content_management/content_manager_ondemand_for_multiplatforms?productContext=-816420431 IBM Content Manager OnDemand Support ]

==== IBM CMOD Knowledge Centers ====

Content Manager OnDemand Knowledge Centers: [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.5.0/com.ibm.ondemandtoc.doc/ondemandmp_10.5.0.htm v10.5] | [https://www.ibm.com/support/knowledgecenter/SSEPCD_10.1.0/com.ibm.ondemandtoc.doc/ondemandmp_10.1.0.htm v10.1] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemandtoc.doc/ondemandmp_9.5.0.htm v9.5] | [http://www-01.ibm.com/support/knowledgecenter/SSEPCD_9.0.0/KC_ditamaps/ondemandmp_9.0.0.htm v9.0]
(CMOD 8.5 Knowldge Center and CMOD Information Centers for 8.4.1 and 8.3 (aka 7.1.2.x) have been discontinued.)

==== Related Documentation ====
IBM Global Security Kit (GSK) v8 User Guide, Edition 23 [https://cmod.wiki/dox/IBM_GSKit_UserGuide_Edition23.pdf Local Mirror]

IBM CMOD Documentation PDFs [http://www-01.ibm.com/support/docview.wss?uid=swg27051069#docs IBM CMOD v10.1 Documentation in PDF format] [https://cmod.wiki/dox/CMODv10.1 Local Mirror]
===== IBM DB2 Documentation =====
IBM DB2 v9.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m1e950.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr95/pdf/en_US/db2m2e950.pdf Volume 2]

IBM DB2 v10.1 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol1-db2m1e1010.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr101/pdf/en_US/DB2MessageRefVol2-db2m2e1010.pdf Volume 2]

IBM DB2 v10.5 Messages & Codes Reference [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol1-db2m1e1050.pdf Volume 1] [http://public.dhe.ibm.com/ps/products/db2/info/vr105/pdf/en_US/DB2MessageRefVol2-db2m2e1050.pdf Volume 2]

[https://www.ibm.com/support/pages/node/627743 IBM DB2 v11.5 Documentation in PDF Format]

===== IBM Tivoli Storage Manager & Spectrum Protect Documentation =====
Tivoli Storage Manager Knowledge Center: [http://www.ibm.com/support/knowledgecenter/SSGSG7_7.1.1/com.ibm.itsm.tsm.doc/welcome.html v7.1.1]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.3/tsm/welcome.html v7.1.3]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.4/tsm/welcome.html v7.1.4]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.5/tsm/welcome.html v7.1.5]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.6/tsm/welcome.html v7.1.6]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.7/tsm/welcome.html v7.1.7]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.8/tsm/welcome.html v7.1.8]   [https://www.ibm.com/support/knowledgecenter/en/SSGSG7_7.1.9/tsm/welcome.html v7.1.9]

The version of Tivoli Storage Manager AFTER version 7.1 is now called 'Spectrum Protect'.

Spectrum Protect Knowledge Centre: [https://www.ibm.com/support/knowledgecenter/en/SSEQVQ_8.1.9/tsm/welcome.html Spectrum Protect v8.1.9]

===== IBM CMOD ODWEK Java API Documentation =====

[https://cmod.wiki/dox/ODWEK-BasicsAndBeyond.pdf IBM Redbook on IBM CMOD ODWEK Java API v8.4] WARNING: This Redbook is almost 10 years old!

[https://cmod.wiki/dox/CMODv7.1/ODApiDoc/index.html IBM CMOD v7.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v8.5/index.html IBM CMOD v8.5 Java API Reference]

[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.odwek.doc/dodwekplugin-gentopic1.htm IBM ODWEK v9.5 Servlet Reference Infocentre]

[https://cmod.wiki/dox/ODapiDoc/v9.5/index.html IBM CMOD v9.5 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.1/index.html IBM CMOD v10.1 Java API Reference]

[https://cmod.wiki/dox/ODapiDoc/v10.5/index.html IBM CMOD v10.5 Java API Reference]

[https://www-01.ibm.com/support/docview.wss?uid=swg27019518 IBM CMOD ODWEK Java API v10.1 - Generic Transform Interface]

===== IBM CMOD ODWEK REST API =====
[https://cmod.wiki/dox/RESTapiDoc/ IBM Content Manager OnDemand REST API Reference v10.5]

===== IBM Content Navigator Documentation & Forums =====

IBM Content Navigator v2.0 [http://www-01.ibm.com/support/docview.wss?uid=swg27025015 Publications] [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002869 Forums]

IBM Developerworks IBM mobile [http://www.ibm.com/developerworks/community/forums/html/forum?id=11111111-0000-0000-0000-000000002868 ECM Forum]

==== IBM ODNews / OnDemand Newsletter ====

ODNews 2016: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2016Q4.pdf 4th Quarter]

ODNews 2017: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2017Q4.pdf 4th Quarter]

ODNews 2018: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2018Q4.pdf 4th Quarter]

ODNews 2019: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2019Q4.pdf 4th Quarter]

ODNews 2020: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2020Q4.pdf 4th Quarter]

ODNews 2021: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2021Q4.pdf 4th Quarter]

ODNews 2022: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2022Q4.pdf 4th Quarter]

ODNews 2023: [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q1.pdf 1st Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q2.pdf 2nd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q3.pdf 3rd Quarter] [https://cmod.wiki/dox/ODNewsletter/ODNewsletter2023Q4.pdf 4th Quarter]

[http://www.ibm.com/support/docview.wss?uid=swg27024130 IBM CMOD "ODNews" Archive ] [https://cmod.wiki/dox/ODNewsletter Local Mirror]

==== IBM CMOD Redbooks ====

[http://www.redbooks.ibm.com/redbooks.nsf/searchsite?SearchView&query=ondemand All IBM CMOD Redbooks]

[http://www.redbooks.ibm.com/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2013)] [http://www.redbooks.ibm.com/redbooks/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/redpieces/abstracts/sg246915.html?Open IBM Content Manager OnDemand Guide (2015)] [http://www.redbooks.ibm.com/redpieces/pdfs/sg246915.pdf PDF]

[http://www.redbooks.ibm.com/abstracts/sg248226.html?Open Building IBM ECM Solutions End to End] [http://www.redbooks.ibm.com/redbooks/pdfs/sg248226.pdf PDF]

==== Misc. Documentation ====
[https://en.wikipedia.org/wiki/ASA_carriage_control_characters Line Data Carriage Control Characters]

----

Last Edit By: --[[User:Jderrick|Jderrick]] ([[User talk:Jderrick|talk]])