Configuring the Signiant App

You can configure the Signiant App by editing parameters in the SigniantClient.json file.

The location of the SigniantClient.json file varies depending on your operating system:

macOS: ~/Library/Preferences/com.signiant.SigniantClient.json
Windows: %APPDATA%\Signiant\SigniantClient.json

When making changes to the Signiant App configuration, it is recommended that you make a copy of your modified file. If you make an error, you can then return to the backup copy, fix any errors, and replace the invalid .json file with one that is correctly formatted. Otherwise, if the Signiant App discards your modified configuration file, you will have to begin your changes again from the default values.

Parameters

Note: Parameter names are case-sensitive.

api-port
Sets the port used by the Signiant App for internal communication between SigniantUser and SigniantClient. If the default port (10001) is already in use by another application, edit the parameter to allow Signiant App components to communicate.

automatic-exclusion-list
Identifies filenames that the Media Shuttle Auto Delivery feature ignores. By default, the Signiant App ignores Thumbs.db and .DS_Store system files. The exclusion list follows a ["file1.txt","skipfile2.data"] format.

log-level
Sets the level of log detail using the Signiant App component processes (SigniantUser, SigniantClient, and SigniantApp). The log level increases in detail from info(default) to debug to trace. Increasing the log level can negatively impact performance.

log-level-overrides
Fine tunes the logging method. This value is different from the general log level set by the log-level parameter. Edit this setting when you want to increase the level of detail while investigating an issue, and when you know that another method is not involved in the issue to reduce code noise.

Example: The Transfer method outputs a large number of log messages in debug mode. If the log-level parameter is set to debug, you can set the override for the Transfer method to info to suppress, and override the SubscriptionStateObserver category to trace.

{  
   "api-port" : 10001,  
   "automatic-exclusion-list" : [],  
   "log-level" : "debug",  
   "log-level-overrides" : [  
      { 
         "category" : "Transfer",  
         "level" : "info"  
      },  
      {  
         "category" : "SubscriptionStateObserver",  
         "level" : "trace"
      }  
   ],  
   "rest-call-timeout" : 30,
   "rest-server" : "mediashuttle.com",  
   "save-manifest" : "true",  
   "unique-id" : "a1b2c3",  
   "update-checked" : "2017-07-24 17:11:44",  
   "update-url" : "updates.signiant.com"
}

record-transfer-events
Saves a log of performance statistics to a local txt file. The txt file name includes the transferId. The log tracks time-stamped events for each user-initiated and automatically-generated transfer.

off - Transfer events are not logged (default)
info - Transfer events log their status and their start progress events
trace - Transfer events log their status events and all progress events

The log saves to the application's perf folder:

macOS: ~/Library/Application Support/Signiant/perf
Windows: %APPDATA%\Signiant\perf

save-manifest
Tells the Signiant App to save a copy of every transfer manifest file. The manifest contains details such as filename and path, size, date (in epoch time format). The manifest also indicates whether the file transfer was successful or skipped. This parameter can be set to true or false.

Manifest files save to the Manifest folder, which is named for the transfer's transferId property:

macOS: ~/Application Support/Signiant/Manifest
Windows: %APPDATA%\Signiant\Manifest

unique-id
Defines an extra key to identify a machine as unique in special cases, such as when cloning a machine from another. The usual method to identify each machine for saving its Auto Delivery configuration may generate the same identifier for both machines. You can set this parameter to any text string, which will append to the usual identifier to ensure each machine's Auto Delivery configuration is unique.

update-checked
Sets the date on which the Signiant App last checked for an update. This date is determines the timing of the next update check. To postpone the update check date, set this parameter to a future date. The Signiant App will not check for updates again until the date has passed. To postpone updates indefinitely, specify a date far in the future. The date is a text string in the format 2017-07-21 17:11:44.

update-url
Identifies where the Signiant App looks for updated versions of the Signiant App. The default value is updates.signiant.com. You may want to change this value if, for example, you want a pre-release version of the Signiant App from the beta program. In this case, change the value to beta.signiant.com.

Invalid JSON Error

If there are formatting errors in your edited configuration file, an invalid JSON error will be returned. The Signiant App will discard your modified configuration file and replace it with a default configuration file in the proper format.