AlphaX
  • WORKSPACE
    • Data Table List View
      • AI View
    • Map
  • Analysis
    • Overview
    • Anomalies
      • Batch Detection
      • Change Point Detection
      • Streaming Detection
      • User interface
        • Anomaly List View
        • Anomaly Edit View
        • Anomaly Chart View
        • Anomaly Share View
      • Analysis List View
    • TOOLBOX
      • Analysis
        • Charts
          • Charts View
          • Drawings View
          • Data View
        • Table
        • Anomaly
      • Reports
        • Reports List View
          • Create a New Report
        • Reports Manage View
      • Device
        • Devices List View
          • Create New Device Registration
        • Devices Manage View
      • API Endpoints
        • API Endpoints List View
          • Create a New Feed
        • API Endpoints Manage View
      • Integrations
        • Integrations List View
          • App
        • Integrations Manage View
      • Dashboards
        • Dashboards List View
          • Create a New Dashboard
        • Dashboards Manage View
      • Alerts
        • Events Hub List View
        • Events Hub Manage View
        • Event Data Format
        • Event Acknowledgement
      • Calculations
        • Calculations List View
          • Create a New Calculation
        • Calculations Manage View
      • Controls
        • Controls List View
          • Create a New Control Element
        • Controls Manage View
  • Data Hub
    • API Queries
      • API Queries List View
      • API Queries Modal View
      • Testing API Queries
      • Common Issues & Troubleshooting
    • ADMINISTRATION
      • People
        • Users
          • Users List View
            • Create a New User Account
          • Users Manage View
        • Roles
          • Roles List View
            • Create a New Access Role
          • Roles Manage View
        • Contacts
          • Contacts List View
            • Create New Contact
          • Contacts Manage View
      • Configuration
        • Asset Hierarchy
          • Asset Hierarchy List View
            • Create New Entity
          • Asset Hierarchy Manage View
        • Attributes
          • Asset Classes
            • Asset Classes List View
              • Create New Asset Class
            • Asset Classes Manage View
          • Battery Types
            • Battery Types List View
              • Create New Battery Type
            • Battery Types Manage View
          • Device Categories
            • Device Categories List View
              • Create New Device Category
            • Device Categories Manage View
          • Feed Types
            • Feed Types List View
              • Create a New Feed Type
            • Feed Types Manage View
          • Manufactures
            • Manufacturers List View
              • Create a New Manufacture
            • Manufactures Manage View
          • Models
            • Models List View
              • Create a New Model
            • Models Manage View
          • Network Types
            • Network Types List View
              • Create New Network Type
            • Network Types Manage View
          • Power Sources
            • Power Sources List View
              • Create A New Power Source
            • Power Sources Manage View
          • Sensor Types
            • Sensor Types List View
              • Create New Sensor Type
            • Sensor Types Manage View
          • Status Labels
            • Status Labels List View
              • Create New Status Label
            • Status Labels Manage View
          • Suppliers
            • Suppliers List View
              • Create New Supplier
            • Suppliers Manage View
      • System Logs
        • System Logs List View
        • Email Message Log
        • SMS Message Log
        • API Transaction Log
        • Create a New Service Log Report
Powered by GitBook
On this page
  • Overview
  • Mandatory Fields
  • Control Output Options
  • 1. Native
  • 2. MQTT
  • 3. HTTP
  • Action Buttons
  • Dynamic Behaviour Summary
  • Example Table: MQTT Password Behaviour
  • Conclusion
  1. Analysis
  2. TOOLBOX
  3. Controls

Controls Manage View

The Edit Control Element window allows editing the name, site, output type, sensor selection, and saving or cancelling changes.

PreviousCreate a New Control ElementNextAPI Queries

Last updated 4 months ago

The Edit Control Element window allows users to modify a control element's settings. Here's a breakdown of its components.

When the user clicks the Manage button, a new window titled "Edit Control Element" opens. This view allows users to modify an existing control element's details and configuration.

Overview

  • The Edit Control Element view is pre-populated with the existing details of the selected control.

  • Users can modify the following fields: Element Name, Site, Control Output, and any dynamic fields related to the chosen output type (Native, MQTT, or HTTP).

  • Sensitive fields, like the MQTT Password, are obscured for security.

Mandatory Fields

These fields are required for the control element and are marked with a star (*).

Field Name
Description

Element Name*

The name of the control element, pre-filled with the current value but editable.

Site*

A dropdown menu to select or update the location associated with the control element.

Control Output*

Displays the current communication method (Native, MQTT, or HTTP). Users can switch to another method.

Control Output Options

The behaviour of the form changes dynamically based on the selected Control Output type.

1. Native

  • Displays the basic form with no additional fields.

  • Editable fields:

    • Element Name

    • Site

    • Sensor

2. MQTT

  • If MQTT is selected, additional fields specific to MQTT configuration are displayed.

  • Password Field Behaviour: The MQTT password is displayed as obscured input (e.g., "•••••") for security. Users can delete and re-enter a new password if needed.

Field Name
Description

Topic*

The MQTT topic used for publishing messages. Pre-filled with the existing value, but editable.

Message (ON)*

The payload sent when the control is turned ON.

Message (OFF)*

The payload sent when the control is turned OFF.

User ID*

The username used to authenticate with the MQTT server.

Password*

Displays the password as obscured input (e.g., "•••••"). Users can modify this if necessary.

Server*

The MQTT server’s URL or IP address, pre-filled with the current value but editable.

3. HTTP

  • If HTTP is selected, additional fields specific to HTTP communication are displayed, along with body format options.

Field Name
Description

Body Format

Options include x-www-form-URL encoded, raw, and binary. The current selection is pre-filled.

URL*

The endpoint URL for HTTP communication. Pre-filled with the current value but editable.

Message (ON)*

The payload sent when the control is turned ON.

Message (OFF)*

The payload sent when the control is turned OFF.

Action Buttons

Located at the bottom-right corner, these buttons allow users to save changes or cancel edits.

Button Name
Description

Cancel

Discards all changes and exits the view without saving.

Save

Saves the updated control element configuration.

Dynamic Behaviour Summary

Control Output
Additional Fields Displayed

Native

No additional fields are displayed.

MQTT

Fields for Topic, Messages (ON/OFF), User ID, Password, and Server appear. Password is obscured for security.

HTTP

Fields for Body Format, URL, and Messages (ON/OFF) appear.

Example Table: MQTT Password Behaviour

Field Name
Description
Behaviour

Password*

Used to authenticate with the MQTT server.

Obscured input (e.g., "•••••").

Conclusion

The Edit Control Element view provides a streamlined interface for updating control configurations. With dynamic form behaviour based on the Control Output type and security features like password obscuration, it ensures flexibility and data integrity while maintaining user-friendly operations.

Controls Manage View