Configuring Iconik Agent Configuring Iconik Agent
  1. Iconik
  2. Iconik Agent
  3. iconik Agent

Configuring Iconik Agent

iconik Agent

See all 11 articles

This sections explains what can be configured and how.

The Preferences window can be accessed from the iconik Agent application menu on macOS and from the File menu on Windows.

Download Preferences

Preferences

Default Download Location

Tap the folder icon to browse for and choose a location that the agent will use for downloads.

If you are running the Iconik Storage Gateway it is best to make sure that this is not located under a folder that the Iconik storage gateway is monitoring

Prompt for Location on Each Download

When enabled, you will be prompted for a download location each time a download is launched from the Iconik web. This will override any download location configured under Default Download Location.

Preserve Custom Collection Order

The Iconik Agent can be configured to preserve custom collection ordering that has been set for a collection in the Iconik web interface. When this option is turned on all file and directory names will get a numbered prefix added to the front of the name. This will allow you to use the normal sort by title functionality available in the system file browser to sort the items in a collection. If this option is turned off then no changes will be made to the name of the files and directories.

Upload Preferences

Calculate checksum on upload:

When this setting is enabled the Agent will calculate an md5 checksum of the file before starting the upload. This checksum will then be attached to the file in Iconik.

When a matching file is already in Iconik:

Controls what the Agent does with the checksum before upload. The options are:

  • Ignore match and continue with the file upload - The Agent will only store the checksum on the file entity in Iconik and continue with the upload.
  • Skip the file upload and use existing Asset - The Agent will check Iconik if a file already exists with the checksum for this file. If a file already exists it will skip the upload. If a collection has been targeted for the upload it will add the existing asset to that collection.
  • Skip the file upload and use existing Asset, only if uploading to the same storage - Similar to the setting above but when searching for existing asset files by checksum the Agent will only consider files that are on the same storage as the upload file was targeted for. If a file with the same checksum exists on another storage the upload will proceed and create a new asset.

ISG Preferences

ISG preferences

Configuring Local ISG Mount Points

For the Agent to be able to reveal files on a locally mounted ISG it needs to know where it is located on the local system. It will try to find this location automatically but in case it can’t you will need to configure it manually. In this case you should see the following dialog.

Configure ISG mount point

Please select the root of the ISG on the local system. This configuration can later be found in preferences under the ISG tab where it can also be changed.

Advanced Configuration

Some configuration options are currently only available by modifying the Agents settings file. This settings file can be found in the following locations:

  • macOS: ~/Library/Application Support/iconik Agent/config.json
  • Windows: %APPDATA%\iconik Agent\config.json

It can also be found by clicking the Show Config File… menu item under the Help menu. This will open a Finder or Explorer window with the configuration file selected.

Options

These are the options that can be configured:

Download settings

Settings related to downloads are contained in the downloadSettings section. The following options are controlled using the config file and can currently not be set in the UI.

  • numParallelDownloads: This key controls how many parallel downloads the Iconik Agent will attempt to run. This can be increased but keep in mind that the more parallel downloads the longer it will take for individual downloads to complete. The default value is 5

Upload settings

Settings related to uploads are contained in the uploadSettings section. These options are currently only available in the configuration file. Modifying these settings can lead to worse upload performance if set incorrectly and the defaults should work for most users. Note that increasing any of these values will lead to higher memory and CPU load.

  • numConcurrentUploads: Controls the number of concurrent file uploads that are run. The default value for this setting is 3
  • numConcurrentChunks: When uploading a file it is split into multiple parts that are uploaded concurrently. This settings controls how many parts are uploaded concurrently. If you are on a very fast connection increasing this value can lead to faster uploads. Default value is 5.
  • chunkSize: Controls the minimum size of each part that is uploaded in bytes. Note that this value can be overridden to a larger size by the Agent depending on the storage type and size of the file you are uploading. You should generally not have to change this value. If you are on a high latency connection though, increasing this value could lead to better speeds since there are less connects. Default value for this setting is 50MB.

Below is a sample configuration

"uploadSettings": { "chunkSize": 52428800, "numConcurrentChunks": 10, "numConcurrentUploads": 5 }

Other

  • Log level. The logLevel key controls what level of logs will be written to the log file. Available options are:
    • error
    • warn
    • info
    • debug
    • verbose

Next Steps

Learn more