Integrations Manage View

The Integration Manage View configures BoM, Post, and SolA integrations, enabling weather data, external API, and solar monitoring.

The Integration Manage View in AlphaX provides a centralized interface for configuring, editing, and managing integrations with external systems. It allows users to define integration settings, validate connections, and monitor data flow for three types of integrations: BoM, Post, and SolA. Each integration type has a dedicated setup form with unique fields and validation options, tailored to its functionality.

BOM Edit View

1. BoM Integration (Bureau of Meteorology)

The BoM integration lets users configure weather data connections for specific weather stations by entering station identifiers like Product ID and WMO.

BoM Integration Manage Table

Field/Button
Description

Name

A descriptive name for the BoM integration.

Entity

The organization or hierarchy under which this integration is managed (e.g., Minnovation).

Tag

An optional label for categorizing the integration.

Status

Specifies whether the integration is Active or Inactive.

Product ID

Unique identifier for the weather station.

WMO

The World Meteorological Organization code for the selected station.

Channels

Lists available weather data channels such as temperature, humidity, wind speed, and rainfall.

Test Connection

Verifies that the Product ID and WMO details are correct and valid.

Save

Saves the configuration for the BoM integration.

Cancel

Discards unsaved changes and exits the configuration window.

2. Post Integration

The Post integration allows AlphaX to send real-time data to an external endpoint. Users can configure this by specifying the Endpoint URL and API Key.

Edit Post View

Post Integration Manage Table

Field/Button
Description

Name

A descriptive name for the Post integration (e.g., "Forward my Data").

Entity

The organization or hierarchy under which this integration is managed (e.g., Minnovation).

End Point

The URL of the external system or API where AlphaX will send the data (e.g., https://...).

x-api-key

A secure API key used to authenticate the connection to the external system.

Status

Specifies whether the integration is Active or Inactive.

Save

Saves the configuration for the Post integration.

Cancel

Discards unsaved changes and exits the configuration window.

3. SolA Integration (Solar Analytics)

The SolA integration connects AlphaX to Solar Analytics for monitoring solar power generation and consumption. Users can log in and select a specific solar site for data retrieval.

Edit SoIA View

SolA Integration Manage Table

Field/Button
Description

Name

A descriptive name for the SolA integration.

Entity

The organization or hierarchy under which this integration is managed (e.g., Minnovation).

Tag

An optional label for categorizing the integration.

Status

Specifies whether the integration is Active or Inactive.

User Name

The Solar Analytics account username for authentication.

Password

Password associated with the Solar Analytics account.

SolA Site

Dropdown populated by clicking Load SolA Sites, showing available solar sites for connection.

Channels

Displays solar metrics: Power Generated, Power Consumed, Capacity, and Overall Status.

Test Connection

Tests if the credentials and selected site connection are valid.

Save

Saves the configuration for the SolA integration.

Cancel

Discards unsaved changes and exits the configuration window.

Key Features of the Manage View

  1. Customizable Settings: Each integration allows users to provide essential details like names, tags, authentication credentials, and configuration parameters.

  2. Connection Validation: Options like Test Connection help users verify the accuracy of entered details before saving.

  3. Streamlined Management: Users can activate or deactivate integrations using the Status field and track their organization hierarchy via the Entity field.

Integration Types in the Manage View

The table below summarizes the three types of integrations available in the AlphaX Manage View. Each integration serves a specific purpose, with unique configuration requirements and validation/usage details.

Integration Type
Purpose
Configuration
Validation/Usage

BoM Integration

Retrieve weather data from the Bureau of Meteorology for environmental monitoring.

Provide a weather station's Product ID and WMO codes to enable data retrieval.

Use the Test Connection button to ensure valid station details are entered.

Post Integration

Send real-time data from AlphaX to external endpoints for synchronization.

Enter an Endpoint URL and an x-api-key for secure data transmission.

Ideal for integrating AlphaX with external APIs or platforms.

SolA Integration

Monitor solar energy systems by connecting to Solar Analytics.

Authenticate using Username and Password, then select a solar site using Load SolA Sites.

Provides four data channels: Power Generated, Power Consumed, Capacity, and Overall Status.

Conclusion

The Integration Manage View simplifies setting up and managing integrations with external systems, providing users with a flexible and efficient way to link AlphaX to weather, solar, or API-driven platforms.

Last updated