[Index]

Model: data/AlertingRule

A rule defining alert settings.

Model Details: data/AlertingRule

Title Description Details
Rule Settings Group Assigned by FDP
  • Field Name: Rule Settings
  • Type: Object
Rule Name * Name of the alerting rule. This must be unique per rule group.
  • Field Name: Rule Settings.name
  • Type: String
  • MaxLength: 255
Description Provide a brief description of this Alerting Rule.
  • Field Name: Rule Settings.description
  • Type: String
  • MaxLength: 8192
Enabled Is this rule enabled?
  • Field Name: Rule Settings.enabled
  • Type: Boolean
Severity *
  • Field Name: Rule Settings.severity
  • Type: String
  • MaxLength: 1024
  • Choices: ["Informational", "Minor", "Major", "Critical"]
Evaluation Frequency *
  • Field Name: Rule Settings.evaluation_frequency
  • Type: String
  • MaxLength: 1024
  • Choices: ["Every 5 minutes", "Every 10 minutes", "Every 30 minutes", "Every hour", "Every 4 hours", "Every day", "Every week", "Every month", "Every year"]
Firing Actions
  • Field Name: firing_actions.[n]
  • Type: Array
Workflow *
  • Field Name: Rule Settings.firing_actions.[n].workflow
  • Type: String
  • Target: data/ProvisioningWorkflow
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Input Parameters Additional parameters for the workflow
  • Field Name: input_parameters.[n]
  • Type: Array
  • Choices: []
Name * Name of additional input parameter.
  • Field Name: Rule Settings.firing_actions.[n].input_parameters.[n].name
  • Type: String
  • MaxLength: 1024
  • Choices: []
Value * Value of additional input parameter.
  • Field Name: Rule Settings.firing_actions.[n].input_parameters.[n].value
  • Type: String
  • MaxLength: 1024
  • Choices: []
Resolved Actions
  • Field Name: resolved_actions.[n]
  • Type: Array
Workflow *
  • Field Name: Rule Settings.resolved_actions.[n].workflow
  • Type: String
  • Target: data/ProvisioningWorkflow
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Input Parameters Additional parameters for the workflow
  • Field Name: input_parameters.[n]
  • Type: Array
  • Choices: []
Name * Name of additional input parameter.
  • Field Name: Rule Settings.resolved_actions.[n].input_parameters.[n].name
  • Type: String
  • MaxLength: 1024
  • Choices: []
Value * Value of additional input parameter.
  • Field Name: Rule Settings.resolved_actions.[n].input_parameters.[n].value
  • Type: String
  • MaxLength: 1024
  • Choices: []
Rule Condition Group Assigned by FDP
  • Field Name: Rule Condition
  • Type: Object
Data Source Specify Data Source Default: LXT0
  • Field Name: Rule Condition.datasource
  • Type: String
  • Default: LXT0
  • MaxLength: 1024
Database Rule
  • Field Name: database_rule
  • Type: Object
Data Source Specify Data Source Default: LXT0
  • Field Name: Rule Condition.database_rule.datasource
  • Type: String
  • Default: LXT0
  • MaxLength: 1024
Data Source Instance Specify Data Source Instance
  • Field Name: Rule Condition.database_rule.datasourceInstance
  • Type: String
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Resource Specify resource
  • Field Name: Rule Condition.database_rule.resource
  • Type: String
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Query Date Range Specify the date range for the query
  • Field Name: Rule Condition.database_rule._range
  • Type: String
  • MaxLength: 1024
  • Choices: ["Last 5 minutes", "Last 30 Minutes", "Last 60 Minutes", "Last 12 Hours", "Last 24 Hours", "Last 7 Days", "Last 30 Days", "Last 2 Months", "Last 3 Months", "Last 6 Months", "Last 12 Months", "Previous Hour", "Previous Day", "Previous Week", "Previous Month", "Previous Year", "Through Today", "Through Yesterday"]
Over Time Specify whether this query should be evaluated over time.
  • Field Name: Rule Condition.database_rule.over_time
  • Type: Boolean
Interval Specify the interval for the query Default: 1
  • Field Name: Rule Condition.database_rule.interval
  • Type: Integer
  • Default: 1
  • Choices: ["Monthly", "Weekly", "Daily", "Hourly", "Minute", "Second"]
Fields Specify the fields from the resource to be used in the chart.
  • Field Name: fields.[n]
  • Type: Array
Field Name * This is the field name.
  • Field Name: Rule Condition.database_rule.fields.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Friendly Name * Specify a friendly name to be used in the chart.
  • Field Name: Rule Condition.database_rule.fields.[n].headerName
  • Type: String
  • MaxLength: 1024
Field Type This is the field type
  • Field Name: Rule Condition.database_rule.fields.[n].ruleTypeString
  • Type: Integer
  • Choices: ["Text", "Integer", "Float"]
Operation Select the operation to be performed on the field.
  • Field Name: Rule Condition.database_rule.fields.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: ["Count", "Grouping Count", "Min", "Max", "Avg", "Sum", "Value", "Variance", "Stddev", "Select Query", "Partition By", "Partition Order"]
Filters Specify filters to be applied to the data.
  • Field Name: filters.[n]
  • Type: Array
Field Name Specify Field Name
  • Field Name: Rule Condition.database_rule.filters.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Operation Specify operation
  • Field Name: Rule Condition.database_rule.filters.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: ["LIKE (Case sensitive)", "NOT LIKE (Case sensitive)", "ILIKE (Case insensitive)", "NOT ILIKE (Case insensitive)", "Equals", "Does Not Equal", "Contains", "Does Not Contain", "Regex (Case sensitive)", "Regex (Case insensitive)", "Exclude Regex (Case sensitive)", "Exclude Regex (Case insenstive)"]
Filter Value Specify filter value
  • Field Name: Rule Condition.database_rule.filters.[n].filterValue
  • Type: String
  • MaxLength: 1024
Alert Condition
  • Field Name: condition
  • Type: Object
Condition Groups Array of condition groups that can be combined with logical operators.
  • Field Name: condition_groups.[n]
  • Type: Array
Operand Defines the logical operator to combine this group with the previous group.
  • Field Name: Rule Condition.database_rule.condition.condition_groups.[n].operand
  • Type: String
  • MaxLength: 1024
  • Choices: ["Logical OR", "Logical AND"]
Conditions List of conditions within this group.
  • Field Name: conditions.[n]
  • Type: Array
Operand Defines the logical operator to combine this group with the previous group.
  • Field Name: Rule Condition.database_rule.condition.condition_groups.[n].conditions.[n].operand
  • Type: String
  • MaxLength: 1024
  • Choices: ["Logical OR", "Logical AND"]
Field The Friendly Name of the field to be used in the condition.
  • Field Name: Rule Condition.database_rule.condition.condition_groups.[n].conditions.[n].field
  • Type: String
  • MaxLength: 1024
Operator Defines the comparison operator for the condition.
  • Field Name: Rule Condition.database_rule.condition.condition_groups.[n].conditions.[n].operator
  • Type: String
  • MaxLength: 1024
  • Choices: ["Equals", "Does Not Equal", "Less Than", "Less Than or Equal", "Greater Than", "Greater Than or Equal", "Contains", "Starts With", "Ends With"]
Value The value to compare against.
  • Field Name: Rule Condition.database_rule.condition.condition_groups.[n].conditions.[n].value
  • Type: String
  • MaxLength: 1024
Data Source Instance Specify Data Source Instance
  • Field Name: Rule Condition.datasourceInstance
  • Type: String
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Resource Specify resource
  • Field Name: Rule Condition.resource
  • Type: String
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Query Date Range Specify the date range for the query
  • Field Name: Rule Condition._range
  • Type: String
  • MaxLength: 1024
  • Choices: ["Last 5 minutes", "Last 30 Minutes", "Last 60 Minutes", "Last 12 Hours", "Last 24 Hours", "Last 7 Days", "Last 30 Days", "Last 2 Months", "Last 3 Months", "Last 6 Months", "Last 12 Months", "Previous Hour", "Previous Day", "Previous Week", "Previous Month", "Previous Year", "Through Today", "Through Yesterday"]
Over Time Specify whether this query should be evaluated over time.
  • Field Name: Rule Condition.over_time
  • Type: Boolean
Interval Specify the interval for the query Default: 1
  • Field Name: Rule Condition.interval
  • Type: Integer
  • Default: 1
  • Choices: ["Monthly", "Weekly", "Daily", "Hourly", "Minute", "Second"]
Fields Specify the fields from the resource to be used in the chart.
  • Field Name: fields.[n]
  • Type: Array
Field Name * This is the field name.
  • Field Name: Rule Condition.fields.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Friendly Name * Specify a friendly name to be used in the chart.
  • Field Name: Rule Condition.fields.[n].headerName
  • Type: String
  • MaxLength: 1024
Field Type This is the field type
  • Field Name: Rule Condition.fields.[n].ruleTypeString
  • Type: Integer
  • Choices: ["Text", "Integer", "Float"]
Operation Select the operation to be performed on the field.
  • Field Name: Rule Condition.fields.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: ["Count", "Grouping Count", "Min", "Max", "Avg", "Sum", "Value", "Variance", "Stddev", "Select Query", "Partition By", "Partition Order"]
Filters Specify filters to be applied to the data.
  • Field Name: filters.[n]
  • Type: Array
Field Name Specify Field Name
  • Field Name: Rule Condition.filters.[n].ruleName
  • Type: String
  • MaxLength: 1024
  • Choices: []
Operation Specify operation
  • Field Name: Rule Condition.filters.[n].operation
  • Type: String
  • MaxLength: 1024
  • Choices: ["LIKE (Case sensitive)", "NOT LIKE (Case sensitive)", "ILIKE (Case insensitive)", "NOT ILIKE (Case insensitive)", "Equals", "Does Not Equal", "Contains", "Does Not Contain", "Regex (Case sensitive)", "Regex (Case insensitive)", "Exclude Regex (Case sensitive)", "Exclude Regex (Case insenstive)"]
Filter Value Specify filter value
  • Field Name: Rule Condition.filters.[n].filterValue
  • Type: String
  • MaxLength: 1024
Alert Condition
  • Field Name: condition
  • Type: Object
Condition Groups Array of condition groups that can be combined with logical operators.
  • Field Name: condition_groups.[n]
  • Type: Array
Operand Defines the logical operator to combine this group with the previous group.
  • Field Name: Rule Condition.condition.condition_groups.[n].operand
  • Type: String
  • MaxLength: 1024
  • Choices: ["Logical OR", "Logical AND"]
Conditions List of conditions within this group.
  • Field Name: conditions.[n]
  • Type: Array
Operand Defines the logical operator to combine this group with the previous group.
  • Field Name: Rule Condition.condition.condition_groups.[n].conditions.[n].operand
  • Type: String
  • MaxLength: 1024
  • Choices: ["Logical OR", "Logical AND"]
Field The Friendly Name of the field to be used in the condition.
  • Field Name: Rule Condition.condition.condition_groups.[n].conditions.[n].field
  • Type: String
  • MaxLength: 1024
Operator Defines the comparison operator for the condition.
  • Field Name: Rule Condition.condition.condition_groups.[n].conditions.[n].operator
  • Type: String
  • MaxLength: 1024
  • Choices: ["Equals", "Does Not Equal", "Less Than", "Less Than or Equal", "Greater Than", "Greater Than or Equal", "Contains", "Starts With", "Ends With"]
Value The value to compare against.
  • Field Name: Rule Condition.condition.condition_groups.[n].conditions.[n].value
  • Type: String
  • MaxLength: 1024