| Condition table |
The Condition table allows you to retrieve InSight Alert conditions for a Fleet customer account.
This topic contains the following sections:
RequirementsWhen you write templates that access this table, follow these requirements:
Specify the Symbolic Name for the table version to use:
TableID = Condition-1.0
Specify an Intent that this table supports:
- Retrieve
- Update
- Retrieve templates:
This table does not require the use of a fetcher. However, the following fetchers are available to optimize your query and are listed from most efficient to least:
- Id (Equals/In)
[Filter] Id(ExtId) = Equals(Id1) # You can filter on literals or on variables from the [User] or [Calculated] sections.
[Filter] Id(ExtId) = In(["Id1","Id2","Id3"])
- Id (Equals/In)
Condition column descriptionsThis list includes each column's name, which you use in expressions to retrieve or create data, and data type, which defines how the data is retrieved and set.
 Note |
|---|
| If a column of data type Id is a primary key OR if it refers to other tables (Id <OtherTable>), then you can map it to an external key or, in some cases, a Telogis key. |
| Column | Data Type | Description |
|---|---|---|
| Id | Id | (primary key) The ID of the condition. |
| Name | Text | (read-only) The name of the condition. |
| ConditionType | Text | (read-only) The type of condition. Some examples include IdleCondition, MaintenanceCondition and SpeedCondition. |
| IsEnabled | BoolType | Indicates whether this condition is enabled. This defines whether the condition will generate alerts. |
| DisableReason | Text | (read-only) The reason why this condition was disabled. |
| DriverId | Id<Driver> | (read-only) The ID of the driver that this condition applies to, if any. |
| UnitId | Id<Unit> | (read-only) The ID of the unit that this condition applies to, if any. |
| FleetId | Id | (read-only) The ID of the fleet that this condition applies to, if any. |
| TeamId | Id | (read-only) The ID of the team that this condition applies to, if any. |
| InstallTypeId | Id<InstallType> | (read-only) The ID of the install type that this condition applies to, if any. |
| AssetTypeId | Id<AssetType> | (read-only) The ID of the asset type that this condition applies to, if any. |
| TerritoryId | Id<Territory> | (read-only) The ID of the territory that this condition applies to, if any. |
| JobTypeId | Id<JobType> | (read-only) The ID of the job type that this condition applies to, if any. |
| ScheduleStart | Array<TimeInterval> | An array indicating the start of the times of day that this condition applies. Each day of the week is represented by an entry in the array, with Sunday being the first day of the week. |
| ScheduleStop | Array<TimeInterval> | An array indicating the end of the times of day that this condition applies. Each day of the week is represented by an entry in the array, with Sunday being the first day of the week. |
| ScheduleInverted | Array<BoolType> | An array indicating whether to trigger an alert when outside the time range specified by ScheduleStart and ScheduleEnd. Each day of the week is represented by an entry in the array, with Sunday being the first day of the week. |
| TimeToTrigger | TimeInterval | The minimum amount of time that the condition must be on before an alert is triggered. |
| EmailOnClose | BoolType | Indicates whether to send an email notification when an alert is turned off. |
| EmailOnTrigger | BoolType | Indicates whether to send an email notification when an alert is triggered. |
| Aggressive | BoolType | Indicates whether to trigger this alert aggressively. Aggressive alerts trigger as soon as the TimeToTrigger elapses, regardless of whether another report comes in confirming that the exception is still occurring. |
| Severity | EnumType | The severity of this condition. Valid values are: Normal, Major or Critical. |
| SeverityColor | Color | The color to use in the InSight Alerts UI when displaying alerts generated by this condition. |
| EmailEnabled | BoolType | Indicates whether this condition can generate emails. |
| EmailToAddress | Text | The email address to send alert notifications to. |
| EmailMessage | Text | The message to send email notifications to. |
| SmsEnabled | BoolType | Indicates whether this condition can generate SMS messages. |
| SmsToAddress | Text | The phone number to send SMS alert notifications to. |
| NotificationPopupOnTrigger | BoolType | Indicates whether to display a popup notification in the Fleet UI when this condition is triggered. |
| NotificationDuration | TimeInterval | The amount of time a popup notification will last, if NotificationType is set to Fade. |
| NotificationType | EnumType | If set to Fade, then popup notifications will be closed after the time indicated by NotificationDuration expires. If set to Sticky, the popup notifications will remain open until the user closes them. |
| CategoryId | Id<Category> | (read-only) The ID of the category that this condition applies to, if any. |
| ServiceTypeId | Id | (read-only) The ID of the service type that this condition applies to, if any. |
| MarkerId | Id<Marker> | (read-only) The ID of the marker that this condition applies to, if any. |
| ZoneType | EnumType | (read-only) The type of zone that this condition applies to, if any. Valid values are: County, State, City or Zip. |
| ZoneName | Text | (read-only) The name of the zone that this condition applies to, if any. |
| Tags | Set<Text> | (read-only) The tags that this condition applies to, if applicable. |
| UseSpeedCategory | BoolType | (read-only) If this is a PostedSpeedCondition, indicates whether to use the implied speed limit from the road class when there is no known speed limit available. |
| UseSpeedAtZoneMarker | BoolType | (read-only) If this is a PostedSpeedCondition, indicates whether to use the implied speed limit from a nearby zone marker. |
| SpeedingThresholdAdjustmentType | EnumType | (read-only) Valid values are: Unadjusted, Default, Percentage or Offset. If this is a PostedSpeedCondition, indicates how the alert threshold is calculated from the speed limit. The threshold can be a Percentage or Offset above the speed limit. Otherwise, it can either be equal to the speed limit (Unadjusted) or set according to the Telogis-configured Default. |
| DiagnosticConditionInverted | BoolType | (read-only) If this is an AnalogDiagnosticCondition, indicates whether to trigger an alert when outside the specified range. If this is a BooleanDiagnosticCondition, indicates whether to trigger an alert when the diagnostic value becomes false. |
| DiagnosticParameterName | Text | (read-only) The name of the vehicle diagnostic that this condition applies to, if any. |
| MinAcceleration | Acceleration | (read-only) If this is an AnalogDiagnosticCondition, the minimum acceleration that this condition applies to. |
| MaxAcceleration | Acceleration | (read-only) If this is an AnalogDiagnosticCondition, the maximum acceleration that this condition applies to. |
| MinDistance | Distance | (read-only) If this is an AnalogDiagnosticCondition, the minimum distance that this condition applies to. |
| MaxDistance | Distance | (read-only) If this is an AnalogDiagnosticCondition, the maximum distance that this condition applies to. If this is a MaintenanceCondition, indicates the maximum distance that a vehicle can be late for its scheduled maintenance before an alert is triggered. |
| MinFlowRate | FlowRate | (read-only) If this is an AnalogDiagnosticCondition, the minimum flow rate that this condition applies to. |
| MaxFlowRate | FlowRate | (read-only) If this is an AnalogDiagnosticCondition, the maximum flow rate that this condition applies to. |
| MinFrequency | Frequency | (read-only) If this is an AnalogDiagnosticCondition, the minimum frequency that this condition applies to. |
| MaxFrequency | Frequency | (read-only) If this is an AnalogDiagnosticCondition, the maximum frequency that this condition applies to. |
| MinPressure | Pressure | (read-only) If this is an AnalogDiagnosticCondition, the minimum pressure that this condition applies to. |
| MaxPressure | Pressure | (read-only) If this is an AnalogDiagnosticCondition, the maximum pressure that this condition applies to. |
| MinSpeed | Speed | (read-only) If this is an AnalogDiagnosticCondition, the minimum speed that this condition applies to. If this is a BooleanDiagnosticCondition or EventDiagnosticCondition, indicates the minimum speed the vehicle must be travelling for the condition to be able to be triggered. |
| MaxSpeed | Speed | (read-only) If this is an AnalogDiagnosticCondition, the maximum speed that this condition applies to. If this is a SpeedCondition or SpeedInMarkerCondition, indicates the maximum speed a vehicle can travel before an alert is triggered. If this is a PostedSpeedCondition with SpeedingThresholdAdjustmentType set to Offset, indicates the maximum amount that the speed limit can be exceeded by before an alert is triggered. |
| MinTemperature | Temperature | (read-only) If this is an AnalogDiagnosticCondition, the minimum temperature that this condition applies to. |
| MaxTemperature | Temperature | (read-only) If this is an AnalogDiagnosticCondition, the maximum temperature that this condition applies to. |
| MinTimeInterval | TimeInterval | (read-only) If this is an AnalogDiagnosticCondition, the minimum time interval that this condition applies to. |
| MaxTimeInterval | TimeInterval | (read-only) If this is an AnalogDiagnosticCondition, the maximum time interval that this condition applies to. If this is an InsuranceCondition, LicenseCondition or MaintenanceCondition, indicates the maximum grace period allowed before triggering an alert. If this is a RunningLateLatestArrivalCondition or RunningLatePlannedArrivalCondition, indicates the maximum amount of time a vehicle can be late for a job before an alert is triggered. |
| MinValue | Number | (read-only) If this is an AnalogDiagnosticCondition, the minimum diagnostic value that this condition applies to. |
| MaxValue | Number | (read-only) If this is an AnalogDiagnosticCondition, the maximum diagnostic value that this condition applies to. If this is a PostedSpeedCondition, indicates the number of percentage points over the speed limit that a vehicle can drive before an alert is triggered. |
| MinVolume | Volume | (read-only) If this is an AnalogDiagnosticCondition, the minimum volume that this condition applies to. |
| MaxVolume | Volume | (read-only) If this is an AnalogDiagnosticCondition, the maximum volume that this condition applies to. |
| MinWeight | Weight | (read-only) If this is an AnalogDiagnosticCondition, the minimum weight that this condition applies to. |
| MaxWeight | Weight | (read-only) If this is an AnalogDiagnosticCondition, the maximum weight that this condition applies to. |
Additional columns: