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.

Configuration Properties

Property Type Description
AdminPassword String
EnableHostTerminal Boolean
EnableSwaggerUI Boolean
EnvironmentVariables Object array
SnapshotProvider Enumeration
SleepTime Integer
SnapshotTimeoutMinutes Integer
StopOnError Boolean
TableCheckOnStartup Boolean
Tables String array
TempStoragePath String
KafkaClientId String
KafkaConsumerGroup String
LogToFile Boolean
LogToHost Boolean
LogFilePath String
LogKeyValues Boolean
SystemLogging Boolean
VerboseLogging Boolean

Example Configuration

{
  "SQLAgent": {
    "AdminPassword": "p@ssw0rd",
    "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"
      }
    ],
    "SnapshotProvider": "RemoteS3",
    "SleepTime": 1,
    "SnapshotTimeoutMinutes": 60,
    "StopOnError": false,
    "TableCheckOnStartup": true,
    "Tables": [
      "DEPARTMENT",
      "EMPLOYEE"
    ],
    "TempStoragePath": "C:\\\\DEV\\\\SYNERGEX\\\\IntegrationPlatformData\\\\temp\\\\",
    "KafkaClientId": "DEFAULT_REPLICATOR1",
    "KafkaConsumerGroup": "DEFAULT_REPLICATOR",
    "LogToFile": true,
    "LogToHost": true,
    "LogFilePath": "C:\\\\DEV\\\\SYNERGEX\\\\IntegrationPlatform\\\\log\\\\",
    "LogKeyValues": false,
    "SystemLogging": false,
    "VerboseLogging": false
  }
}