Sets the maximum file size in kilobyte for the ImageMaster log files.

When a log file exceeds the defined size, it will be copied with a timestamp in its name. This is called rotation. Log files will be split and marked with a timestamp: ImageMaster 9-yyyy-MM-dd Thh-mm-ss.ms.log. The timestamp denotes the date and time of the log file’s last modification (yyyy=year, MM=month, dd=day, hh=hour, mm=minute, ss=second, ms=millisecond).

This setting is ignored if “ima.log.rotation” is set to “daily”.

The default is 10000 (10 megabyte).

Sets the log file name.

Sets the rotation mode. If set to “daily”, the log files are rotated every day. If set to “size”, the log files are rotated according to the set file size.

Sets the directory to be used for ImageMaster log files. By default the directory is used where the application server stores its log files for the instance.

Sets a threshold time interval in milliseconds (e.g. 1000 for one second) for logging warning messages about long-running SQL statements.

Any statement that takes longer to execute (statement preparation + result set retrieval) will be logged with the message id IMA9_INV_01017 on level WARNING. This is a trouble-shooting option to identify complex SQL statements and inappropriate database performance.

This setting is disabled by default.

Sets the path of the license log file (license audit). The default is “ImageMaster9-license.log” in the current directory.

Sets the maximum number of rotated log files which will be stored. When the number is exceeded, the oldest file will be deleted after a rotation.

The default is 10.

Sets the log level. The parameter value SSSS may be one of the following:

ERROR, WARNING, INFO (default), TRACE, DEBUG.

These settings denote an increasing level of detail starting from “ERROR” with the least detailed level (restricted only to report errors), up to “DEBUG”, which contains the most detailed logging information resulting in large log files.

The default is INFO.

Changing this property only takes effect after a system restart.

ima.jdbc.ddlTimeout=XX

Oracle only: Sets the timeout in seconds that ddl statements (table creation etc.) wait before aborting if the database is busy. If this property is not set, the Oracle default value of ‘30’ is used.

Setting this property requires “ALTER SESSION” rights for the ImageMaster database user.

Omits partly redundant, internal permission checks for better performance (when set to true) so access to the revision object itself also grants access to objects that can be retrieved through the said revision object such as contained contents or binary objects.

The default is true.

ima.cache.verificationInterval=XX

Sets a time interval in milliseconds that determines when the cache is refreshed (based on a comparison with the current state in the database). This represents the maximum time that a cache can return outdated administrative information after an operation such as modifying or deleting a role.

This cache setting can be relevant in clustered environments with multiple application server instances. Within the instance that triggered a modification, the outcome is immediately effective, but for the other instances there can be a delay of the said interval.

• If there is only one application server instance, this interval has no effect.

• A value of 0 validates the caches on each access.

• A value below 0 disables cache validation.

  This can be useful if administrative changes occur rarely and if it is foreseen to restart other instances after an administrative change.

The default is 600000 (10 minutes).

ima.monitoring.enabled=BB

Can be used to deactivate ImageMaster application monitoring, which is active by default.

Changing this property only takes effect after a system restart.

ima.monitoring.maxQueries=XX

Specifies the maximum number of different queries to be monitored. If the specified number is exceeded, the oldest query will be removed using a least recently used (LRU) strategy.

The default is 1000.

Changing this property only takes effect after a system restart.

http.proxyHost=myProxyHost

http.proxyPort=myProxyPort

https.proxyHost=myProxyHost

https.proxyPort=myProxyPort

You can use these parameters as one alternative to define a proxy configuration for ImageMaster archive storage based on Hitachi. To apply the system settings from here, in the AdminClient the proxy type “SYSTEM” must be set up.

As another alternative, you can directly define the proxy setting via the AdminClient by selecting the proxy type “DEDICATED”, for more details see section Archives configuration in [UM AdminClient].

Instead of the given default (tx-object-store) in the ImageMaster configuration file (configureAppServer.config), here you can set an alternative absolute path to a dedicated fast storage device like a RAM drive that is used for temporary storage of internal data. This is useful to speed up your system in high load scenarios.

Sets the max pool size of the connection pool for SFTP connections. This setting is also relevant for NetApp storage connected via SFTP.

The default is 50.

Sets the timeout for SFTP connections in milliseconds.

The default is 60000 (one minute).

ima.archive.bufferSize=XX

Specifies the size in bytes for the buffers used to transfer data to an archive. The default is 65536 (64 kilobytes).

http.maxConnections=XX

Sets the maximum number of concurrent recovery threads. The default is 1, which effectively disables concurrent processing.

ima.arm.gateKeeperSleepInterval=XX

Sets the maximum sleep interval in milliseconds for the ARM subsystem between two load checks.

The default is 5000 (5 seconds).

Sets a minimum time interval in minutes to wait before a process scheduled in the future is run.

The default is 5 (minutes).

A keystore can be used to store SSH key pairs, e.g. for private key authentication for SFTP archives (chapter Setup on the application server for SFTP with SSH step “Copy the key files”). This parameter sets the directory where the ImageMaster keystore is located.

The default is "ima-keystore" which is interpreted to be a path within the application server’s configuration directory, e.g.:

• for JBoss/WildFly: …“/standalone/configuration/ima-keystore/”

The keystore directory can also be specified as an absolute path beginning with “/” in Unix or Linux or begin with the drive letter (such as “C:/”) in Windows.

ima.statistics.documents.count.enabled=true

Enables gathering statistics for number of archived documents per document type.

The default is false.

ima.statistics.documents.size.enabled=true

Enables gathering statistics for content size per document type.

The default is false.

ima.statistics.documents.count.doctypes=SSSS

The document type names separated by comma for which (number of documents) statistics should be collected.

The statistics are collected under the key ima.<documentTypeName>.documents.count, where <documentTypeName> is the actual document type name. For the configured document type the total number of documents in this type is counted.

ima.statistics.documents.size.doctypes=SSSS

The document type names separated by comma for which statistics (size of all attachments) should be collected.

The statistics are collected under the key ima.<documentTypeName>.documents.size, where <documentTypeName> is the actual document type name.

Each document is counted with all its attachments as the size is reported for each document. Effects of single-instancing or archive mirroring are not included in the reported size.

com.tsystems.private.key.alias=SSSS

com.tsystems.private.key.password=SSSS

Controls the custom validation of inbound SOAP messages. The validation is not a full schema validation but only checks if required elements exit.

The default is true.

Controls the custom validation of outbound SOAP messages. Since messages generated by the Integration Service are expected to be valid, this option is only of limited use (e.g. for test and development purposes).

The default is false.

Sets the number of rows to fetch at once in a query. Also see the documentation for Java's java.sql.ResultSet.setFetchSize(int). This parameter is passed on to the underlying JDBC method for result set fetching.

The default is 100.

Defines the order of the documents and which one is selected when multiple documents are opened from the hit list. Possible values:

• selected_first

• selected_last

• hitlist_first

• hitlist_last

The default is “selected_last”.

Skips the execution of installer routines at application startup to achieve a fast startup, e.g. in large tenant applications.

The default is false.

Caution:

This option must only be enabled after the internal installer routines have run at least once, because this is required to prepare a new system for running operations!

If you plan to skip installers in your standard scenario:

• Only deactivate them after an initial successful run e.g. after a fresh installation where you successfully logged in once with the client.

• In an ImageMaster upgrade make sure to reactivate the installers temporarily to run at least once (e.g. with a client login).

By default the installers are run each time when the system is started. When these had already run before, this won’t change the system but can still take some extra time for routines to check if the system setup is up-to-date.

Activates logging of details about the client certificates.

This option is useful to debug SSL SOAP client authentication. The information is logged on level TRACE with a label “INTWS-00555”.

The default is false.

Specifies the location of the keystore to be used for storing client certificates.

This store will be used for outgoing HTTPS communication (e.g. archives using HTTPS). If this property is not specified, the system property “javax.net.ssl.keyStore” will be used instead. Thus this property should be used if one wants to use separate SSL keystores for ImageMaster and the application container (i.e. the application server). The password for the keystore must be stored in the ImageMaster password store under the alias “ima.ssl.keyStorePassword”.

Specifies the location of the trust store to be used for storing trusted server certificates.

This store will be used for outgoing HTTPS communication (e.g. archives using HTTPS). If this property is not specified, the system property “javax.net.ssl.trustStore” will be used instead. Thus this property should be used if one wants to use separate SSL truststores for ImageMaster and the application container (i.e. the application server). The password for the truststore must be stored in the ImageMaster password store under the alias “ima.ssl.trustStorePassword”.

Specifies the master password for the ImageMaster password store.

If no password is supplied, the default (empty) password is assumed until a password is set explicitly via the ImageMaster Integration Service (or AdminClient).

Caution

• If a master password is defined, only one of the settings must be used:

  • “ima.security.masterPassword”

  • alternatively, “ima.security.masterPasswordFile”

• Changing this property takes effect after a system restart.

• Wrong master password handling can cause the system to deny any service after a restart until the correct master password is supplied to the system again.

• For related details see: ImageMaster password manager.

As an alternative use the next option to store the password in a file.

Specifies the name of a file in the application server file system that contains the master password for the ImageMaster password store. For background information see the previous option.

As an alternative use the previous option to store the password directly in the application server configuration.

Sets the maximum age (in seconds) to sustain a job lock before the system breaks this log to purge unwanted locks. Undesired locks typically occur in case of an unexpected outage where the system cannot cleanly shut down (e.g. a power breakdown).

If you are aware of any customized jobs, where a very long job execution time is expected, make sure that you set a sufficiently long interval to avoid unwanted purging.

The default is 259200 (3 days).

ima.job.processing=BB

Determines if job processing is enabled on one application server instance (values: true / false). In case of a clustered ImageMaster installation, where multiple ImageMaster instances share a single database, only one instance needs to be enabled for job processing.

By default, job processing is enabled on each instance. Disabling the job system on one application server avoids duplicate work that otherwise is discarded on the slower instance. In contrast, keeping the job system enabled on multiple instances ensures that job processing proceeds if one instance is affected from an outage.

You must always make sure that at least one instance has job processing enabled.

Sets the timeout in seconds for updating the document lock table for document checkout and delete operations. If this timeout expires while acquiring the lock, the operation is considered to have failed.

The default is 20.

Sets the JDBC timeout in seconds for the ImageMaster query operation. A long running query fails with an error message if this limit is exceeded. This parameter can be overridden by any query operation in the corresponding web service request.

The default is 60 (i.e. 1 minute). The value 0 indicates that there is no timeout, which implies that a query can run for an infinite time interval.

Sets the JDBC timeout in seconds for operations that add a single-valued attribute to an existing document type. A long running operation fails with an error message if this limit is exceeded.

The default is 5 (seconds).

Controls whether error details are shown on the error page (error.jsf).

The default is false.

Enables tenant-based access by a tenant definition via the HTTP header

If header mode is enabled, a valid header (the custom header is named X-ima-tenant) must be present in order to access the client.

If the JVM parameter is false or omitted, the default behavior via the URL parameter is used.

ima.retention.extractprogram=BB

This option is used to enable the retention program to be extracted and stored in a separate table to reduce database storage.

Disable the option to optimize the system for faster performance in case database space is not important, or if there are extensions that create individual programs for each document, so extracting would bring no benefit.

The default is true.

ima.aspose.mono.spaced.fonts

Semicolon separated list of mono spaced fonts that are iterated to get the first available font in the system for rendering of text documents in the Web client user interface. Also see Font package installation.

The default is:

Liberation Mono;Courier New;Andale Mono;Dejavu Sans Mono;Consolas

ima.client.property.blacklist=SSSS

Comma separated list of properties that can be blacklisted from the about page (ImageMaster Properties & Java Properties). Check is done for each property via String#contains.

The default is password,pwd,passwd.

You can use this parameter to configure an HTTPS connection which is based on a given certificate, and which is established between the application server and an external server, such as an archive storage. However, the overall setup also requires further steps as they are typical in certificate based authentication (for a short summary see chapter Guideline for HTTPS connection setup of application server).

This option may be used to disable validation for incoming SOAP requests for better performance. It is recommended only to disable request validation after an initial testing phase, in a stable environment, in which it has been verified, that incoming requests are valid.

The default is true.

This option may be used to enable validation of SOAP responses from the full-text search for analysis, e.g. in a testing environment.

The default is false.

This option can be useful to troubleshoot error scenarios with invalid certificates in SSL/TLS communication. It should only be used temporarily and it is recommended not to activate this permanently in productive environments to reduce the log overhead.

For efficient end-to-end streaming the ImageMaster Integration REST Service [WS IS REST] requires that body parts for incoming data must be in the same order as the binary data objects that reference them. Otherwise, there is a loss of performance with increased memory usage. This setting is intended for further tuning the behavior in cases where this efficiency rule is not met: if this limit (in bytes) is exceeded in the internal stream processing (which can happen when attachments are out of order), REST attachments are temporarily written into files on the application server. This can ease a load on memory at the expense of performance. The default is 104857600 (100 MB).

Specifies the directory for temporary files for buffering REST attachments (see ima.rest.multipartMemoryBuffer above).

If this value is not set, the application server operating system’s default directory for temporary files is used.

ima.safe.logFile=SSSS

Full path for the location of the log files of the Signature Service (“ImaSafe.log” created by the components Crypto-Module and ArchiSig-Module). This location is initially valid up to the point in time when the module’s own log configuration is activated.

For further settings related to the Signature Service see the system manual [SM Signature Service].

ima.stamping.max.filesize=XX

Defines the maximum file size (in bytes) of the image that is used for stamping. The upload of an image with a larger size will be denied with an error by the AdminClient.

Default value: 102400

ima.stamping.allowed.mimetypes=SSSS

Comma-separated list of allowed mime-types . The upload of an image with another type will be denied with an error by the AdminClient. The default list contains well known image formats:

image/jpeg, image/jpg, image/png, image/bmp

com.tsystems.ima.stamping.maxWidth=XX

Limit for the maximum stamp width in pixels. The default value is 10000 (pixels).

com.tsystems.ima.stamping.maxHeight=XX

Limit for the maximum stamp height in pixels. The default value is 10000 (pixels).

com.tsystems.ima.stamping.tiffMaxArea=XX

A TIFF image with an area (width x height) less than the value of this system property will be converted to RGB color space and a color stamp will be placed on the TIFF.

The default value is 0, which means that color conversion is disabled. Enabling this feature (by setting a value that represents a size limit) can require much memory. Make sure to set a limit which can be handled by your system to avoid out-of-memory errors.

com.tsystems.ima.stamping.compressionType=SSSS

Compression type of the TIFF image. In case the TIFF file is not allowed for color space conversion (because of its size), the initial compression type of the input stream will be applied and only a stamp with an opacity more than 50% can be seen on the page.

The default compression type is LZW.

Semicolon-separated list of absolute server directories that are used by the rendition service when loading custom fonts. Also see the related issue: Missing package “fontconfig” on Linux systems

This option enforces secure connections for the ImageMaster clients and is used to enable:

• cookies to be created with the secure flag

• the HSTS header to be set (HTTP Strict Transport Security)

• the CSP header to be set (Content Security Policy)

An application server restart is required.

The default is true since ImageMaster release 9.12.2.2.

This option is used to define the maximum file size in bytes for uploads in the workspace area, administration is not affected.

Default is 0 (unlimited).

You can define the maximum size using the property “max-post-size”. It is recommended setting the option greater or equal than the described system property. An application server restart is required in this case. See [WildFly max-post-size] for more details.

This option is used to define a white list of allowed file extensions for uploads in the workspace area, while the administration area is not affected. The default is empty and no restrictions are defined.

com.tsystems.ima.stamping.printlabel.horizontalMargin=XX

This option is used to create space in pixels to the left and to the right of the elements, outside of defined borders.

In case the print label does not fit the page, the font size of the print label will be reduced to fit.

Default is 10.

com.tsystems.ima.stamping.printlabel.verticalMargin=XX

This option is used to create space in pixels at the top and bottom of the elements, outside of defined borders.

Default is 15.

com.tsystems.ima.stamping.printlabel.labelToContentMargin=XX

This option is used to define the margin in pixels between the document content and the print label.

Default is 10.

ima.renditionservice.image.pdfbox=true

Using this option with the value “true”, enables the rendering engine “pdfbox”. It has a limit for height and width of 14400units (200inches or 508cm). If the limit is exceeded, an error is thrown (IMAGE_CONVERSION_FAILED). This limit can be reduced (see next option for size limit) to avoid the processing of large images.

Setting this value to “false” enables the alternative engine (aspose) with the limit 1584units (22inches or 55,88cm). This engine behaves differently and scales images down, when the limit is exceeded.

Default is true.

ima.renditionservice.image.pdfbox.limit=14440

This option is only relevant in combination with the previous option if pdfbox is used. A limit in units (as an integer value) is specified here. If the rendition’s height or width exceeds the specified limit, an error is thrown (IMAGE_CONVERSION_FAILED).

Default and maximum is 14440.

ima.client.msx.ws.request.timeout=XX

Defines the request timeout (in seconds) in the web services communication related to the Content Services for E-Mail.

Default value: 60

ima.client.msx.ws.connect.timeout=XX

Defines the connection timeout (in seconds) in the web services communication related to the Content Services for E-Mail.

Default value: 60

ima.client.spc.ws.request.timeout=XX

Defines the request timeout (in seconds) in the web services communication related to the Content Services for SharePoint.

Default value: 60

ima.client.spc.ws.connect.timeout=XX

Defines the connection timeout (in seconds) in the web services communication related to the Content Services for SharePoint.

Default value: 60

ima.archive3d.backend.key=SSSS

Defines a back-end key that is used to authenticate against the Kisters WebViewer.

com.tsystems.ima.sap.messenger.calculateSAPDocTypeAttribute=BB

This option may be used to identify the data type of a binary attachment of an SAP document.

The default is false.

com.tsystems.ima.sap.messenger.defaultSAPDocType=SSSS

Defines the default SAP document type (“PDF”, “FAX”, ...). By default no document type is set.

com.tsystems.ima.sap.messenger.updateSAPDocTypeAttribute=BB

The property enables the update of the attribute holding the SAP document in case the SAP document type has been calculated, see SAP document data type calculation.

The default is false.

com.tsystems.ima.sap.messenger.workitem.numbercolumns=BB

Supported since ImageMaster 9.10.2.6:

By default each ImageMaster value of an ImageMaster multi-value attribute is assigned to a separate SAP column with an increasing number suffix in the SAP column name. For example, in case of an SAP column with the name “SAPCol” the associated column names will be “SAPCol1”, “SAPCol2”, “SAPCol3” etc.

By setting this parameter to “false”, all values of an ImageMaster multi-value attribute are mapped to the same SAP column.

com.tsystems.ima.erp.ilm.propagation.singleMode=BB

This system property controls if all documents of a folder are processed in the same task or if propagating legal hold and expiration date is done in a separate task for each document individually.

The default is false. For related recommendations see Troubleshooting - activemq/journal disk usage.

See chapter Configure ImageMaster in configureAppServer.config on how to set these.

org.apache.cxf.stax.maxTextLength

If large documents need to be processed by ImageMaster with the SOAP web services, make sure to increase the value of this property. The default value is 128m (128 megabyte). If the value is too low, an error can be encountered (see Large documents with SOAP).

Document files processed by the ImageMaster SOAP web services are temporarily encoded in Base64. This value represents the maximum size of such an internally Base64 encoded document. On average, the size of a Base64 encoded document is larger by ⅓ than the original file size. So make sure to consider this overhead, when you determine your threshold value for this parameter.

org.apache.cxf.io.CachedOutputStream.Threshold

This threshold represents the file size limit in bytes that triggers caching in the file system in order to reduce memory load. If binary data is transferred which exceeds this size, it will temporarily be written into the file system of the application server, i.e. for Unix based systems in the directory /tmp. The default is 64 kB.

Be aware that increasing this limit requires enough RAM. In particular the number of possible parallel requests which is determined by the HTTP pool size must be considered to calculate the maximum memory size that must be available for the application server.

org.apache.coyote.http11.DEFAULT_CONNECTION_TIMEOUT

This parameter can be used to set the default socket timeout for http connections. The default value of one minute (60000 milliseconds) may not be sufficient, e.g. if  the upload of large files must be handled in your environment.