Events Hub Manage View

The manage view in Events Hub is a comprehensive interface that allows you to configure events. This guide will provide an explanation of the manage view, its sections, and functionalities.

The manage view in Events Hub is a robust interface that allows you to configure and monitor events in detail. By understanding and utilizing each section, you can efficiently manage your events, ensuring they are accurately set up and effectively monitored. Use this guide to navigate the manage view and leverage its full capabilities.

Accessing the Manage View

You can access the manage view in two ways.

1. From the List View: Click the manage action button (gear icon) on the right side of an event in the list view.

2. From the Device Detail Events Tab: Click the event manage action button in the device detail events tab.

Event Manage View

Overview of the Manage View

The manage view is divided into several logical sections, each containing specific settings and information related to the event. These sections can be opened or collapsed by clicking on their titles.

1. Alert Status

• Alert Mode: Toggle between Manual and Auto modes.

• Alert Status: Shows whether the alert is Active or Inactive.

2. Alert Information

• Alert Name: Field to set the name of the alert.

• Entity: Dropdown to select the entity associated with the event.

3. Alert Condition

• Condition Mode: Toggle between "All" or specific conditions.

• Condition Label: Field to label the condition.

• Limit: Field to set the limit value.

• Alert Condition: Dropdown to specify the alert condition type.

• Add New Condition: Button to add more conditions as needed.

• Delete Button: Each alert condition has a Delete icon next to it. When the user clicks this icon, a confirmation window will appear, asking whether they want to proceed with deleting the selected condition.

Delete Confirmation Window The confirmation window displays the message: "Are you sure you want to delete this Alert Condition?" This gives the user a chance to review the action before confirming the deletion.

4. Action Settings

• This section allows you to define the actions that will be taken when the alert conditions are met

5. Sensors

• This section provides settings related to the sensors involved in the event.

6. Notes

• Free Text Space: Allows users to add notes related to the event. Useful for adding context, reminders, or additional information.

7. Logs

• Audit Trail: Displays a full history of all events associated with the current event, including edits, actions taken, and notifications sent. This helps in tracking the event's history and any changes made.

8. Administration

• Created By and Date: Shows who created the event and when.

• Last Edited By and Date: Shows who last edited the event and when.

Detailed Sections

Some sections of the manage view contain more detailed configurations that will be explained on separate pages. These include:

Event Status

• Details about the event's current operational status and how it is managed within the system.

Event Conditions

• Comprehensive setup of the conditions that trigger the event, including multiple condition configurations.

Event Actions

• Specifications of actions that will be executed when the event conditions are met, such as notifications, data processing, or system commands.

Event Sensors

• Detailed settings related to the sensors that provide the data for the event triggers.

Using the Manage View

Managing Alert Information

1. Set Alert Name: Enter a descriptive name for the alert.

2. Select Entity: Choose the appropriate entity from the dropdown menu.

Configuring Alert Conditions

1. Choose Condition Mode: Toggle between "All" conditions or specific conditions.

2. Label Conditions: Provide a label for each condition.

3. Set Limits: Enter the threshold values for conditions.

4. Specify Alert Conditions: Select the type of condition (e.g., value goes above limit).

Adding Notes

1. Enter Notes: Use the free text space to add any relevant information or context about the event.

Reviewing Logs

1. Audit Trail: Check the logs section to see a detailed history of actions, edits, and notifications related to the event.

Viewing Administration Details

1. Creator Information: View who created the event and when it was created.

2. Last Editor Information: View who last edited the event and when it was edited.

Events Status

The Event Hub Status section allows users to control the activation and monitoring of events based on specific conditions. Here’s a detailed explanation of its features and functionalities.

Auto Alert Mode

The Event Hub Status section provides a flexible and intuitive way to manage when events are actively monitored. By using Auto mode, you can set specific conditions based on time periods to ensure events are only active when needed. Manual mode offers straightforward control for quick activation or deactivation. Utilise these settings to optimise event monitoring and ensure efficient system performance.

Alert Mode

Auto Mode

• Description: In Auto mode, the event's monitoring status automatically changes based on user-defined conditions.

• Functionality:

  • The system monitors the specified conditions (days of the week, hours of the day, and months of the year).

  • If the conditions are met, the event will not be monitored and will not be triggered.

  • Example: If an event should only be active during weekdays from 9 AM to 5 PM in January, set the conditions accordingly. Outside these conditions, the event will not be monitored.

Manual Alert Mode

Description: In Manual mode, users can manually set the event to be either Active or Inactive.

Functionality

• Active: The event is actively monitored and can be triggered.

• Inactive: The event is not monitored and cannot be triggered.

Setting Conditions in Auto Mode

Months Alert is Active

Description: Allows users to select the months during which the event should be active.

Functionality:

• Click on the month buttons to toggle them on or off.

• Green Button: The event is active during this month.

• Gray Button: The event is inactive during this month.

Days Alert is Active

• Description: Allows users to select the days of the week during which the event should be active.

• Functionality

  • Click on the day buttons to toggle them on or off.

  • Green Button: The event is active on this day.

  • Gray Button: The event is inactive on this day.

Hours Alert is Active

• Description: Allows users to select the hours of the day during which the event should be active.

• Functionality

  • Use the slider to set the active hours range.

  • Green Bar: Indicates the hours during which the event is active.

  • Adjust the start and end points to define the active time range.

Using the Event Hub Status Section

1. Selecting Alert Mode

   • Toggle between Auto and Manual modes using the switch.

2. Setting Manual Mode

   • Switch to Manual mode.

   • Set the event to Active or Inactive using the toggle.

3. Configuring Auto Mode

   • Switch to Auto mode.

   • Select the active months by clicking the respective month buttons.

   • Select the active days by clicking the respective day buttons.

   • Adjust the slider to set the active hours range.

4. Activating/Deactivating Time Periods

   • Click on the month, day, or adjust the hours slider to toggle the event's activity status for those periods.

   • Green indicates active periods, and Gray indicates inactive periods.

Example Configuration

Scenario: Active during Weekdays in Business Hours of January

1. Select Auto Mode.

2. Months: Click on "JAN" to keep it green (active) and click on other months to turn them Gray (inactive).

3. Days: Click on "MON", "TUE", "WED", "THU", and "FRI" to keep them green (active) and click on "SAT" and "SUN" to turn them Gray (inactive).

4. Hours: Adjust the slider to cover 9 AM to 5 PM (9 to 17 on the slider).

Event Conditions

AlphaX allows you to set up various alert conditions to monitor system events and trigger alerts based on predefined criteria. This guide explains how to configure these alert conditions.

Alert Condition View

By following these guidelines, you can effectively monitor and manage system events in AlphaX, ensuring timely alerts and responses to critical situations.

Understanding Condition Modes

1. First Mode

   • This mode matches the first condition that is true from the top of the list.

   • Once a condition is matched, it stops processing further conditions.

   • Useful when you want the system to trigger an alert immediately upon meeting the first criterion.

2. All Mode

   • This mode evaluates all the conditions in the list.

   • Useful when you need all specified conditions to be evaluated and potentially trigger multiple alerts.

Types of Conditions

AlphaX supports three types of conditions:

1. Value-Based Conditions

   • Options: Above, Equal, Below

   • Use this type to trigger alerts based on numerical values.

   • Example: Trigger an alert if a temperature sensor reads below 70 degrees.

2. Status-Based Conditions

   • Options: Payload Received, Device Offline, Error Code

   • Use this type to monitor specific status events of devices or systems.

   • Example: Trigger an alert when a device goes offline or an error code is received.

3. AI-Based Conditions

   • Option: Anomaly Detected

   • Use this type to leverage AI to detect unusual patterns or behaviours.

   • Example: Trigger an alert when the system detects an anomaly in data patterns.

Configuring Alert Conditions

1. Adding a Condition

   • Click the + Add New Condition button.

   • Enter a Condition Label to describe the condition.

   • Set the Limit value if applicable (e.g., 70 for Below 70% Capacity).

   • Choose an Alert Condition from the dropdown (e.g., Payload Received, Error Code).

2. Deleting a Condition

   • Click the trash can icon to the right of the condition you wish to delete.

Example Setup

Condition 1: Data Sent

• Condition Label: Data Sent

• Limit: 0

• Alert Condition: Payload Received

Condition 2: Below 70% Capacity

• Condition Label: Below 70% Capacity

• Limit: 70

• Alert Condition: Value goes below limit

Condition 3: Error Received

• Condition Label: Error Received

• Limit: 434

• Alert Condition: Error Code

Tips for Effective Alert Management

• Prioritise Conditions: When using First Mode, arrange conditions by priority to ensure the most critical alerts are processed first.

• Monitor Critical Systems: Use status-based conditions to keep an eye on vital system statuses like device connectivity and error codes.

• Leverage AI: Incorporate AI-based conditions to detect and respond to unusual patterns that might not be immediately obvious through value-based conditions.

Event Actions

AlphaX provides several action options that can be triggered when an alert condition is met. This explains how to configure these actions to ensure you receive timely notifications and responses.

Action Settings View -1

By configuring these actions, AlphaX ensures that alerts are communicated effectively, allowing for timely responses and minimizing downtime. Adjust the action settings based on your specific operational needs and the criticality of the systems being monitored.

Available Actions

1. Email Notification

   • Sends an email to the specified addresses when an alert condition is met.

   • Useful for immediate notification to stakeholders.

2. SMS Notification

   • Sends an SMS to the specified phone numbers.

   • Ideal for critical alerts that require quick attention, especially when email might not be immediately checked.

3. HTTP

   • Makes an HTTP request to a specified endpoint.

   • This can be used to integrate with other systems, trigger webhooks, or log events in external services.

4. Control

   • Executes a control action within the AlphaX system.

   • This can be used to automate responses, such as shutting down a machine, restarting a service, or changing a configuration.

5. MQTT

   • Publishes a message to an MQTT broker.

   • Useful for IoT applications where devices and services communicate through the MQTT protocol.

Configuring Email and SMS Notification Settings

Action Settings View

AlphaX allows you to set up notifications to ensure timely alerts through both email and SMS. Additionally, it can provide AI-powered insights to help understand the root causes and provide recommendations. Here's how to configure these settings.

Active Actions

1. Email Notification

   • Purpose: Sends an email to the specified recipients when an alert condition is met.

   • Configuration

     • Notify List: Enter the email addresses of the recipients. In the example, it's [e-mail].

     • Notification Subject: Provide a clear and concise subject for the alert email. In this case, "Bin level over 70% used".

     • Notification Body: Include a detailed message that explains the alert. Here, it states, "Bass Coast Bin level over 70% used".

NOTE: A default body is also attached to the email. The notification body users set is in addition to the default body

1. SMS Notification

   • Purpose: Sends an SMS to the specified phone numbers for immediate alerts.

   • Configuration

     • Similar to email notifications, you will need to specify the phone numbers and message content. Ensure the message is concise due to SMS character limits.

Example Configuration

• Active Actions:

  • Email Notification: Enabled

  • SMS Notification: Enabled

• Notify List:

  • Email: [e-mail]

• Notification Subject: "Bin level over 70% used"

• Notification Body: "Bass Coast Bin level over 70% used"

• AI:

  • Recommendations: Enabled

  • Root Causes: Enabled

AI Insights

AlphaX includes AI capabilities to enhance the usefulness of notifications by providing additional insights:

1. Recommendations

   • Purpose: Analyses data and provides suggestions on the best actions to take in response to the event based on current conditions.

   • Example: If a bin level is over 70%, the AI might recommend scheduling an additional pickup or checking for obstructions.

2. Root Causes

   • Purpose: Analyses data to determine possible causes of the alert condition and provides these to the user in the notification body.

   • Example: For a bin level alert, the AI might identify increased usage due to a nearby event or an issue with the regular pickup schedule.

Configuring HTTP Event Actions in AlphaX

HTTP View

AlphaX allows you to configure HTTP actions to interact with external systems whenever an alert condition is met. This guide provides detailed instructions on setting up HTTP event actions.

HTTP Event Actions Settings

1. Enable HTTP Action

   • Check the box next to HTTP to activate the HTTP action.

2. HTTP URL

   • Purpose: Specifies the endpoint URL that the HTTP request will be sent to.

   • Example: https://xxx.mysite.com/createMyWorkorder

   • Ensure the URL is correctly formatted and accessible from the AlphaX system.

3. Headers

   • Purpose: Allows you to include additional information in the HTTP request header.

   • Example Header

     • Key: token

     • Value: abcxxx

   • Add headers by clicking the + Add Header button. You can add multiple headers as needed for authentication or other purposes.

4. HTTP Method

   • Purpose: Specifies the format and encoding of the HTTP request body.

   • Options,

     • Plain text: Sends the data as plain text.

     • Multipart Form: Sends the data as a multipart form, typically used for file uploads.

     • x-www-form-urlencoded: Sends the data as key-value pairs encoded in the URL.

     • JSON: Sends the data in JSON format, commonly used for APIs.

   • Select the appropriate method based on the requirements of the receiving endpoint.

NOTE: POST body is provided in standard AlphaX API format with 2 additional objects embedded. One object contains the matched condition data. The second object contains AI descriptions and information (If selected).

Example Configuration

Scenario: Creating a Work Order

• HTTP URL: https://xxx.mysite.com/createMyWorkorder

• Headers:

  • Key: token

  • Value: abcxxx

• HTTP Method: JSON

Steps to Configure

1. Activate HTTP Action

   • Ensure the HTTP action checkbox is checked.

2. Enter the HTTP URL

   • Type the endpoint URL in the HTTP URL field.

3. Add Headers

   • Click + Add Header to add a new header.

   • Enter the header key (token) and value (abcxxx).

   • Add more headers if necessary by repeating the process.

4. Select HTTP Method

   • Choose the method that matches the expected input format of your endpoint. For example, select JSON if the endpoint expects JSON formatted data.

Usage Tips

• Authentication: Use headers to include tokens or API keys for authenticated requests.

• Data Formatting: Ensure the data sent in the HTTP request matches the expected format of the endpoint to avoid errors.

• Testing: Test the HTTP action with your endpoint to confirm it works as expected before relying on it for critical alerts.

By configuring HTTP event actions, you can seamlessly integrate AlphaX with external systems, automating workflows such as creating work orders, logging events, or triggering additional processes. This enhances the responsiveness and efficiency of your operations.

Configuring Event Controls in AlphaX

Control Element

Event controls in AlphaX allow you to automate responses to specific alert conditions by changing the state of control elements within your system. This guide explains how to configure these controls to ensure efficient and automated management of your devices and systems.

Understanding Event Controls

Event controls enable AlphaX to automatically perform actions such as turning equipment on or off, adjusting settings, or executing predefined commands in response to specific conditions being met.

Steps to Configure Event Controls

1. Enable Control Action

   • Check the box next to Control to activate the control action.

2. Select Control Element

   • From the dropdown menu, choose the control element you want to manage.

   • Example: SM01LW Pump Control [Seven Mile Waste Facility]

   • Ensure you select the correct control element that corresponds to the device or system you wish to control.

3. Set Control State

   • Use the toggle switch to set the desired state of the control element when the alert condition is met.

   • Options

     • On: Turns the control element on.

     • Off: Turns the control element off.

   • Example: Setting the pump control to On activates the pump when the specified alert condition is triggered.

Example Configuration

Scenario: Automatically Activating a Pump

• Control Element: SM01LW Pump Control [Seven Mile Waste Facility]

• Control State: On

Steps to Implement

1. Enable Control Action

   • Ensure the Control action checkbox is checked.

2. Select the Control Element

   • Choose SM01LW Pump Control [Seven Mile Waste Facility] from the dropdown menu.

3. Set the Control State

   • Toggle the switch to On to ensure the pump is activated when the alert condition is met.

Use Case Scenarios

1. Automated System Responses

   • For instance, if a waste bin level exceeds 70%, the system could automatically turn on a pump to start compacting the waste.

2. Safety and Emergency Management

   • Automatically turning off machinery if an error condition is detected to prevent damage or hazards.

3. Operational Efficiency

   • Adjusting lighting, heating, or cooling systems based on occupancy or environmental conditions detected by sensors.

Summary

By configuring event controls in AlphaX, you can automate your system's response to specific conditions, ensuring timely and efficient management of devices. This automation reduces the need for manual intervention, improves safety, and enhances operational efficiency. Adjust the control elements and states according to your specific requirements and operational needs.

Configuring MQTT Event Actions in AlphaX

MQTT View

MQTT (Message Queuing Telemetry Transport) event actions in AlphaX allow you to publish messages to an MQTT broker in response to specific alert conditions. This guide explains how to set up MQTT event actions to ensure effective communication between AlphaX and your IoT devices or systems.

MQTT Event Actions Settings

1. Topic

   • Purpose: The topic on which the message will be published.

   • Example: /mytopic/xyz/123

   • Ensure the topic follows the MQTT topic naming conventions and is appropriate for your message.

2. Message

   • Purpose: The actual content of the message that will be sent to the MQTT broker.

   • Example: This is an additional body of text

   • The message should be clear and contain all necessary information relevant to the alert condition.

3. Username/User ID

   • Purpose: The username or user ID for authenticating with the MQTT broker.

   • Example: myUsername

   • Ensure this matches the credentials configured on the MQTT broker.

4. Password

   • Purpose: The password for the MQTT broker.

   • Example: ****** (typically shown as asterisks for security)

   • Ensure this is kept secure and matches the credentials on the MQTT broker.

5. Host/Server

   • Purpose: The hostname or IP address of the MQTT broker.

   • Example: mqtt.alphax.cloud

   • Ensure the broker is accessible from the AlphaX system and correctly configured to accept connections.

Example Configuration

Scenario: Publishing a Message to an MQTT Topic

• Topic: /mytopic/xyz/123

• Message: This is an additional body of text

• Username/User ID: myUsername

• Password: ******

• Host/Server: mqtt.alphax.cloud

Steps to Implement

1. Enable MQTT Action

   • Ensure the MQTT action checkbox is checked to activate this action.

2. Configure the Topic

   • Enter the topic in the Topic field where the message will be published.

3. Compose the Message

   • Write the message content in the Message field. Ensure it contains all necessary information related to the alert.

4. Enter Credentials

   • Provide the Username/User ID and Password for authentication with the MQTT broker.

5. Set the Host/Server

   • Enter the hostname or IP address of your MQTT broker in the Host/Server field.

Use Case Scenarios

1. Device Monitoring

   • Publish messages to specific topics to notify devices of status changes or instructions.

   • Example: Notify a device to start a specific task when a condition is met.

2. Data Collection

   • Send sensor data to an MQTT broker for real-time processing and monitoring.

   • Example: Publish temperature readings to a central monitoring system.

3. Alert Notifications

   • Notify administrators or systems of critical events by publishing messages to relevant topics.

   • Example: Publish a high-priority alert to a topic monitored by an incident response system.

Summary

By configuring MQTT event actions, you enable AlphaX to communicate effectively with MQTT-enabled devices and systems, facilitating real-time data exchange and automation. Ensure all fields are correctly configured to establish a secure and reliable connection with your MQTT broker. Adjust the settings based on your specific use case and operational requirements.

NOTE: MQTT message is provided in standard AlphaX API output format with 3 additional objects embedded. One object contains the matched condition data. The second object contains AI descriptions and information (If selected). The third is the MQTT message text box.

Configuring Throttle Events in AlphaX

Throttle View

Throttle events in AlphaX are used to control the frequency of actions triggered by alert conditions, preventing repetitive alerts and ensuring that actions are not executed too frequently. This guide explains how to configure throttle settings effectively.

Throttle Settings

1. Throttle Active

   • Purpose: Enables throttling to limit the number of times an action is triggered within a specified time period.

   • Example: Ensuring an action is not triggered more than once every 24 hours.

2. Limit 1 Action Per

   • Purpose: Defines the time interval during which only one action can be triggered.

   • Example: Setting the interval to 24 hours means that once an action is triggered, no further actions will be triggered for the next 24 hours, regardless of how many times the alert condition is met.

Example Configuration

Scenario: Limiting Notification Frequency

• Throttle Active: Enabled

• Limit 1 Action Per: 24 hours

Steps to Implement

1. Enable Throttle

   • Check the box next to Throttle Active to activate throttling for the selected action.

2. Set the Throttle Interval

   • Enter 24 in the Limit 1 Action Per field.

   • Select Hours from the dropdown menu to set the interval to 24 hours.

Use Case Scenarios

1. Preventing Alert Fatigue

   • Avoid overwhelming users with too many notifications by limiting the frequency of alerts.

   • Example: If a sensor frequently reports a minor issue, throttling ensures users receive only one notification per day, reducing annoyance and focusing attention on significant issues.

2. System Stability

   • Protect system resources by preventing actions from being executed too frequently.

   • Example: Limiting the number of times a control command is sent to a device, ensuring it is not overloaded with repeated commands.

3. Resource Management

   • Efficiently manage resources by controlling the frequency of actions that might consume bandwidth or processing power.

   • Example: Limiting HTTP requests to external systems to avoid excessive API calls.

Summary

By configuring throttle settings in AlphaX, you can effectively manage the frequency of actions triggered by alert conditions, ensuring that notifications and commands are executed at appropriate intervals. This helps to prevent alert fatigue, protect system stability, and manage resources efficiently. Adjust the throttle settings based on your specific.

Event Sensors

The Event Sensors section in AlphaX is designed to provide a clear and manageable overview of all sensors and devices being monitored by the event.

Sensors View

Understanding the Event Sensors Section in AlphaX

The Event Sensors section in AlphaX provides a comprehensive overview and management interface for sensors and devices being monitored. This guide explains the components and functionalities of the Event Sensors section to help you effectively manage your monitoring setup.

Overview of the Sensors Table

The table in the Event Sensors section displays a list of all sensors and devices being monitored. Here's a breakdown of the key components and functionalities.

1. Buttons in the Top Right

   • Manage Sensors: Opens a management interface for configuring and managing the sensors.

   • Add Sensors: Opens a modal window that allows you to add new sensors and devices to the monitoring list.

2. Filter in the Top Left

   • Filter Box: Allows you to filter the list of sensors by specific criteria. Enter text to quickly search for a particular sensor or device based on its attributes.

3. Pagination in the Bottom Right

   • Previous/Next Buttons: Navigate through pages if there are multiple entries. This helps in managing large lists of sensors.

Table Fields

The table includes several fields describing the sensors and devices.

1. Channel ID

   • Unique identifier for each sensor channel.

2. Channel Description

   • Brief description of what the sensor measures or its purpose.

   • Example: "Raw Distance"

3. Device Name

   • The name of the device to which the sensor is attached.

   • Hyperlinked to access the device management page, allowing for detailed configuration and status checks.

4. Device Tag

   • A tag or identifier for the device.

   • Example: ZZZ-BINS-001

5. Value

   • Current reading or value from the sensor. This field might be empty if no data is currently available.

6. Status

   • Indicates the current status of the sensor.

   • Example: OK for normal operation, other statuses might indicate issues or warnings.

7. Last Seen

   • Timestamp of the last communication from the sensor.

   • Example: Never if the sensor has not yet reported data.

8. Actions

   • Includes a delete button (trash can icon) that allows you to remove the sensor or device from the monitoring list.

Adding and Managing Sensors

1. Managing Sensors

• Click the Manage Sensors button to access the sensor management interface.

• Add Sensors: Add new sensors and devices to your monitoring system for a specific alert.

• Show Hidden Channels: Toggle visibility of additional sensor channels that might be hidden.

• Save Changes: After selecting or removing sensors, click Save to confirm changes. This will reset the alert status of all selected sensors.

1. Deleting Sensors

• In the Actions column, click the trash can icon next to a sensor to remove it from the list.

Warning ! : This action will permanently delete the sensor from your monitoring setup.

Summary

The Event Sensors section in AlphaX is designed to provide a clear and manageable overview of all sensors and devices being monitored. Utilize the filtering, pagination, and management buttons to effectively navigate and manage your sensor data. The hyperlinked device names allow for quick access to detailed device management pages, enhancing your ability to configure and monitor your system efficiently.