Skip to content

SQL Agent Configuration

If you'll be using the SQL Agent, it must be configured using the SQLAgent property in MasterConfig.json.

SQL Agent Configuration
{
  "SQLAgent": {
    "EnableHostTerminal": true,
    "EnableSwaggerUI": true,
    "EnvironmentVariables": [
      {
        "Name": "SIP_DAT",
        "Value": "C:\DEV\SYNERGEX\IntegrationPlatform\dat\"
      },
      {
        "Name": "SIP_EXPORT",
        "Value": "C:\DEV\SYNERGEX\IntegrationPlatform\dat\"
      },
      {
        "Name": "SIP_HOOKS_LOGLEVEL",
        "Value": "1"
      }
    ],
    "HelperAssembly": "C:\SOME\PATH\SQLTableHelpers.dll",
    "SnapshotProvider": "RemoteS3",
    "SleepTime": 1,
    "SnapshotTimeoutMinutes": 60,
    "StopOnError": false,
    "TableCheckOnStartup": true,
    "TempStoragePath": "C:\SOME\PATH\temp",
    "KafkaClientId": "DEFAULT_REPLICATOR1",
    "KafkaConsumerGroup": "DEFAULT_REPLICATOR",
    "LogToFile": true,
    "LogToHost": true,
    "LogFilePath": "C:\SOME\PATH\log",
    "LogKeyValues": false,
    "SystemLogging": false,
    "VerboseLogging": false
  }
}

Configuration Properties

Property Type Description
EnableHostTerminal Boolean Within the admin UI, should the host terminal option be available?
EnableSwaggerUI Boolean Should the agent expose API information via SwaggerUI?
EnvironmentVariables Object array An array of environment variables to set in the agent environment.
SnapshotProvider Enumeration The type of the Snapshot storage provider (RemoteS3 or LocalS3).
SleepTime Integer If the agent runs out of work (changes to process) the number of seconds to wait before checking for new changes.
SnapshotTimeoutMinutes Integer The maximum number of minutes to wait for a requested snapshot to become available.
StopOnError Boolean Should the agent stop processing if an error is encountered? Not stopping results in an out-of-sync database.
TableCheckOnStartup Boolean Should the agent check for and attempt to load missing database tables during startup?
TempStoragePath String The full path where the agent should store temporary files.
KafkaClientId String The client ID to use when subscribing to Kafka.
KafkaConsumerGroup String The consumer group to use when subscribing to Kafka.
LogToFile Boolean Should the agent log messages to a log file?
LogToHost Boolean Should the agent log messages to that ASP.NET application log?
LogFilePath String If file logging is enabled, the full path where the agent should create log files.
LogKeyValues Boolean Should the agent log key values when processing changes? CAUTION: Only use this for development/debugging.
SystemLogging Boolean Should the agent log messages to the system log (Windows event log/Linux syslog)?
VerboseLogging Boolean Should verbose logging be enabled? CAUTION: Only use this for development/debugging.