App
AlphaX Integration View connects BoM, SolA, and Post integrations, enabling weather data, solar monitoring, and external data transfers.
The AlphaX Integration App View allows users to connect external systems, offering three integration options: BoM (retrieves weather data from Australia's Bureau of Meteorology), SolA (monitors solar energy performance via Solar Analytics), and Post (sends AlphaX data to external endpoints). Each app has customizable settings with mandatory fields and validation tools for seamless integration and data flow.
The "Integration +APP View" is where users can connect AlphaX with external systems and data sources. It showcases three available apps for integration: BoM, Post, and SolA. Each app provides unique functionality and can be activated by clicking the +Create button. Below are detailed descriptions of each app, organized into tables.
1. BoM (Bureau of Meteorology Integration)
The BoM interface allows users to connect AlphaX to the Bureau of Meteorology for retrieving weather data. Users can specify the weather station details using Product ID and WMO codes.
BoM Interface Table
Name
A unique name for the BoM integration.
Mandatory
Entity
The organization or project under which this integration is created.
Mandatory
Tag
An optional label to organize or categorize the integration.
Non-Mandatory
Status
Sets whether the integration is Active or Inactive.
Mandatory
Product ID
Unique identifier for the weather station (obtained from the BoM website).
Mandatory
WMO
The World Meteorological Organization code for the weather station.
Mandatory
Channels
Lists weather data metrics like Air Temperature, Rainfall, Wind Speed, etc.
Populated automatically
Test Connection
Tests if the integration credentials and station details are valid.
Optional (for validation)
Save
Saves the configuration.
Mandatory
Cancel
Discards changes and exits the interface.
Non-Mandatory
The BoM integration connects AlphaX with Australia's official weather forecasts and radar data. This enables weather-related insights to be used within the AlphaX platform.
Purpose
Fetch weather data such as temperature, humidity, wind speed, and rainfall from the Bureau of Meteorology.
Use Cases
Ideal for environmental monitoring, agricultural applications, and renewable energy systems.
Key Features
Provides real-time data across multiple channels like air temperature, dew point, and wind direction.
Setup
Requires Product ID and WMO to connect with a specific weather station.
Channels
Up to 8 channels for various weather metrics such as Air Temperature, Wind Speed, and Rainfall.
BoM Integration Help Button
Instructions
Navigate to the provided BoM website link.
Select a weather station from the map.
Scroll to the bottom of the station's page to find the Product ID (e.g.,
IDV60842) and WMO (e.g.,94888).
Example Provided: Highlights the JSON format for identifying the Product ID and WMO.
2. Post Integration
The Post interface allows AlphaX to send data to external endpoints in real-time. Users can specify the endpoint URL and secure the connection with an API key.
Post Interface Table
Name
A unique name for identifying the Post integration.
Mandatory
Entity
The organization or project under which this integration is created.
Mandatory
End Point
The URL of the external system or API where AlphaX will send the data.
Mandatory
x-api-key
Secure API key for authenticating the connection to the external system.
Mandatory
Status
Sets the integration to either Active or Inactive.
Mandatory
Save
Saves the configuration.
Mandatory
Cancel
Discards changes and exits the interface.
Non-Mandatory
The Post integration allows AlphaX to send data to an external endpoint whenever new data is received. It is used for real-time data transmission to external systems.
Purpose
Push AlphaX data to a specified external system or API endpoint.
Use Cases
Ideal for scenarios where AlphaX data needs to be synchronized with external platforms in real time.
Key Features
Supports secure transmission using an x-api-key.
Setup
Requires specifying the Endpoint URL and an x-api-key for authentication.
Status Options
Active or Deactivated.
3. SolA (Solar Analytics Integration)
The SolA integration allows AlphaX to connect to Solar Analytics for monitoring solar energy systems. Users can retrieve data such as power generated, consumed, and capacity by selecting a solar site.
SolA Integration Fields Table
Name
A unique name for identifying the SolA integration.
Mandatory
Entity
The organization or project under which the integration is created.
Mandatory
Tag
An optional label for categorization or organization.
Non-Mandatory
Status
Determines whether the integration is Active or Inactive.
Mandatory
User Name
Solar Analytics account username for authentication.
Mandatory
Password
Password associated with the Solar Analytics account.
Mandatory
SolA Site
Dropdown list populated by clicking Load SolA Sites, showing available solar sites.
Mandatory
Channels
Displays solar metrics: Generated Power, Consumed Power, Capacity, and Overall Status.
Populated automatically
Test Connection
Tests if the credentials and site connection are valid.
Optional (for validation)
Save
Saves the integration setup.
Mandatory
Cancel
Discards changes and exits the setup interface.
Non-Mandatory
The SolA integration connects AlphaX to Solar Analytics, a solar monitoring system. It provides insights into solar power generation, consumption, and overall system performance.
Purpose
Retrieve real-time solar performance data such as power generated, consumed, and capacity metrics.
Use Cases
Useful for monitoring solar installations, optimizing performance, and tracking energy usage.
Key Features
Four channels are provided: Generated Power, Consumed Power, Capacity, and Overall Status.
Setup
Requires valid Username, Password, and selection of a SolA Site.
Additional Info
Each user credential supports up to 300 connections.
SolA Integration Help Button
Instructions
Enter valid user credentials (username and password) for the Solar Analytics Web Portal or White Label solutions.
Ensure each user credential can support up to 300 connections.
Use the Load SolA Sites button to fetch available solar sites.
Channels Explained
Channel 1: Power Generated.
Channel 2: Power Consumed.
Channel 3: Capacity of the site.
Channel 4: Overall Status (values:
0=Good,1=Investigate,2=Attention).
"These Help sections provide practical steps and examples to assist users in successfully configuring their integrations."
How to Create an Integration
Step 1: Click the +Create button under the desired app.
Step 2: Fill in the required fields on the configuration screens, as shown in the provided interface for BoM, Post, and SolA.
Step 3: Save your integration, and test the connection where applicable.
This organized approach helps users easily identify the purpose and setup requirements of each app within the integration view.
Conclusion
Each integration has a unique purpose, and the interface buttons and fields are tailored for their respective functionalities. Mandatory fields ensure that the integration works, while non-mandatory fields add convenience for organization. The tables provide a clear breakdown to guide users in setting up their integrations effectively.
Last updated