Source Manager settings


The source manager settings define the general behavior of the source manager which synchronizes the original source images with the internal storage. The source manager settings are located in [CONFIG DIRECTORY]/sourcemanager.xml. This file is split into six main sections:

Application

The application section defines general settings for the source manager. By setting the enabled attribute to false the source manager can be disabled completely.


Storage
Descriptionlocation of internal storage
SyntaxString
Default 

Specifies the location of the internal storage. The given directory should exist and should be writable by the user running the application server. If a relative path is given it will be interpreted as being relative to the web applications PRIVATE folder. This setting should be identical to the storage setting in the request processor settings (see "Request processor settings")

MaxCPU
Descriptionnumber of threads for CPU tasks
SyntaxString
Defaultauto

The maximum number of threads running in parallel to use for CPU heavy internal tasks like scaling and encoding. "Auto" will determine the number of CPU threads available on the system.


MaxIO
Descriptionnumber of threads for IO tasks
SyntaxString
Defaultauto

The maximum number of threads running in parallel to use for I/O heavy tasks like reading image tiles from the disk.


MaxThreadsPerJob
Descriptionnumber of threads for single job
SyntaxString
Defaultauto

Defines the maximum number of threads that will be used for a single job.


ConversionThreads
Descriptionnumber of threads used for image conversion.
SyntaxString
Defaultauto

Defines the maximum number of threads that will be used for the image conversion.


ForceCPUThreads, ForcecIOThreads, ForceCPUtThreadsPerJob
Description 
SyntaxNumber
Default" "


MaxScaleMemratio
Description 
SyntaxFloat
Default0.75


Prefetch
Description 
SyntaxBoolean
Defaulttrue


PrefetchMaxSize
Description 
Syntax 
Default 


LogToStorage
Descriptiondefines if logs are written into strorage
SyntaxBoolean
Defaultfalse

Defines if the logs are written into the storage folder instead of the tomcat log folder.


Standalone
Descriptioncontrols FSI Administrator connection to FSI Server
SyntaxBoolean
Defaultfalse

Allows or disallows an FSI Administrator instance to connect to this FSI Server. Note that setting standalone to "false" and not connecting an FSI Administrator may be a security risk. Please refer to the FSI Administrator manual for a detailed description.


TempDirectory
Descriptionspecifies directory used to store temporary files
SyntaxString
Default"webapps/fsi/private/internal/temp"

Specifies the directory used to store temporary files. This will default to "webapps/fsi/private/internal/temp" if nothing is specified.


UserDP
Descriptionspecifies usage of user and group configurations
SyntaxString
Default"xmlfile"

Defines whether to use user and groups configurations from local XML files or from a (remote) LDAP Server. Possible values are "xmlfile" (default) and "ldap".

LDAP Settings

If the above configuration parameter "userdb" is set to LDAP, then the access to the LDAP server needs to be specified.

LPADURI
Descriptionspecifies location of LDAP server
SyntaxString
Default"ldap://localhost:389/"


LDAPUser, LDAPPassword
Descriptionspecify how to log in to the LDAP server
SyntaxString
Default" ", " "


LDAPBaseDN
Descriptionspecifies which base DN is used
SyntaxString
Default" "

Details on the required directory structure beneath the given base DN can be found in "LDAP Directory Structure".


UseKrb
Descriptiondefines if a Kerberos server is used
SyntaxBoolean
Defaultfalse

Defines whether to use an external Kerberos server for authentication instead of using the password hashes from local files or LDAP servers. When using Kerberos, the operating systems Kerberos client configuration needs to define the correct realm and KDC Location. Please see "Systemwide Kerberos configuration" for details on configuring your system as a Kerberos client.


KrbDebug
Descriptionenables or disables Kerberos debug
SyntaxBoolean
Defaultfalse

Enables or disables the debug of the external Kerberos server.


Jmx
Descriptionenables or disables JMX support
SyntaxBoolean
Defaultfalse

Enables or disables JMX support, which can be used for server monitoring with JMX MBeans. Read more about the definition of JMX MBeans.


Import
Descriptiondisables or enables the image import
SyntaxBoolean
Defaulttrue



HasHT
Descriptiondefines if hyperthreading is used
SyntaxBoolean
Defaulttrue

Defines if hyperthreading is used. If the processor does not support hyperthreading, set this parameter to "false" in order to ensure optimal performance.

Scanner

The scanner section controls the behavior of the scanning process, which monitors the input directories defined in the source connectors. Setting the scanner sections enabled attribute to false will disable the scanning process. New images placed in the file system will not be found and must therefore be uploaded using the webinterface or the OpenAPI.

Sorting
Descriptionenables sorting of a directory before processing
SyntaxBoolean
Defaulttrue

This specifies if the contents of a directory should be sorted before it is processed. Enabling sorting will help that new images in a folder will be imported in the correct order. Sorting the directory contents on every scan might have an impact on the servers performance, especially with large directories.


ConvertBefore1stScan
Descriptionenables immediate import of images
SyntaxBoolean
Defaultfalse

If set to true the FSI Server will start importing images immediately. If not, newly found images will be enqueued but not imported before the first full scan after a restart of the server has been completed.


FileScanDelay
Description 
SyntaxNumber
Default1


UseMagicBytes
Description 
SyntaxBoolean
Defaultfalse




The search section defines where to find the external Solr server. These should match the settings of the request processor component as described in the corresponding section.

SolServerURI
Descriptiondefines the location of the Solr server
SyntaxString
Default"http://localhost/solr"

Defines the URI specifying where to find the Solr server. The default is "http://localhost/solr".


Core
Descriptiondefines the Solr core used
SyntaxString
Default"fsi-server"

Specifies the Solr core to use. Defaults to "fsi-server".


Authentication
Descriptiondefines if Solr requires authentication
SyntaxBoolean
Defaultfales

Specifies whether the Solr server requires authentication. The default is "false".


AuthenticationType
Descriptiondefines the authentication type
SyntaxString
Default"basic"

Defines the authentication type. Only applies if authentication is enabled. The default type is "basic".


AuthenticationUsername, AuthenticationPassword
Descriptiondefine the login credentials
SyntaxString
Default" ", " "

Define the authentication login credentials. Only apply if authentication is enabled. User name and password have no defaults and must be specified.


Proxy
Descriptionspecifies proxy use
SyntaxBoolean
Defaultfalse

Specifies whether or not to use a proxy to connect to the Solr server. The default is "false".


ProxyHostname
Descriptiondefines the proxy hostname
SyntaxString
Default" "

Defines the proxy hostname. Only applies if proxy is enabled.


ProxyPort
Descriptiondefines the proxy port
SyntaxNumber
Default80

Defines which proxy port is used. The default is 80. Only applies if proxy is enabled.


ProxySSL
Descriptiondefines if SSL is activated
SyntaxBoolean
Defaultfalse

Defines if the SSL protocol is used for proxy connection. Only applies if proxy is enabled.


ProxyAuthentication
Descriptiondefines if authentication is used
SyntaxBoolean
Defaultfales

Defines if proxy authentication is enabled. Only applies if proxy is enabled.


ProxyUsername, ProxyPassword
Descriptiondefines log in credentials
SyntaxString
Default" ", " "

Define the proxy log in credentials. Only apply if proxy authentication is used. Username and password have no details and need to be specified.


ConnectionPoolMax
Descriptionmax. number of connections to Solr
SyntaxNumber
Default500

Defines the maximum number of connections to the Solr server. The default is "500".

ColorManagementSystem

The colormanagement section defines the settings for the colormanagement used when importing images. Disabling this section will disable the colormanagement systems and no color profiles will be used when importing images.

DefaultCMYKProfile, DefaultRGBProfile, DefaultGrayProfile
Descriptiondefines the default color profiles
SyntaxString
Default"auto"

These settings define the default profiles to be used when importing images that do not contain color profiles. "Auto" will evaluate to an internal profile. Other valid values would be complete paths to valid color profile files.


FallBackICCConversion
Description 
SyntaxBoolean
Defaulttrue




Cache

The cache section defines the cache settings.

MaxMemory
Descriptionmax. amount of memory to be used
SyntaxString
Default"auto"

The maximum amount of memory to be used by for the memory cache. The value is assumed to be given in bytes unless followed by one of the common abbreviations (KB, MB, GB etc).


DirectMemory
Descriptiondefines if direct memory or heap space is used
SyntaxBoolean
Defaultfalse

Specified whether to use direct memory or heap space to store the cache. The default is "false".


L1, L2
Description 
SyntaxBoolean
Defaulttrue, true


L1Size
Description 
SyntaxNumber
Default1000


PackASync
Description 
SyntaxBoolean
Defaulttrue


WriteCacheDir
Description 
SyntaxString
Default" "


MaxThreads
Descriptionmax number if threads used simultaneously
SyntaxString
Default"auto"

Specifies how many threads usually access the cache simultaneously. This helps optimizing the caches internal organization and therefore can improve performance. Set to "auto" if uncertain.

Formats

The formats section contains a list for <format> nodes containing file types that should be imported. Other files will be ignored.

Protected files

The protected files section contains a list of <file> nodes containing names of files that should be skipped while scanning.