Beonic Live Integration User Manual

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

  1. Navigate to the Integrations section in the application.
  2. Locate the Beonic (Live) or Beonic (Historical) integration.
  3. 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

  1. After filling in the required details, click Test Connection.
  2. If the connection is successful, the Channels Table will appear, displaying:
    • Channel
    • Description
    • Latest Value
  3. 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

  1. Go to the Integrations List section.
  2. Click on an existing Beonic integration to modify it.

  1. Adjust any necessary details and Test Connection again.
  2. Click Save to apply the changes.