Alert Variables

Advanced Alerting User Guide

Actions

The Actions section enables you to decide what actions to take after your alert is triggered. You can take multiple actions all at once for a single action group, which may include sending emails to multiple users and dispatching messages to multiple channels. Image of the Actions pane. Protocols All protocols also support Velocity Variable Replacement. You can use any of the following Alert Variables, or any Global Map variable. Channel: The template is sent as a message to the channel selected in the Recipient column. The subject is not used for this protocol. Email: The subject and template is used to send an email to the address specified in the Recipient column. User: Same as the Email protocol, the email address used is the one configured for the selected user. Role: Emails are sent to all users within a particular Role-Based Access Control role. Only visible when the Role-Based Access Control extension is installed. Alert Variables A list of general variables that you can use to

Mirth® Connect by NextGen Healthcare User Guide

Alert Variables

alertId: The unique ID of the alert. alertName: The name of the alert. serverId: The unique ID of the server. globalMapVariable: Indicates that you can use any variable in the global or configuration maps. date: The current date, formatted as a human-readable string. systemTime: The current epoch time in milliseconds. error: The full error message, including (where applicable) the source code, line number, and error details. errorMessage: If an exception is associated with the error event, this will be the message or detail of the exception. errorType :The category of the error. For additional information, see Alert Error Types and Regex. channel Id: The ID of the channel associated with the error, if applicable. channelName: The name of the channel associated with the error, if applicable. connectorName: The name of the connector associated with the error, if applicable. connectorType: The type of the connector associated with the error, if applicable. messageId: The ID of the message

Advanced Alerting User Guide

Channel Error

The Channel Error type triggers whenever a channel encounters an error. You can decide what type of errors you want your alert to trigger on. This includes choosing among categories of error types, and optionally using a regular expression that only allows events whose error source, error message, or exception stacktrace matches. An image of the Errors section. Alert Error Categories Any: Select this option to trigger on all error categories. Source Connector: An error that originated from the source connector during deploy/start, receiving a message, or sending a response. Destination Connector: An error that originated from a destination connector during deploy/start, dispatching a message, or receiving a response. Serializer: An error that originated from the source or destination filter/transformer script, specifically when serializing the message to the internal representation (such as XML), or deserializing the message to the outbound data type format. Filter: An error that origi

Mirth® Connect by NextGen Healthcare Advanced Clustering User Guide

Advanced Alerting

With the Advanced Alerting plugin installed, there will also be a new trigger type available, Clustering Channel Synchronization: When the channel synchronization process detects that an action should be taken, it will first send a Submitted event that can be triggered on. When that action finishes, it will send one of these two triggerable events: Succeeded: The task finished without any errors. Failed: The task finished with errors. This usually means that the channel was not able to be deployed/started/etc. With this event, the "exception" variable containing the full error stacktrace will be available in the template context. In addition to all of the regular template variables that are available in alert template contexts, this trigger also adds the following variables: Variable Description action The channel or connector action being taken. Will be one of: Deploy, Undeploy, Start, Stop, Pause, Resume event The stage of the current task. Will be one of: Submitted, Succeeded, Faile

Mirth® Connect by NextGen Healthcare User Guide

Channel Properties

Item Name Description A Name The name of the channel. Only alphanumeric (a-z / 0-9) characters, spaces, hyphens, and underscores are allowed. B Enabled Indicates whether the channel is ready to be deployed. All enabled channels will automatically be deployed with the Mirth® Connect by NextGen Healthcare server starts up. If there is an error in your channel configuration, this will automatically be unchecked. C Set Data Types Dialog Configure data types across your entire channel, from the source connector to each of your destination connectors. Allows easy bulk editing of data type properties. For additional information, see Set Data Types. D Clear global channel map on deploy If checked, the global channel map for this channel will be cleared out whenever the channel is redeployed. E Set Dependencies Configures Code Template Libraries, Library Resources, and Deploy/Start Dependencies for this channel. For more information, see Set Dependencies Window. F Initial State Determines what

Mirth® Connect by NextGen Healthcare User Guide

Edit Alert View

Use the Edit Alert view to configure and modfiy alerts. An alert is a process that listens for certain types of events and triggers based on configurable settings. From these triggers you can take various actions, like dispatching an e-mail to a user or specific address, or sending a message to a channel. Mirth® Connect by NextGen Healthcare comes with a built-in Error-based alerting system that listens for error events from selected channels. The Advanced Alerting extension adds on this by also including powerful metric-based alerts, escalation levels, scheduling, notification throttling, and other advanced features. The Edit Alert view is where alerts are configured / modified. Once saved, an alert will be displayed on the Alerts view, which is like a dashboard for your currently configured alerts. Image of the Edit Alert view Navigation Alert Error Types and Regex Alert Enabled Channels Alert Actions Edit Alert Tasks Parent topic: Edit Views

Alert Variables

Recommendations

Actions

Alert Variables

Channel Error

Advanced Alerting

Channel Properties

Edit Alert View

Actions

Alert Variables

Channel Error

Advanced Alerting

Channel Properties

Edit Alert View