Signiant Support

Signiant App configuration file Print


To configure the Signiant App, edit SigniantClient.json.

You can find your configuration file in the Signiant directory on Windows, or in your /Library/:
  • Windows: %APPDATA%\Signiant\SigniantClient.json
  • Mac: ~/Library/Preferences/com.signiant.SigniantClient.json    
The default SigniantClient.json file has the following configuration:

{
   "api-port" : 10001,
   "automatic-exclusion-list" : [],
   "log-level" : "info",
   "rest-call-timeout" : 30,
   "rest-server" : "mediashuttle.com",
   "update-checked" : "2017-07-21 17:11:44",
   "update-url" : "updates.signiant.com"
}

 
Edit the following parameters:

api-port
  • The port used by the Signiant App for internal communication between: SigniantUser and SigniantClient.
  • Edit this parameter if the default port (10001) is already in use by another application. When the default port is already in use, Signiant App components aren't able to communicate. 
automatic-exclusion-list
  • A list of filenames that the Signiant App Auto-Delivery ignores. The Signiant App ignores these system files: Thumbs.db and.DS_Store.
  • The exclusion list is in the following format: ["file1.txt","skipfile2.data"]
log-level
  • Sets the level of detail to log using the three Signiant App component processes: SigniantUser, SigniantClient, and SigniantApp.
  • The log level choices are, in order of increasing detail:info, debug, trace.
  • The log level values are not case sensitive.
log-level-overrides
  • Used to fine-tune the specific methods to log. This is different from the general log level definition set by the log-level parameter.
  • Use this parameter when you want to increase the level of detail while investigating an issue and you know that another method(s) is not involved in the issue to reduce code noise. For example, the Transfer method outputs a large amount log messages at debug level. In the example below, the user has set the log-level to debug, but set the override for the Transfer method to info to suppress, and override the SubscriptionStateObserver category to trace.
record-transfer-events
  • Saves a log of performance statistics to a local text file (txt format) named for the transfer's transferId property. Once created, the log saves to the application's /perf folder:
    • MacOS: ~/Library/Application Support/Signiant/perf
    • Windows: %APPDATA%\Signiant\perf
  • Tracks time-stamped events for each transfer, for interactive and automatic delivery.
  • Use a value to configure the log file:
    • "off" - Transfer events are not logged. (Default Value)
    • "info" - Transfer events log their status and their start progress events.
    • "trace" -Transfer events log their status events and all progress events.
save-manifest
  • This optional parameter tells the Signiant App to save a copy of every transfer manifest file. When enabled, manifest files save to the application's /Manifest folder, named after the transfer's transferId property:
    • MacOS: ~/Application Support/Signiant/Manifest
    • Windows: %APPDATA%\Signiant\Manifest
  • The manifest contains details such as file name and path, size, date (in epoch time format), and whether the file transfer was successful or skipped.
  • Valid values are: "true" or "false".
unique-id
  • This optional parameter defines an extra key to identify a machine as unique in special cases, such as 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 Auto-delivery configuration is unique.
update-checked
  • This value is the date on which the Signiant App last checked to see if an update to the Signiant App was available online. The Signiant App periodically checks for Signiant App updates, and uses this value to determine whether it's time to run an 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 after this date has passed.
  • To postpone updates indefinitely, specify a date far in the future, such as 2035.
  • The date is a text string in the format: "2017-07-21 17:11:44".
update-url
  • This value 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 scenario, change the value to: "beta.signiant.com".

Note: Parameter names are case-sensitive.

The following is an example of an edited SigniantClient.json file:

{
   "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"
}

 

Important Note

The configuration file contains all the parameters in a defined format called JSON. If the Signiant App reads the configuration file and the file is not in the proper JSON format, the Signiant App discards the configuration file and replaces it with a new configuration file in the proper format. For example, a missing comma or bracket will return an "invalid JSON" error and replace it with default values. 
 
When making changes to the configuration file, we recommend making a copy of the modified configuration file. This copy ensures that if you do make an error, you won't lose your work when you replace the invalid file with a properly formatted default file.