Manufacturing Connect User UI
...
Events and Alerts
Alerts

Set Up Alert Triggers

12min

Note: The user interface below is for Manufacturing Connect version 2.10.0 and later.

You can add a user alert trigger for edge devices in the Triggers section in the Alerts module.

Important: Triggers require an action for notification implementation.

Variables change depending on the Source selected.

Before You Begin

Add an action to the Action List to receive a notification. See Add new Action for details.

Step 1: Select and Set Up Source

Completing the Source section first avoids issues with the variables for the Subject and Message fields in the Trigger section. The source is the type of condition needed to trigger an alert.

Source section
Source section


Note: When a Google Cloud Platform (GCP) Marketplace-deployed Manufacturing Connect is upgraded (See Install / Upgrade Manufacturing Connect) from an earlier version to version 2.10.0, Metrics-based alerts will not function. These GCP Marketplace-deployed Manufacturing Connect instances must be backed up, reinstalled and restored (See Export/Import and Install / Upgrade Manufacturing Connect) for Metrics-based alerts to function.

To select a source:

  1. Select a Source. The options are:
    • Metrics: The Trigger section's Subject and Message fields will be hidden and disabled.
    • Events: The Trigger section's Subject and Message fields will be revealed and enabled.
  2. Click the Add link to add a new rule. The rule table drops down. The rule table is dependent on your source selection.

Step 1a: Set Up Metrics Source

Select a metrics source to set up an alert that triggers based on metrics collected by Manufacturing Connect, specifically when the value of a variable is a certain desired value or certain set/interval of values. You may create only one metrics rule per alert.

Metrics Source
Metrics Source


To set up a metrics source:

  1. From the Select Alert template drop-down list, select an alert template. The options are:
    • Connector disk buffer | Integration
    • Connector online status | Integration
    • DH device online status | Device Hub
    • DH device data quality | Device Hub
    • Edge Device online status | Edge Device
    • Edge Device license expiration | Edge Device
    • Edge Device free disk space | Edge Device
    • Edge Device memory available | Edge Device
    • Edge Device CPU idle | Edge Device
  2. For the alert template you've chosen, for each of it's respective fields, enter a respective value.

Step 1b: Set Up Events Source

Select an events source to set up an alert that triggers when a specific event occurs. 

Events Source
Events Source


To set up an events source:

  1. From the Severity drop-down list, select an option.
    • All
    • Info
    • Warning
    • Alert
  2. From the Component drop-down list, select an option.
    • All
    • cc - Integrations
    • mp - Marketplace
    • dh - Device Hub
    • auth - Auth
    • dm - Device Management
  3. From the Event ID drop-down list, select an option. Options are dependent on the Component selected. See Event ID for User Alert Triggers.
  4. (Optional) Click Show Event Attributes..., for each of the event attributes, enter a value.
  5. (Optional) In the Info field, enter a value.
  6. Repeat with additional new rules by clicking the Add new rule button as needed.

Step 2: Set Up Trigger

Note: In Manufacturing Connect version 2.13.0 and later, you can customize the subject and message of the trigger alert with your preferred text in addition to the variables.

You can customize the trigger's subject/message contents that will be sent to a recipient. The visibility of the Subject and Message fields are dependent on the Source selection from Step 1.

Metrics version
Metrics version

Events version
Events version


Subject and Message Variables

You can select from the following variables in the trigger subject and message:

  • $devicename: The name of the associated edge device . (For example: Manufacturing Connect Edge (08:00:23:18:r5:32).
  • $name: The name of the associated connector or DeviceHub device. (For example: PLC_2)
  • $alertDelay: The alert delay parameter configured for the trigger.
  • $value: The current value associated with the connector or DeviceHub device that is being monitored. (For example: connector disk buffer of 98MB)
  • $company: The company associated with the edge device for the trigger.
  • $deviceid: The associated edge device ID. (For example: 9udklweoidslsdd0lksdjfslkd)
  • $project: The project associated with the edge device for the trigger.
  • $targetValue: The target value configured for the trigger. (For example: 50MB for Connector disk buffer)
  • $componentid: The associated component for the event trigger: cc - Integrations, mp - Marketplace, dh - Device Hub, or auth - Auth.
  • $message: The associated event message for the trigger.
  • $triggerid: The associated trigger ID.
  • $hostname: The associated host name for the trigger.
  • $tags: The associated tags for the trigger.
  • $severity: The severity level selected for the trigger: Info, Warning, or Alert.
  • $triggername: The name configured for the trigger.
  • $type: The associated event type for the trigger.
  • $eventid: The event ID associated with the trigger.

To set up the trigger:

  1. In the Name field, enter a name for the trigger.
  2. (Optional) Click the Active check box to set an active trigger flag.
  3. (Optional) Click the Dashboard check box to show trigger alerts on dashboard.
  4. In the Description field, enter a description for the trigger.
  5. In the Subject field, select one or more variables. In Manufacturing Connect version 2.13.0 and later, you can enter your preferred text in addition to selected variables.
  6. In the Message field, select one or more variables. In Manufacturing Connect version 2.13.0 and later, you can enter your preferred text in addition to selected variables.

Step 3: Set Up Scope

You can customize the scope of the user triggers. This will determine the applicable edge device(s) that will receive this alert trigger.

Scope section
Scope section


To set up the scope:

  • From the Scope section, select an option .
    • All edge devices
    • Edge Device. From the Edge Device drop-down list, select an edge device.

Step 4: Set Up Action

You must create an action to use this section. You can select the response action that will immediately occur after the alert is triggered.

Action section
Action section


To set up the action:

  1. Select an option from the Action List drop-down list.
  2. (Optional) Select the Continuously check box.
    • If you have checked Continuously, enter a value in the Notification Period field in minutes.
  3. Click Save. The alert trigger appears in the Trigger List.