Barium Integration Agent (BIA) is a lightweight Windows service that can be configured to monitor local data sources and send messages and data to process applications in a space in Barium Live if the configured rules are fulfilled.


The BIA requires that your Barium Live subscription plan has support for API integration. This will give you access to an API key that is needed to integrate with Barium Live. Please contact the Barium Live sales team to get access to and to get started using the BIA.



Introduction and background

The Barium Integration Agent is created for customers who need to get started with integration fast and easily. The BIA is a simple application that can be installed on any Windows environment and that has an accompanied XML configuration file where the configuration for the BIA is done. It is possible for anyone with knowledge to create their own, custom integration agent since Barium Live has an open REST API which is used by the Barium Integration Agent. We have created the BIA so that customers do not have to. It supports a number of data sources that it can connect to but it can of course be extended to support more.


Supported data sources

Barium Integration Agent supports integration with the following data sources:

  • SQL server databases (Microsoft SQL Server 2005 or later)
  • XML documents
  • LDAP-compatible directory services (LDAP version 3, including Active Directory)
  • Excel documents


Barium Integration Agent communicates with Barium Live over the Barium Live REST API. Many other integration scenarios are possible through the use of Barium Live REST API. Contact a Barium Integration Partner if you need help creating integration with Barium Live.


Deployment requirements

The Barium Integration Agent software is technically a .Net executable service that connects to the Barium Live REST API over HTTPS (port 443) and performs HTTP requests. The requests contains custom HTTP headers used for authentication, content type etc. and string and binary data is transferred between Barium Integration Agent and the Barium Live website.


Pre-installation checklist:

  • Make sure that the server where Barium Integration Agent will be installed has Microsoft .Net Framework 4.0 installed.
  • The server where Barium Integration Agent will be installed must allow outgoing HTTPS connections to https://live.barium.se on port 443.
  • Make sure that the communication Barium Integration Agent and the Barium Live website is not blocked. Note that Barium Integration Agent uses the default proxy settings of Internet Explorer.


Installation

Extract the zip file with Barium Integration Agent into a folder on an application server.


Barium Integration Agent can be run on-demand in console mode or be installed as a Windows service. Make sure to configure the configuration file agent.xml (see the Configuration section) before running the integration agent for the first time.


BariumIntegrationAgent.exe    Runs the agent in console mode
-service                      Installs and starts the agent service
-uninstall                    Stops and uninstalls the agent service

Note that Barium Integration Agent must be installed/uninstalled with an administrator account or using "Run as administrator" in Windows.


See the article Configure Barium Integration Agent about configuration.