General Properties

icat.url

The url of the machine hosting the icat service. It should normally just have the scheme, the hostname and the port. For example: https://example.com:443

plugin.zipMapper.class

The class name of the ZipMapper which defines the Zip file structure you want. The class must be deployed in the lib/applibs directory of your domain and must be packaged with all it dependencies.

plugin.main.class

The class name of the main storage plugin. The class must be deployed in the lib/applibs directory of your domain and must be packaged with all it dependencies.

plugin.main.properties

Optional property file for the main storage plugin.

cache.dir

The location (absolute or relative to the config directory of the domain) of a directory to hold mostly zip files.

preparedCacheSize1024bytes

The maximum size to allow for prepared zip files in the cache.

preparedCount

The maximum number of failed prepareData attempts to hold in memory.

processQueueIntervalSeconds

The frequency of checking the process queue. This is used both for cleaning old information from memory and for triggering movements between main and archive storage (if selected).

rootUserNames

A space separated list of users allowed to make the getServiceStatus call.

sizeCheckIntervalSeconds

How frequently to check the cache sizes and clean up if necessary.

readOnly

If true disables write operations (put and delete).

reader

space separated icat plugin name and credentials for a user permitted to read all datasets, datafiles, investigations and facilities. For example: db username db/root password password. This is only required if you are using archive storage or if you enable file checking by setting filesCheck.parallelCount to be greater than 0.

Properties for archive storage

plugin.archive.class

The class name of the archive storage plugin. The class must be deployed in the lib/applibs directory of your domain and must be packaged with all it dependencies.

plugin.archive.properties

Optional property file for the archive storage plugin.

datasetCacheSize1024bytes

The maximum size to allow for dataset zip files in the cache.

writeDelaySeconds

The amount of time to wait before writing to archive storage. This exists to allow enough time for all the datafiles to be added to a dataset before it is zipped and written.

compressDatasetCache

If true the dataset cache and the archive storage of datasets will all be compressed. This takes longer to write and is only useful if you know that the data will compress well.

tolerateWrongCompression

If true a get or prepareData which is for a single dataset will make use of the dataset cache even though it does not match the requested compression.

Properties for file checking

When a datafile is added to the IDS its length and checksum are computed and stored in ICAT. File checking, if enabled, cycles through all the stored data making sure that they can be read and that files have the expected size and checksum.

filesCheck.parallelCount

This must always be set, and if non zero then the readability of the data will be checked. The behaviour is dependent upon whether or not archive storage has a been requested. In the case of single level storage this is done in groups of files where the group size is defined by this parameter. If archive storage has been requested then only the archive is checked. Each file in the archive holds a complete dataset and this filesCheck.parallelCount parameter then defines how many dataset files will be checked in parallel.

In the case of checking datasets in the archive storage these are unzipped on the fly to compute the checksum of each file inside the zip file as well as its length.

If the archive storage has a long latency then it is useful to have a "large" value, however a thread is started for each stored file so the value of this parameter should not be too large.

filesCheck.gapSeconds

the number of seconds to wait before launching a check of the next batch of datafiles or datasets.

filesCheck.lastIdFile

the location of a file which is used to store the id value of the last datafile or dataset to be checked. This is so that if the IDS is restarted it will continue checking where it left off. If this file is deleted the ids will restart checking from the beginning. The parameters filesCheck.parallelCount and filesCheck.gapSeconds should be set so that the data are all checked with the desired frequency but without excessive I/O. A nagios plugin might check that this file is being written periodically and that its contents change.

filesCheck.errorLog

the file with a list of errors found. The file is not kept open but instead is opened in append mode each time a problem is spotted and then closed. A nagios plugin might be set up to watch this file. Entries in the file are data stamped and new entries are simply appended without regard for the existence of an entry for the same file.