Event Acknowledgement

Acknowledging events in AlphaX helps manage events efficiently by resetting the event status.

Acknowledging Events

AlphaX provides two convenient methods for acknowledging events, allowing you to reset the event status and log these actions for future reference. This functionality helps in managing events efficiently and ensuring that events are ready to be triggered again.

Methods of Acknowledging Events

1. Acknowledging via Email or SMS

   • Description: When an event condition is met, notifications are sent via email and SMS. These notifications contain a reply link that allows you to acknowledge the event.

   • Functionality

     • Clicking the reply link in the email or SMS body will acknowledge the event.

     • Acknowledging an event through this method will reset the event immediately overriding any throttle settings.

   • Example

     • Email Body Hyperlink: "To acknowledge this event and reset the event status, please click [here]."

     • SMS Body Hyperlink: "Acknowledge and reset this event"

2. Acknowledging via URL

   • Description: You can acknowledge events directly by using a specific URL format. This method provides a quick way to acknowledge events programming when events recommendations and actions have been completed.

   • Functionality

     • Access the acknowledgment URL: https://app.alphax.cloud/acknowledge?id=<eventID>&device=<networkID>&channel=<channelID>

     • Replace <eventID>, <networkID>, and <channelID> with the appropriate identifiers for the event you wish to acknowledge and the device that it is associated with.

     • Acknowledging an event via this URL will also reset the event and reactivate it regardless of throttle settings.

   • Example

     • URL Format: https://app.alphax.cloud/acknowledge?id=12345&device=network001&channel=ch001

Logging Acknowledged Events

• Device Logs

  • When an event is acknowledged, an entry is added to the device logs. This log entry provides a record of the acknowledgment action, including the time and the user who performed the acknowledgment.

• Work Order Section

  • Additionally, the acknowledgment action is logged in the specific device's work order section. This helps in maintaining a comprehensive record of all actions taken concerning the device, facilitating better tracking and management.

Acknowledging Events via URL Body

When acknowledging events in AlphaX using the URL method, you need to send a JSON object in the request body. This object contains important information that allows the system to register and log the acknowledgment properly. Below is a detailed explanation of the required JSON object and its fields.

JSON Object for Acknowledging Events

When you access the acknowledgment URL, you need to include the following JSON object in the request body:

jsonCopy code{
    "token": "abc13hgm4cfm",
    "completedDate": "1685532671234",
    "completedDescription": "Issue resolved and monitored.",
    "completedBy": "John Doe"
}

Breakdown of JSON Fields

1. token

   • Purpose: This field is used for authentication or validation purposes. It ensures that the acknowledgment request is coming from an authorized source.

   • Example: "abc13hgm4cfm"

   • Note: The token value should be securely generated and managed.

2. completedDate

   • Purpose: This field records the date and time when the event was acknowledged. It should be in the form of a 13-digit Unix timestamp (milliseconds since epoch).

   • Example: "1685532671234" (corresponding to a specific date and time)

   • Note: Ensure the timestamp is accurate to log the acknowledgment correctly.

3. completedDescription

   • Purpose: This field provides a description of the actions taken to address the event or the current status of the issue. It helps in providing context for the acknowledgment.

   • Example: "Issue resolved and monitored."

   • Note: Keep the description clear and concise, but informative enough to understand the resolution or status.

4. completedBy

   • Purpose: This field records the name of the person who acknowledged the event. It helps in tracking accountability and responsibility.

   • Example: "John Doe"

   • Note: Use the full name or an identifier that clearly indicates who completed the acknowledgment.

Example Acknowledgment Request

Here’s an example of how you might structure the request to acknowledge an event using the URL method:

• URL: https://app.alphax.cloud/acknowledge

• Method: POST

• Request Body:

{
    "id": "ab23gndj",
    "deviceId": "network001",
    "channelId": 1,
    "token": "abc13hgm4cfm",
    "completedDate": "1685532671234",
    "completedDescription": "Issue resolved and monitored.",
    "completedBy": "John Doe"
}

Steps to Acknowledge an Event

1. Prepare the JSON Object: Include the required fields (id, deviceId, channelId, token, completedDate, completedDescription, completedBy) with appropriate values.

2. Send the Request: Use an HTTP POST request to the acknowledgment URL, ensuring that the JSON object is included in the request body.

3. Verify the Response: Check the response from AlphaX to confirm that the event has been acknowledged and logged successfully.

Summary

Acknowledging events via the URL in AlphaX requires sending a structured JSON object containing a token, timestamp, description, and the name of the person acknowledging the event. This process helps ensure proper logging and tracking of acknowledgments, enhancing accountability and providing a clear audit trail. By following the specified format and including all necessary fields, you can effectively manage event acknowledgments in AlphaX.