Element containing the properties associated with the mc-system-alerter workflow.
Type defining the contents of the element defining properties of the task.
element containing alerts associated with the this task.
Type defining the contents of element defining the alerts to be sent for the task.
Element defining an email alert associated with this task.
Element defining an alert which sends an AlarmRequest to the AlarmModule webservice
Element defining an alert which sends a log entry to the configured Azure Service Bus
Type defining the contents of email alert specifications.
Element listing the recipients of the email resulting from this task.
Element defining the configuration of the email sender that will send email for task.
Element defining the subject line for the email generated for the task.
Element defining the text body of the email. It is possible to use the tag %LOG%. The tag %LOG% will be replaced by the log message(s) that contained the event/action Tag (if it mapped to a one_off event)
Element defining the optional attachments for the email.
Type defining the specification of body contents.
content to appear in body of email
Type defining the specification for how recipients are defined.
Element defining details of email recipient.
Type defining the specification of a recipient details.
email address of recipient of email alert
Type defining the specification of contents of configuration element.
Element used to specify the smtp configuration for the alert.
Type defining the specification of contents of configuration element.
name of host on which smtp gateway is running.
port on which smtp gateway is configured.
user from which messages are reported as being sent, also used as the user name in SMTP authentication if the password attribute is supplied.
password for SMTP authentication. If no password or passwordEnvironmentVariableKey is provided, no SMTP authentication will be used.
Alternative to the password, requires OS System Environment Property FEWS_MCSYSTEMALERTER_PASSWORD to be present. If no password or passwordEnvironmentVariableKey is provided, no SMTP authentication will be used.
valid (format) email address from which messages are reported as being sent. If the from address is not
specified, the InternetAddress.getLocalAddress method will be used to set the from address.
Setting tls to true will make sure startTLS process is supported.
This is required for SMTP servers like Microsoft Office 365.
Type defining specification of the contents of the subject.
Element defining the subject line text (that substitutions may be made into).
Element defining the substitutions that should occur in the text of the subject line. Only the
predefined keywords will be substituted and then only if they are specified in the list of
substitutions to take place.
Type defining how substitutions in the subject line should be specified.
Element defining a tag that should be substitued into the subject line.
Type defining how the subject line text is specified.
Type defining how the subject line substitutions are specified.
Type enumerating subject line substitution tags.
Type defining how attachments are specified.
element used to specify an attachment for the message.
Abstract type as placeholder for types defining the specification of attachments.
element used to specify details of the filename to use for the attachment.
attribute used to specify the maximum size of an attachment in KB. For CSV file attachments the last
row that can be fitted into a file will be added and then an extra line indicating that the max
attachment size has been exceeded will be added.
Type used to specify how a filename should be built for attachments.
used to specify the prefix used at the beginning of the filename.
used to specify if filename should include a timestamp. The timestamp will always be GMT and expressed in
the format yyyymmddhhmmss.
Type used to specify how the selection criteria for log entries attachments is made.
Element used to specify that the log contaents should be export and in which format and layout.
Name of a column header for column separated log contents
attribute specifying the column used to determine the order the logs are sorted in.
attribute specifying the maximum number of log entries to include based upon the sort order
specified.
Attribute specifying the maximum age of logs to return specified in hours. The age comparison is
carried out against the same field that is used for the sort order.
attribute specifying a pattern to use to match log event codes.
Attribute used to specify a log level threshold for entries - logs with this level and more severe
will be included.
Type used to specify how the selection criteria for report attachments is made.
Type defining the specification for the contents of a report.
Types used to specify the threshold for the log entries to include.
log table columns that can be used for the sorting of logs.
Type defining how the report selection criteria are specified.
Attribute which specifies if the module instance outputs selected in the report selection are to be
included in the report contents generated for the attachment.
true - the selection criteria are active.
false - the selection criteria are not active.
report selection method that results in the latest reports for each of the listed module instance ids being
included in the report file generated for the attachment.
element is used to list individual module instance run outputs to include.
report selection method that results in all the reports with matching module instance ids and task run ids in the
current module instance table being included in the report generated for the attachment. Only the reports
relating to the module instance ids listed in the reports contents element will be excluded
element is used to list individual module instance run outputs from the current module instance
runs to exclude.
Types used to specify the module instance ids that can be used to select reports for inclusion/exclusion in
report.
Type defining the contents of alarmmodule alert specifications.
URL of the AlarmModule webservice the alarmrequests have to be sent to, e.g. http://alarmserver.deltares.nl:8080/AlarmModuleManager/webservices/
Template of pi Diag Line-like elements to be used to build up the list of log message lines to send as part of the AlarmRequest. The following tags can be specified for substitution:
%LOG% : text of logmessage
%EVENT_CODE%: event code of log message
%MC_ID%: Id of mastercontroller generating the alert
pi Diag Line-like elements to be sent to the alarmModule
Type defining the message content that can be sent to the Azure Service Bus
URL of the Azure Service Bus, for example: sb://fffs-eventcode-service-bus.servicebus.windows.net/
Endpoints on the Azure Service Bus the messages should be sent to. Can be either a service bus queue or topic endpoint.
Topic example: https://fffs-eventcode-service-bus.servicebus.windows.net/fews-eventcode-topic/messages
Queue example: https://fffs-eventcode-service-bus.servicebus.windows.net/fews-eventcode-queue/messages
Name of the Shared Access Policy key that is used when sending a message to the Azure Service Bus. The Send claim has to be assigned to this policy. Example: ServiceBusSendingSharedAccessKey
Value of the Shared Access Policy key that is used when sending a message to the Azure Service Bus. Example value: feznB/MekxZ1qwHQfCThSOP/Ih/q0HK/xewTglBTInQ=
content type of the message that is sent to the service bus. Default is text/plain. Content type is used to escape the parameters in the serviceBusMessagePayLoad.
payload of the service bus message send as part of the Azure Service Bus Messages. The following tags can be specified for substitution:
%LOG% : text of log message. In case xml is used as content type, it is advised to use a CDATA block for the log message to avoid xml encoding issues.
%EVENT_CODE%: event code of log message
%MC_ID%: id of master controller generating the alert
payload of the messages that will be sent to the service bus in the template format.
Types used to specify the content that is sent to Service Bus.
Type defining elements of augmented piDiag Lines
Severity level, most likely ignored. (hint: use 1 for now)
3 = info (information, all is well, e,g, :"SOBEK: program ended")
2 = warn (warning information.e.g. "SOBEK: high number of iterations")
1 = error (critical problems. e.g. "SOBEK: no convergence")
0 = fatal (full module crash. e.g. "SOBEK: ooops, what now?")
All levels higher than 3 are regarded as non-essential (debug) information
The description of the alarm, usually the text of the log message. Use %LOG% in template to be substituted by log message text.
The source of the alarm request, usually the MC ID. Use %MC_ID% in template to be substitued by the ID of the MC generating the alert.
The event code for the alarm request, usually the event code of the log message. Use %EVENT_CODE% in the template to by subsitituted by the log message event code.
The source of the alarm request, usually the MC ID. Use %MC_ID% in template to be substitued by the ID of the MC generating the alert.
The event code for the alarm request, usually the event code of the log message. Use %EVENT_CODE% in the template to by subsitituted by the log message event code.
File formats of log contents