Root Schema : Oracle GoldenGate Task
Type: object
Title: Oracle GoldenGate Task
Show Source
{
"title":"Oracle GoldenGate Task",
"type":"object",
"properties":{
"maxHistory":{
"description":"Number of task executions to maintain history for",
"type":"integer",
"minimum":1,
"default":10,
"maximum":1024
},
"command":{
"x-oneOf":[
{
"description":"Start an Extract or Replicat",
"type":"object",
"properties":{
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"after":{
"description":"Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
},
"threads":{
"description":"Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.",
"type":"array",
"items":{
"type":"integer",
"minimum":1,
"maximum":500
},
"minItems":1,
"maxItems":500
},
"resetBoundedRecovery":{
"description":"Reset Bounded Recovery and use normal recovery instead",
"type":"boolean",
"default":false
},
"name":{
"enum":[
"start"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"$schema":{
"enum":[
"ogg:command"
]
},
"skipTransaction":{
"description":"Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded.",
"type":"boolean",
"default":false
},
"filterDuplicates":{
"description":"Causes Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (using the ATCSN or AFTERCSN) and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. Integrated mode handles duplicate transactions transparently. The default is true.",
"type":"boolean",
"default":true
},
"at":{
"description":"Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
}
},
"additionalProperties":false,
"allOf":[
{
"required":[
"name",
"processName"
]
},
{
"not":{
"required":[
"at",
"after"
]
}
},
{
"not":{
"required":[
"at",
"skipTransaction"
]
}
},
{
"not":{
"required":[
"after",
"skipTransaction"
]
}
},
{
"dependencies":{
"filterDuplicates":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
},
"threads":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
}
}
},
{
"x-anyOf":[
{
"dependencies":{
"threads":[
"at"
]
}
},
{
"dependencies":{
"threads":[
"after"
]
}
},
{
"dependencies":{
"threads":[
"skipTransaction"
]
}
}
]
}
]
},
{
"description":"Stop an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"stop"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"force":{
"type":"boolean",
"default":false
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Kill an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"kill"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Execute an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"execute"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Synchronize a Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"synchronize"
]
},
"processType":{
"enum":[
"replicat"
]
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Execute the Monitor Agent",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"execute"
]
},
"processName":{
"enum":[
"Monitor Agent"
]
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Report on Processes",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"up",
"down"
]
}
},
"required":[
"name",
"reportType"
],
"additionalProperties":false
},
{
"description":"Report on Process Lag",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"lag"
]
},
"thresholds":{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"info",
"critical"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"seconds"
]
},
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":65535
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2
}
},
"required":[
"name",
"reportType",
"thresholds"
],
"additionalProperties":false
},
{
"description":"Report Operating System and database version information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"versions"
]
},
"credentials":{
"description":"Credentials for database",
"default":null,
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
{
"type":"null"
}
]
}
},
"required":[
"name",
"reportType"
],
"additionalProperties":false
},
{
"description":"Lists the schemas in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"schemas"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"qualified":{
"description":"If true, returned schema names are fully qualified",
"type":"boolean",
"default":true
},
"specification":{
"description":"The name of a schema which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
}
]
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Lists the tables in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"tables"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"qualified":{
"description":"If true, returned table names are fully qualified",
"type":"boolean",
"default":true
},
"specification":{
"description":"The name of a table or a group of tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"tableType":{
"description":"The type of table to list",
"enum":[
"any",
"auto_capture",
"checkpoint",
"trace"
],
"default":"any"
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Lists the checkpoint tables in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"checkpointTables"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"specification":{
"description":"The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Lists the containers in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"containers"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"specification":{
"description":"The name of a container or a group of containers which can include wildcard characters",
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Purge checkpoint history for ER processes",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"checkpoints"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"keep":{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"checkpoints"
]
}
]
},
"value":{
"type":"integer",
"minimum":1,
"maximum":500
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"processName",
"keep"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"ddlHistory",
"ddlHistoryAlt",
"markerHistory"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2
}
},
"required":[
"name",
"purgeType",
"credentials",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge trail files no longer needed",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"trails"
]
},
"trails":{
"description":"Trails to purge",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the trail, wildcards allowed",
"type":"string",
"pattern":"^[A-Za-z*][A-Za-z0-9*]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":1,
"maxLength":4096
}
},
"required":[
"name"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
},
"useCheckpoints":{
"type":"boolean",
"default":true
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of files",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"files"
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":100
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"trails",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge Extract or Replicat tasks",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"tasks"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"useStatus":{
"type":"boolean",
"default":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"processName",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge files no longer needed",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"files"
]
},
"dumpFiles":{
"description":"Purge dump files (*.dmp) which are generated when an application abnormally terminates",
"type":"boolean",
"default":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge change data - currently only implemented for SQL Server",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"changeData"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"credentials",
"keep"
],
"additionalProperties":false
},
{
"description":"Updates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"flushSequence"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"sequence":{
"description":"The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"trace":{
"description":"Whether to call the sql procedure to update the sequence with tracing mode on",
"type":"boolean",
"default":false
}
},
"required":[
"name",
"credentials",
"sequence"
],
"additionalProperties":false
}
]
},
"enabled":{
"description":"Indicates if the task is enabled for execution",
"type":"boolean",
"default":true
},
"schedule":{
"x-oneOf":[
{
"description":"Task is not scheduled",
"enum":[
"none"
]
},
{
"description":"Task is run on a time-based schedule",
"type":"object",
"properties":{
"days":{
"description":"Days of the week to run the task",
"x-oneOf":[
{
"enum":[
"every"
]
},
{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
{
"type":"array",
"items":{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"minItems":1,
"maxItems":7
}
]
},
"times":{
"description":"Array of times to run task in 24 hour format HH:MM",
"type":"array",
"items":{
"type":"string",
"pattern":"([01][0-9]|2[0-3]):[0-5][0-9]",
"minLength":5,
"maxLength":5
},
"minItems":1,
"maxItems":1440
}
},
"required":[
"days",
"times"
],
"additionalProperties":false
},
{
"description":"Task is run on an interval",
"type":"object",
"properties":{
"every":{
"type":"object",
"properties":{
"units":{
"x-oneOf":[
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
},
{
"enum":[
"days"
]
},
{
"enum":[
"weeks"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":1024
}
},
"required":[
"units",
"value"
],
"additionalProperties":false
}
},
"required":[
"every"
],
"additionalProperties":false
},
{
"description":"Task is run when the Admin Server starts",
"type":"object",
"properties":{
"autoStart":{
"description":"Indicates task starts with Admin Server",
"enum":[
true
]
},
"delay":{
"description":"Time to wait in seconds before starting task",
"type":"integer",
"minimum":0,
"default":0,
"maximum":3600
}
},
"required":[
"autoStart"
],
"additionalProperties":false
}
]
},
"$schema":{
"enum":[
"ogg:task"
]
},
"status":{
"description":"Task Status",
"default":"stopped",
"enum":[
"starting",
"running",
"stopped",
"killed",
"abended"
]
},
"timeout":{
"description":"Amount of time in seconds before a running task is cancelled",
"type":"integer",
"minimum":1,
"maximum":65535
},
"critical":{
"description":"Indicates the task is critical to the deployment",
"type":"boolean",
"default":false
},
"restart":{
"description":"Control how the task is restarted if it terminates",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:taskRestart"
]
},
"enabled":{
"description":"If set, the task can be restarted if it terminates.",
"type":"boolean",
"default":false
},
"onSuccess":{
"description":"If false, the task is only restarted if it fails.",
"type":"boolean",
"default":false
},
"delay":{
"description":"The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process.",
"type":"integer",
"minimum":0,
"default":120,
"maximum":3600
},
"retries":{
"description":"The maximum number of times the task should be restarted before aborting retry efforts.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":3600
},
"window":{
"description":"The window of time, in seconds, during which retries are counted.",
"type":"integer",
"minimum":0,
"default":7200,
"maximum":604800
},
"disableOnFailure":{
"description":"If true, the task is disabled when it fails all execution attempts in an execution window.",
"type":"boolean",
"default":false
},
"failures":{
"description":"The number of times the task failed in the current window.",
"type":"integer",
"minimum":0,
"maximum":3600
}
},
"additionalProperties":false
},
"description":{
"description":"A description of the task",
"type":"string",
"minLength":1,
"maxLength":4095
}
},
"additionalProperties":false
}
Nested Schema : command
Match One
Show Source
{
"x-oneOf":[
{
"description":"Start an Extract or Replicat",
"type":"object",
"properties":{
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"after":{
"description":"Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
},
"threads":{
"description":"Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.",
"type":"array",
"items":{
"type":"integer",
"minimum":1,
"maximum":500
},
"minItems":1,
"maxItems":500
},
"resetBoundedRecovery":{
"description":"Reset Bounded Recovery and use normal recovery instead",
"type":"boolean",
"default":false
},
"name":{
"enum":[
"start"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"$schema":{
"enum":[
"ogg:command"
]
},
"skipTransaction":{
"description":"Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded.",
"type":"boolean",
"default":false
},
"filterDuplicates":{
"description":"Causes Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (using the ATCSN or AFTERCSN) and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. Integrated mode handles duplicate transactions transparently. The default is true.",
"type":"boolean",
"default":true
},
"at":{
"description":"Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
}
},
"additionalProperties":false,
"allOf":[
{
"required":[
"name",
"processName"
]
},
{
"not":{
"required":[
"at",
"after"
]
}
},
{
"not":{
"required":[
"at",
"skipTransaction"
]
}
},
{
"not":{
"required":[
"after",
"skipTransaction"
]
}
},
{
"dependencies":{
"filterDuplicates":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
},
"threads":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
}
}
},
{
"x-anyOf":[
{
"dependencies":{
"threads":[
"at"
]
}
},
{
"dependencies":{
"threads":[
"after"
]
}
},
{
"dependencies":{
"threads":[
"skipTransaction"
]
}
}
]
}
]
},
{
"description":"Stop an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"stop"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"force":{
"type":"boolean",
"default":false
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Kill an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"kill"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Execute an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"execute"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Synchronize a Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"synchronize"
]
},
"processType":{
"enum":[
"replicat"
]
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Execute the Monitor Agent",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"execute"
]
},
"processName":{
"enum":[
"Monitor Agent"
]
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
},
{
"description":"Report on Processes",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"up",
"down"
]
}
},
"required":[
"name",
"reportType"
],
"additionalProperties":false
},
{
"description":"Report on Process Lag",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"lag"
]
},
"thresholds":{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"info",
"critical"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"seconds"
]
},
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":65535
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2
}
},
"required":[
"name",
"reportType",
"thresholds"
],
"additionalProperties":false
},
{
"description":"Report Operating System and database version information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"versions"
]
},
"credentials":{
"description":"Credentials for database",
"default":null,
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
{
"type":"null"
}
]
}
},
"required":[
"name",
"reportType"
],
"additionalProperties":false
},
{
"description":"Lists the schemas in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"schemas"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"qualified":{
"description":"If true, returned schema names are fully qualified",
"type":"boolean",
"default":true
},
"specification":{
"description":"The name of a schema which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
}
]
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Lists the tables in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"tables"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"qualified":{
"description":"If true, returned table names are fully qualified",
"type":"boolean",
"default":true
},
"specification":{
"description":"The name of a table or a group of tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"tableType":{
"description":"The type of table to list",
"enum":[
"any",
"auto_capture",
"checkpoint",
"trace"
],
"default":"any"
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Lists the checkpoint tables in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"checkpointTables"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"specification":{
"description":"The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Lists the containers in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"containers"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"specification":{
"description":"The name of a container or a group of containers which can include wildcard characters",
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
},
{
"description":"Purge checkpoint history for ER processes",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"checkpoints"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"keep":{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"checkpoints"
]
}
]
},
"value":{
"type":"integer",
"minimum":1,
"maximum":500
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"processName",
"keep"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"ddlHistory",
"ddlHistoryAlt",
"markerHistory"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2
}
},
"required":[
"name",
"purgeType",
"credentials",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge trail files no longer needed",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"trails"
]
},
"trails":{
"description":"Trails to purge",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the trail, wildcards allowed",
"type":"string",
"pattern":"^[A-Za-z*][A-Za-z0-9*]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":1,
"maxLength":4096
}
},
"required":[
"name"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
},
"useCheckpoints":{
"type":"boolean",
"default":true
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of files",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"files"
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":100
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"trails",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge Extract or Replicat tasks",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"tasks"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"useStatus":{
"type":"boolean",
"default":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"processName",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge files no longer needed",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"files"
]
},
"dumpFiles":{
"description":"Purge dump files (*.dmp) which are generated when an application abnormally terminates",
"type":"boolean",
"default":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"keep"
],
"additionalProperties":false
},
{
"description":"Purge change data - currently only implemented for SQL Server",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"changeData"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"credentials",
"keep"
],
"additionalProperties":false
},
{
"description":"Updates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"flushSequence"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"sequence":{
"description":"The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"trace":{
"description":"Whether to call the sql procedure to update the sequence with tracing mode on",
"type":"boolean",
"default":false
}
},
"required":[
"name",
"credentials",
"sequence"
],
"additionalProperties":false
}
]
}
Nested Schema : restart
Type: object
Control how the task is restarted if it terminates
Show Source
-
$schema(optional):
Allowed Values: [
"ogg:taskRestart"
]
-
delay(optional):
integer
Minimum Value: 0
Maximum Value: 3600
Default Value: 120
The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process.
-
disableOnFailure(optional):
boolean
Default Value: false
If true, the task is disabled when it fails all execution attempts in an execution window.
-
enabled(optional):
boolean
Default Value: false
If set, the task can be restarted if it terminates.
-
failures(optional):
integer
Minimum Value: 0
Maximum Value: 3600
The number of times the task failed in the current window.
-
onSuccess(optional):
boolean
Default Value: false
If false, the task is only restarted if it fails.
-
retries(optional):
integer
Minimum Value: 0
Maximum Value: 3600
Default Value: 2
The maximum number of times the task should be restarted before aborting retry efforts.
-
window(optional):
integer
Minimum Value: 0
Maximum Value: 604800
Default Value: 7200
The window of time, in seconds, during which retries are counted.
{
"description":"Control how the task is restarted if it terminates",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:taskRestart"
]
},
"enabled":{
"description":"If set, the task can be restarted if it terminates.",
"type":"boolean",
"default":false
},
"onSuccess":{
"description":"If false, the task is only restarted if it fails.",
"type":"boolean",
"default":false
},
"delay":{
"description":"The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process.",
"type":"integer",
"minimum":0,
"default":120,
"maximum":3600
},
"retries":{
"description":"The maximum number of times the task should be restarted before aborting retry efforts.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":3600
},
"window":{
"description":"The window of time, in seconds, during which retries are counted.",
"type":"integer",
"minimum":0,
"default":7200,
"maximum":604800
},
"disableOnFailure":{
"description":"If true, the task is disabled when it fails all execution attempts in an execution window.",
"type":"boolean",
"default":false
},
"failures":{
"description":"The number of times the task failed in the current window.",
"type":"integer",
"minimum":0,
"maximum":3600
}
},
"additionalProperties":false
}
Nested Schema : schedule
Match One
Show Source
{
"x-oneOf":[
{
"description":"Task is not scheduled",
"enum":[
"none"
]
},
{
"description":"Task is run on a time-based schedule",
"type":"object",
"properties":{
"days":{
"description":"Days of the week to run the task",
"x-oneOf":[
{
"enum":[
"every"
]
},
{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
{
"type":"array",
"items":{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"minItems":1,
"maxItems":7
}
]
},
"times":{
"description":"Array of times to run task in 24 hour format HH:MM",
"type":"array",
"items":{
"type":"string",
"pattern":"([01][0-9]|2[0-3]):[0-5][0-9]",
"minLength":5,
"maxLength":5
},
"minItems":1,
"maxItems":1440
}
},
"required":[
"days",
"times"
],
"additionalProperties":false
},
{
"description":"Task is run on an interval",
"type":"object",
"properties":{
"every":{
"type":"object",
"properties":{
"units":{
"x-oneOf":[
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
},
{
"enum":[
"days"
]
},
{
"enum":[
"weeks"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":1024
}
},
"required":[
"units",
"value"
],
"additionalProperties":false
}
},
"required":[
"every"
],
"additionalProperties":false
},
{
"description":"Task is run when the Admin Server starts",
"type":"object",
"properties":{
"autoStart":{
"description":"Indicates task starts with Admin Server",
"enum":[
true
]
},
"delay":{
"description":"Time to wait in seconds before starting task",
"type":"integer",
"minimum":0,
"default":0,
"maximum":3600
}
},
"required":[
"autoStart"
],
"additionalProperties":false
}
]
}
Nested Schema : command-x-oneOf[0]
Type: object
Start an Extract or Replicat
Show Source
-
$schema(optional):
Allowed Values: [
"ogg:command"
]
-
after(optional):
after
Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.
-
at(optional):
at
Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.
-
filterDuplicates(optional):
boolean
Default Value: true
Causes Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (using the ATCSN or AFTERCSN) and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. Integrated mode handles duplicate transactions transparently. The default is true.
-
name(optional):
Allowed Values: [
"start"
]
-
processName(optional):
string
Minimum Length: 1
Maximum Length: 8
Pattern: ^[*A-Z_$][*A-Z0-9_$]*$
-
processType(optional):
Default Value: ER
Allowed Values: [
"extract",
"replicat",
"ER"
]
-
resetBoundedRecovery(optional):
boolean
Default Value: false
Reset Bounded Recovery and use normal recovery instead
-
skipTransaction(optional):
boolean
Default Value: false
Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded.
-
threads(optional):
array threads
Minimum Number of Items: 1
Maximum Number of Items: 500
Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.
{
"description":"Start an Extract or Replicat",
"type":"object",
"properties":{
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"after":{
"description":"Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
},
"threads":{
"description":"Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.",
"type":"array",
"items":{
"type":"integer",
"minimum":1,
"maximum":500
},
"minItems":1,
"maxItems":500
},
"resetBoundedRecovery":{
"description":"Reset Bounded Recovery and use normal recovery instead",
"type":"boolean",
"default":false
},
"name":{
"enum":[
"start"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"$schema":{
"enum":[
"ogg:command"
]
},
"skipTransaction":{
"description":"Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded.",
"type":"boolean",
"default":false
},
"filterDuplicates":{
"description":"Causes Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (using the ATCSN or AFTERCSN) and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. Integrated mode handles duplicate transactions transparently. The default is true.",
"type":"boolean",
"default":true
},
"at":{
"description":"Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
}
},
"additionalProperties":false,
"allOf":[
{
"required":[
"name",
"processName"
]
},
{
"not":{
"required":[
"at",
"after"
]
}
},
{
"not":{
"required":[
"at",
"skipTransaction"
]
}
},
{
"not":{
"required":[
"after",
"skipTransaction"
]
}
},
{
"dependencies":{
"filterDuplicates":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
},
"threads":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
}
}
},
{
"x-anyOf":[
{
"dependencies":{
"threads":[
"at"
]
}
},
{
"dependencies":{
"threads":[
"after"
]
}
},
{
"dependencies":{
"threads":[
"skipTransaction"
]
}
}
]
}
]
}
Match All
Show Source
{
"description":"Start an Extract or Replicat",
"type":"object",
"properties":{
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"after":{
"description":"Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
},
"threads":{
"description":"Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.",
"type":"array",
"items":{
"type":"integer",
"minimum":1,
"maximum":500
},
"minItems":1,
"maxItems":500
},
"resetBoundedRecovery":{
"description":"Reset Bounded Recovery and use normal recovery instead",
"type":"boolean",
"default":false
},
"name":{
"enum":[
"start"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"$schema":{
"enum":[
"ogg:command"
]
},
"skipTransaction":{
"description":"Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded.",
"type":"boolean",
"default":false
},
"filterDuplicates":{
"description":"Causes Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (using the ATCSN or AFTERCSN) and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. Integrated mode handles duplicate transactions transparently. The default is true.",
"type":"boolean",
"default":true
},
"at":{
"description":"Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
}
},
"additionalProperties":false,
"allOf":[
{
"required":[
"name",
"processName"
]
},
{
"not":{
"required":[
"at",
"after"
]
}
},
{
"not":{
"required":[
"at",
"skipTransaction"
]
}
},
{
"not":{
"required":[
"after",
"skipTransaction"
]
}
},
{
"dependencies":{
"filterDuplicates":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
},
"threads":{
"properties":{
"processType":{
"enum":[
"replicat",
"ER"
]
}
}
}
}
},
{
"x-anyOf":[
{
"dependencies":{
"threads":[
"at"
]
}
},
{
"dependencies":{
"threads":[
"after"
]
}
},
{
"dependencies":{
"threads":[
"skipTransaction"
]
}
}
]
}
]
}
Nested Schema : command-x-oneOf[1]
Type: object
Stop an Extract or Replicat
Show Source
{
"description":"Stop an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"stop"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"force":{
"type":"boolean",
"default":false
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[2]
Type: object
Kill an Extract or Replicat
Show Source
{
"description":"Kill an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"kill"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[3]
Type: object
Execute an Extract or Replicat
Show Source
{
"description":"Execute an Extract or Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"execute"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[4]
Type: object
Synchronize a Replicat
Show Source
{
"description":"Synchronize a Replicat",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"synchronize"
]
},
"processType":{
"enum":[
"replicat"
]
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[5]
Type: object
Execute the Monitor Agent
Show Source
{
"description":"Execute the Monitor Agent",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"execute"
]
},
"processName":{
"enum":[
"Monitor Agent"
]
}
},
"required":[
"name",
"processName"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[6]
Type: object
Report on Processes
Show Source
{
"description":"Report on Processes",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"up",
"down"
]
}
},
"required":[
"name",
"reportType"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[7]
Type: object
Report on Process Lag
Show Source
{
"description":"Report on Process Lag",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"lag"
]
},
"thresholds":{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"info",
"critical"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"seconds"
]
},
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":65535
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2
}
},
"required":[
"name",
"reportType",
"thresholds"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[8]
Type: object
Report Operating System and database version information
Show Source
{
"description":"Report Operating System and database version information",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"versions"
]
},
"credentials":{
"description":"Credentials for database",
"default":null,
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
{
"type":"null"
}
]
}
},
"required":[
"name",
"reportType"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[9]
Type: object
Lists the schemas in the database with names that match the input specification
Show Source
{
"description":"Lists the schemas in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"schemas"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"qualified":{
"description":"If true, returned schema names are fully qualified",
"type":"boolean",
"default":true
},
"specification":{
"description":"The name of a schema which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
}
]
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[10]
Type: object
Lists the tables in the database with names that match the input specification
Show Source
{
"description":"Lists the tables in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"tables"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"qualified":{
"description":"If true, returned table names are fully qualified",
"type":"boolean",
"default":true
},
"specification":{
"description":"The name of a table or a group of tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"tableType":{
"description":"The type of table to list",
"enum":[
"any",
"auto_capture",
"checkpoint",
"trace"
],
"default":"any"
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[11]
Type: object
Lists the checkpoint tables in the database with names that match the input specification
Show Source
{
"description":"Lists the checkpoint tables in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"checkpointTables"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"specification":{
"description":"The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[12]
Type: object
Lists the containers in the database with names that match the input specification
Show Source
{
"description":"Lists the containers in the database with names that match the input specification",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"report"
]
},
"reportType":{
"enum":[
"containers"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"specification":{
"description":"The name of a container or a group of containers which can include wildcard characters",
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
}
},
"required":[
"name",
"reportType",
"credentials",
"specification"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[13]
Type: object
Purge checkpoint history for ER processes
Show Source
{
"description":"Purge checkpoint history for ER processes",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"checkpoints"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"keep":{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"checkpoints"
]
}
]
},
"value":{
"type":"integer",
"minimum":1,
"maximum":500
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"processName",
"keep"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[14]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"ddlHistory",
"ddlHistoryAlt",
"markerHistory"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2
}
},
"required":[
"name",
"purgeType",
"credentials",
"keep"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[15]
Type: object
Purge trail files no longer needed
Show Source
{
"description":"Purge trail files no longer needed",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"trails"
]
},
"trails":{
"description":"Trails to purge",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the trail, wildcards allowed",
"type":"string",
"pattern":"^[A-Za-z*][A-Za-z0-9*]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":1,
"maxLength":4096
}
},
"required":[
"name"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
},
"useCheckpoints":{
"type":"boolean",
"default":true
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of files",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"files"
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":100
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"trails",
"keep"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[16]
Type: object
Purge Extract or Replicat tasks
Show Source
{
"description":"Purge Extract or Replicat tasks",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"tasks"
]
},
"processType":{
"enum":[
"extract",
"replicat",
"ER"
],
"default":"ER"
},
"processName":{
"type":"string",
"pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
"minLength":1,
"maxLength":8
},
"useStatus":{
"type":"boolean",
"default":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"processName",
"keep"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[17]
Type: object
Purge files no longer needed
Show Source
{
"description":"Purge files no longer needed",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"files"
]
},
"dumpFiles":{
"description":"Purge dump files (*.dmp) which are generated when an application abnormally terminates",
"type":"boolean",
"default":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"keep"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[18]
Type: object
Purge change data - currently only implemented for SQL Server
Show Source
{
"description":"Purge change data - currently only implemented for SQL Server",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"purge"
]
},
"purgeType":{
"enum":[
"changeData"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"keep":{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
},
"required":[
"name",
"purgeType",
"credentials",
"keep"
],
"additionalProperties":false
}
Nested Schema : command-x-oneOf[19]
Type: object
Updates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.
Show Source
{
"description":"Updates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:command"
]
},
"name":{
"enum":[
"flushSequence"
]
},
"credentials":{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
"sequence":{
"description":"The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
},
"trace":{
"description":"Whether to call the sql procedure to update the sequence with tracing mode on",
"type":"boolean",
"default":false
}
},
"required":[
"name",
"credentials",
"sequence"
],
"additionalProperties":false
}
Nested Schema : after
Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.
Match Any
Show Source
-
after-x-anyOf[0]
-
after-x-anyOf[1]
-
string
Minimum Length: 3
Maximum Length: 41
Pattern: ^([0-9]{1,20}[.][0-9]{1,20})$
Log Record Identifer(LRI) pattern for DB2LUW Database.
Example: 65423.12345
-
string
Minimum Length: 3
Maximum Length: 22
Pattern: ^([0][Xx][a-fA-F0-9]{1,20})$
Log Sequence Number (LSN) pattern for DB2ZOS Database.
Example: 0xa123bcde
-
after-x-anyOf[4]
-
string
Minimum Length: 15
Maximum Length: 56
Pattern: ^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$
Commit Sequence Number pattern for MSSQL Database.
Example: 0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445
-
string
Minimum Length: 3
Maximum Length: 17
Pattern: ^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$
Commit Sequence Number pattern for PostgreSQL Database.
Example: 9acd12/231bcf
-
string
Minimum Length: 7
Maximum Length: 33
Pattern: ^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$
Commit Sequence Number pattern for Sybase Database.
Example: 00000.0026487383.0000533650.00034
-
null
Commit Sequence Number for Teradata (Not Supported)
-
string
Minimum Length: 1
Maximum Length: 100
Pattern: ^([A-Za-z0-9_]{1,100})$
Commit Sequence Number pattern for Generic Database.
Example: 9acd12231bcf
{
"description":"Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
}
Nested Schema : at
Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.
Match Any
Show Source
-
at-x-anyOf[0]
-
at-x-anyOf[1]
-
string
Minimum Length: 3
Maximum Length: 41
Pattern: ^([0-9]{1,20}[.][0-9]{1,20})$
Log Record Identifer(LRI) pattern for DB2LUW Database.
Example: 65423.12345
-
string
Minimum Length: 3
Maximum Length: 22
Pattern: ^([0][Xx][a-fA-F0-9]{1,20})$
Log Sequence Number (LSN) pattern for DB2ZOS Database.
Example: 0xa123bcde
-
at-x-anyOf[4]
-
string
Minimum Length: 15
Maximum Length: 56
Pattern: ^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$
Commit Sequence Number pattern for MSSQL Database.
Example: 0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445
-
string
Minimum Length: 3
Maximum Length: 17
Pattern: ^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$
Commit Sequence Number pattern for PostgreSQL Database.
Example: 9acd12/231bcf
-
string
Minimum Length: 7
Maximum Length: 33
Pattern: ^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$
Commit Sequence Number pattern for Sybase Database.
Example: 00000.0026487383.0000533650.00034
-
null
Commit Sequence Number for Teradata (Not Supported)
-
string
Minimum Length: 1
Maximum Length: 100
Pattern: ^([A-Za-z0-9_]{1,100})$
Commit Sequence Number pattern for Generic Database.
Example: 9acd12231bcf
{
"description":"Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.",
"x-anyOf":[
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
},
{
"description":"Log Record Identifer(LRI) pattern for DB2LUW Database.",
"type":"string",
"pattern":"^([0-9]{1,20}[.][0-9]{1,20})$",
"minLength":3,
"maxLength":41,
"example":"65423.12345"
},
{
"description":"Log Sequence Number (LSN) pattern for DB2ZOS Database.",
"type":"string",
"pattern":"^([0][Xx][a-fA-F0-9]{1,20})$",
"minLength":3,
"maxLength":22,
"example":"0xa123bcde"
},
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
},
{
"description":"Commit Sequence Number pattern for MSSQL Database.",
"type":"string",
"pattern":"^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$",
"minLength":15,
"maxLength":56,
"example":"0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445"
},
{
"description":"Commit Sequence Number pattern for PostgreSQL Database.",
"type":"string",
"pattern":"^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$",
"minLength":3,
"maxLength":17,
"example":"9acd12/231bcf"
},
{
"description":"Commit Sequence Number pattern for Sybase Database.",
"type":"string",
"pattern":"^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$",
"minLength":7,
"maxLength":33,
"example":"00000.0026487383.0000533650.00034"
},
{
"description":"Commit Sequence Number for Teradata (Not Supported)",
"type":"null"
},
{
"description":"Commit Sequence Number pattern for Generic Database.",
"type":"string",
"pattern":"^([A-Za-z0-9_]{1,100})$",
"minLength":1,
"maxLength":100,
"example":"9acd12231bcf"
}
]
}
Nested Schema : threads
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 500
Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.
Show Source
{
"description":"Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.",
"type":"array",
"items":{
"type":"integer",
"minimum":1,
"maximum":500
},
"minItems":1,
"maxItems":500
}
Nested Schema : command-x-oneOf[0]-allOf[5]
Match Any
Show Source
{
"x-anyOf":[
{
"dependencies":{
"threads":[
"at"
]
}
},
{
"dependencies":{
"threads":[
"after"
]
}
},
{
"dependencies":{
"threads":[
"skipTransaction"
]
}
}
]
}
Nested Schema : after-x-anyOf[0]
Match One
Show Source
-
integer
Minimum Value: 0
Maximum Value: 9.223372036854776E18
System Change Number(Normal Format) for Oracle Database.
Example: 6488359
-
string
Minimum Length: 3
Maximum Length: 64
Pattern: [0-9]+[.][0-9]+
System Change Number(Alternate Format) for Oracle Database.
Example: 6488359.3456712
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
Nested Schema : after-x-anyOf[1]
Match One
Show Source
-
string
Minimum Length: 3
Maximum Length: 37
Pattern: ^([0-9]+[:][0-9]+)$
Commit Sequence Number pattern(Legacy) for MySQL Database.
Example: 6488359:564781
-
string
Minimum Length: 77
Maximum Length: 77
Pattern: ^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$
CSN pattern(GTID format) for MySQL Database.
Example: 00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
}
Nested Schema : after-x-anyOf[4]
Match One
Show Source
-
integer
Minimum Value: 1
Maximum Value: 1.8446744073709552E19
Commit Sequence Number pattern (Legacy) for DB2400 Database.
Example: 78654321
-
string
Minimum Length: 32
Maximum Length: 32
Pattern: ^([a-fA-F0-9]{32})$
Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.
Example: F0B4993FD22315E5F0B4993FD22315E5
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
}
Nested Schema : at-x-anyOf[0]
Match One
Show Source
-
integer
Minimum Value: 0
Maximum Value: 9.223372036854776E18
System Change Number(Normal Format) for Oracle Database.
Example: 6488359
-
string
Minimum Length: 3
Maximum Length: 64
Pattern: [0-9]+[.][0-9]+
System Change Number(Alternate Format) for Oracle Database.
Example: 6488359.3456712
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
Nested Schema : at-x-anyOf[1]
Match One
Show Source
-
string
Minimum Length: 3
Maximum Length: 37
Pattern: ^([0-9]+[:][0-9]+)$
Commit Sequence Number pattern(Legacy) for MySQL Database.
Example: 6488359:564781
-
string
Minimum Length: 77
Maximum Length: 77
Pattern: ^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$
CSN pattern(GTID format) for MySQL Database.
Example: 00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern(Legacy) for MySQL Database.",
"type":"string",
"pattern":"^([0-9]+[:][0-9]+)$",
"minLength":3,
"maxLength":37,
"example":"6488359:564781"
},
{
"description":"CSN pattern(GTID format) for MySQL Database.",
"type":"string",
"pattern":"^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$",
"minLength":77,
"maxLength":77,
"example":"00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654"
}
]
}
Nested Schema : at-x-anyOf[4]
Match One
Show Source
-
integer
Minimum Value: 1
Maximum Value: 1.8446744073709552E19
Commit Sequence Number pattern (Legacy) for DB2400 Database.
Example: 78654321
-
string
Minimum Length: 32
Maximum Length: 32
Pattern: ^([a-fA-F0-9]{32})$
Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.
Example: F0B4993FD22315E5F0B4993FD22315E5
{
"x-oneOf":[
{
"description":"Commit Sequence Number pattern (Legacy) for DB2400 Database.",
"type":"integer",
"minimum":1,
"maximum":1.8446744073709552E19,
"example":"78654321"
},
{
"description":"Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.",
"type":"string",
"pattern":"^([a-fA-F0-9]{32})$",
"minLength":32,
"maxLength":32,
"example":"F0B4993FD22315E5F0B4993FD22315E5"
}
]
}
Nested Schema : thresholds
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"info",
"critical"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"seconds"
]
},
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":65535
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"type":{
"enum":[
"info",
"critical"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"seconds"
]
},
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":65535
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : units
Match One
Show Source
-
Allowed Values: [
"seconds"
]
-
Allowed Values: [
"minutes"
]
-
Allowed Values: [
"hours"
]
{
"x-oneOf":[
{
"enum":[
"seconds"
]
},
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
}
]
}
Nested Schema : credentials
Credentials for database
Default Value: oracle.doceng.json.BetterJsonNull@5d0ea2af
Match One
Show Source
{
"description":"Credentials for database",
"default":null,
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
},
{
"type":"null"
}
]
}
Nested Schema : credentials-x-oneOf[0]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : credentials
Type: object
Credentials for database
Show Source
{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : specification
The name of a schema which can include wildcard characters
Match Any
Show Source
-
string
Minimum Length: 1
Maximum Length: 130
Pattern: ^([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"The name of a schema which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
}
]
}
Nested Schema : credentials
Type: object
Credentials for database
Show Source
{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : specification
The name of a table or a group of tables which can include wildcard characters
Match Any
Show Source
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"The name of a table or a group of tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
Nested Schema : credentials
Type: object
Credentials for database
Show Source
{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : specification
The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters
Match Any
Show Source
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
Nested Schema : credentials
Type: object
Credentials for database
Show Source
{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"checkpoints"
]
}
]
},
"value":{
"type":"integer",
"minimum":1,
"maximum":500
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"x-oneOf":[
{
"enum":[
"checkpoints"
]
}
]
},
"value":{
"type":"integer",
"minimum":1,
"maximum":500
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : units
Match One
Show Source
-
Allowed Values: [
"checkpoints"
]
{
"x-oneOf":[
{
"enum":[
"checkpoints"
]
}
]
}
Nested Schema : credentials
Type: object
Credentials for database
Show Source
{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":2
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
}
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"hours"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 1000
Allowed value for hours value
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Maximum number of hours
Show Source
-
type:
Allowed Values: [
"max"
]
-
units:
Allowed Values: [
"hours"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 1000
Allowed value for hours value
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[2]
Type: object
Minimum number of days
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"days"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 365
Allowed value for days value
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[3]
Type: object
Maximum number of days
Show Source
-
type:
Allowed Values: [
"max"
]
-
units:
Allowed Values: [
"days"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 365
Allowed value for days value
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of files",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"files"
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":100
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
Nested Schema : trails
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024
Trails to purge
Show Source
{
"description":"Trails to purge",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of the trail, wildcards allowed",
"type":"string",
"pattern":"^[A-Za-z*][A-Za-z0-9*]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":1,
"maxLength":4096
}
},
"required":[
"name"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of files",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"files"
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":100
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
}
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"hours"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 1000
Allowed value for hours value
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Minimum number of days
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"days"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 365
Allowed value for days value
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[2]
Type: object
Minimum number of files
Show Source
{
"description":"Minimum number of files",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"files"
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":100
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items
Type: object
Show Source
-
name:
string
Minimum Length: 1
Maximum Length: 2
Pattern: ^[A-Za-z*][A-Za-z0-9*]?$
The name of the trail, wildcards allowed
-
path(optional):
string
Minimum Length: 1
Maximum Length: 4096
The path where trail data is stored
{
"type":"object",
"properties":{
"name":{
"description":"The name of the trail, wildcards allowed",
"type":"string",
"pattern":"^[A-Za-z*][A-Za-z0-9*]?$",
"minLength":1,
"maxLength":2
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":1,
"maxLength":4096
}
},
"required":[
"name"
],
"additionalProperties":false
}
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
}
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"hours"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 1000
Allowed value for hours value
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Minimum number of days
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"days"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 365
Allowed value for days value
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
}
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"hours"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 1000
Allowed value for hours value
{
"description":"Minimum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Minimum number of days
Show Source
-
type:
Allowed Values: [
"min"
]
-
units:
Allowed Values: [
"days"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 365
Allowed value for days value
{
"description":"Minimum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"min"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : credentials
Type: object
Credentials for database
Show Source
{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
},
"minItems":1,
"maxItems":1
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
},
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
]
}
Nested Schema : items-x-oneOf[0]
Type: object
Maximum number of hours
Show Source
-
type:
Allowed Values: [
"max"
]
-
units:
Allowed Values: [
"hours"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 1000
Allowed value for hours value
{
"description":"Maximum number of hours",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"hours"
]
},
"value":{
"description":"Allowed value for hours value",
"type":"integer",
"minimum":1,
"maximum":1000
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Maximum number of days
Show Source
-
type:
Allowed Values: [
"max"
]
-
units:
Allowed Values: [
"days"
]
-
value:
integer
Minimum Value: 1
Maximum Value: 365
Allowed value for days value
{
"description":"Maximum number of days",
"type":"object",
"properties":{
"type":{
"enum":[
"max"
]
},
"units":{
"enum":[
"days"
]
},
"value":{
"description":"Allowed value for days value",
"type":"integer",
"minimum":1,
"maximum":365
}
},
"required":[
"type",
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : credentials
Type: object
Credentials for database
Show Source
{
"description":"Credentials for database",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : sequence
The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.
Match Any
Show Source
-
string
Minimum Length: 1
Maximum Length: 130
Pattern: ^([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":1,
"maxLength":130
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":3,
"maxLength":261
},
{
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":5,
"maxLength":392
}
]
}
Nested Schema : schedule-x-oneOf[1]
Type: object
Task is run on a time-based schedule
Show Source
-
days:
days
Days of the week to run the task
-
times:
array times
Minimum Number of Items: 1
Maximum Number of Items: 1440
Array of times to run task in 24 hour format HH:MM
{
"description":"Task is run on a time-based schedule",
"type":"object",
"properties":{
"days":{
"description":"Days of the week to run the task",
"x-oneOf":[
{
"enum":[
"every"
]
},
{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
{
"type":"array",
"items":{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"minItems":1,
"maxItems":7
}
]
},
"times":{
"description":"Array of times to run task in 24 hour format HH:MM",
"type":"array",
"items":{
"type":"string",
"pattern":"([01][0-9]|2[0-3]):[0-5][0-9]",
"minLength":5,
"maxLength":5
},
"minItems":1,
"maxItems":1440
}
},
"required":[
"days",
"times"
],
"additionalProperties":false
}
Nested Schema : schedule-x-oneOf[2]
Type: object
Task is run on an interval
Show Source
{
"description":"Task is run on an interval",
"type":"object",
"properties":{
"every":{
"type":"object",
"properties":{
"units":{
"x-oneOf":[
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
},
{
"enum":[
"days"
]
},
{
"enum":[
"weeks"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":1024
}
},
"required":[
"units",
"value"
],
"additionalProperties":false
}
},
"required":[
"every"
],
"additionalProperties":false
}
Nested Schema : schedule-x-oneOf[3]
Type: object
Task is run when the Admin Server starts
Show Source
-
autoStart:
Allowed Values: [
true
]
Indicates task starts with Admin Server
-
delay(optional):
integer
Minimum Value: 0
Maximum Value: 3600
Default Value: 0
Time to wait in seconds before starting task
{
"description":"Task is run when the Admin Server starts",
"type":"object",
"properties":{
"autoStart":{
"description":"Indicates task starts with Admin Server",
"enum":[
true
]
},
"delay":{
"description":"Time to wait in seconds before starting task",
"type":"integer",
"minimum":0,
"default":0,
"maximum":3600
}
},
"required":[
"autoStart"
],
"additionalProperties":false
}
Nested Schema : days
Days of the week to run the task
Match One
Show Source
-
Allowed Values: [
"every"
]
-
Allowed Values: [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
-
array days-x-oneOf[2]
Minimum Number of Items: 1
Maximum Number of Items: 7
{
"description":"Days of the week to run the task",
"x-oneOf":[
{
"enum":[
"every"
]
},
{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
{
"type":"array",
"items":{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"minItems":1,
"maxItems":7
}
]
}
Nested Schema : times
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1440
Array of times to run task in 24 hour format HH:MM
Show Source
-
Array of:
string
Minimum Length: 5
Maximum Length: 5
Pattern: ([01][0-9]|2[0-3]):[0-5][0-9]
{
"description":"Array of times to run task in 24 hour format HH:MM",
"type":"array",
"items":{
"type":"string",
"pattern":"([01][0-9]|2[0-3]):[0-5][0-9]",
"minLength":5,
"maxLength":5
},
"minItems":1,
"maxItems":1440
}
Nested Schema : days-x-oneOf[2]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 7
Show Source
-
Array of:
Allowed Values: [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
{
"type":"array",
"items":{
"enum":[
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"minItems":1,
"maxItems":7
}
Nested Schema : every
Type: object
Show Source
{
"type":"object",
"properties":{
"units":{
"x-oneOf":[
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
},
{
"enum":[
"days"
]
},
{
"enum":[
"weeks"
]
}
]
},
"value":{
"type":"integer",
"minimum":0,
"maximum":1024
}
},
"required":[
"units",
"value"
],
"additionalProperties":false
}
Nested Schema : units
Match One
Show Source
-
Allowed Values: [
"minutes"
]
-
Allowed Values: [
"hours"
]
-
Allowed Values: [
"days"
]
-
Allowed Values: [
"weeks"
]
{
"x-oneOf":[
{
"enum":[
"minutes"
]
},
{
"enum":[
"hours"
]
},
{
"enum":[
"days"
]
},
{
"enum":[
"weeks"
]
}
]
}