The Beonic Integration feature allows users to connect and retrieve real-time from Beonic's API. This guide provides step-by-step instructions on how to create,and edit the integration.
1. Accessing Beonic Integration
- Navigate to the Integrations section in the application.
- Locate the Beonic (Live) or Beonic (Historical) integration.
- Click Create to set up a new Beonic integration.
2. Creating a Beonic Integration
After clicking Create, a form will appear with two sections: DEFAULT and DATA.
2.1 DEFAULT Tab
The DEFAULT tab contains the main configuration settings:
- Status:
- Toggle between Active and Inactive.
- Beonic Account ID (Required):
- Enter the Beonic system account ID.
- Key / Basic Auth Username (Required):
- This is the API Key Username obtained from the Beonic API.
- Password / Basic Auth Password (Required):
- Enter the corresponding API Key Password.
- Entity:
- Select the entity from the dropdown (e.g., "Minnovation").
- Tag (Required):
- Enter a tag to the integration.
2.2 DATA Tab
The DATA tab contains the specific data settings:
- Counter ID(s) (Required):
- Input the ID of the counter you wish to monitor. Note: Only one counter ID can be entered for live integration.
- Name:
- This field is auto-filled based on the Counter ID.
- Group By:
- Determines the granularity of the retrieved data.
- Available options:
- Minute
- 5 Minute
- 15 Minutes
- Hour
3. Testing the Connection
- After filling in the required details, click Test Connection.
- If the connection is successful, the Channels Table will appear, displaying:
- Channel
- Description
- Latest Value
- If the connection fails, check the API credentials and counter IDs.
4. Saving the Integration
- Once the connection is successful and the data is validated:
- Click Save to complete the integration.
- Click Cancel if you want to discard the setup.
5. Editing an Existing Beonic Integration
- Go to the Integrations List section.
- Click on an existing Beonic integration to modify it.
- Adjust any necessary details and Test Connection again.
- Click Save to apply the changes.