An observation plan can be configured to remind users of likely plan violations in the near future.
When an observation plan is checked and all of the following conditions are true the observation plan treats this as a likely violation:
•The Reminder is activated on the Observation Plan.
•The observation plan defines a check interval that includes the current date, this time interval is called the current check interval.
•This check interval's end date is less than a user specified time span away from the current date.
•This check interval's end date is more than a user specified time span away from the current date
•The observation count for this interval is not fulfilling the observation plan
If all of the above mentioned conditions are met when this observation plan is checked, the Application Server will send a message to a defined user group to inform those users about the likely violation. A likely violation is not recorded as an observation plan violation.
Table 1 summarizes the observation plan settings
Setting |
Description |
Reminder active |
If set the observation plan will check for violations in the current check interval and will send reminders if violations are found. |
Minimum response time |
A likely violation is only detected if the time span between the date when the observation plan is checked and the end date of the current check interval is greater than this value. This setting helps you to prevent reminders that would be sent to users even though users would not have enough time to react till the end of the current check interval. |
Maximum response time |
A likely violation is only detected if the time span between the date when the observation plan is checked and the end date of the current check interval less than this value. This setting helps you to prevent reminders that would be sent to users even though the end of the current check interval is far away. |
Message subject template |
A text template that is used for the subject of the messages sent to users in case a likely violation is found. |
Message body template |
A text template that is used for the subject of the messages sent to users in case a likely violation is found. |
Message severity |
The severity for the sent messages. |
Varable name |
Variable type |
Description |
ObservationPlan |
Class |
Exposes details of the observation plan that triggered sending a reminder. |
ObservationPlanCheck |
Class |
Exposes details of the actual check of the observation plan |
Table 2: Text template variables supported in Message subject and Message body for observation plan reminders
Variable name |
Variable type |
Description |
Name |
Primitive |
Name of the observation plan |
Description |
Primitive |
Description of the observation plan |
SourceFeatureId |
Primitive |
Id of the feature on which the observation plan is defined |
SourceFeatureName |
Primitive |
Name of the feature on which the observation plan is defined |
ErroneousHandling |
Primitive |
Handling of erroneous observations in this observation plan. |
OnlyApproved |
Primitive |
Defines if only approved observations are counted when checking this observation plan. |
Table 3: Properties of the ObservationPlan markup class.
Variable name |
Variable type |
Description |
CheckDate |
Primitive |
Date and time when the observation plan check was initiated |
LikelyViolations |
Collection |
Collection of likely violations (LikelyViolation markup class) |
ReminderIntervalBeginning |
Primitive |
Time stamp of the beginning of the time interval for which likely observations were checked |
ReminderIntervalEnd |
Primitive |
Time stamp of the end of the time interval for which likely observations were checked. |
Table 4: Properties of the ObservationPlanCheck markup class.
Variable name |
Variable type |
Description |
FeatureId |
Primitive |
Id of the feature for which a likely violation was identified |
FeatureName |
Primitive |
Name of the feature for which a likely violation was identified |
Delta |
Primitive |
The delta calculated for the current check interval. |
Table 5: Properties of the Violation markup class.
