Start with OIBus

OIBus & collecte de données

Source Code

The source code of OIBus is available with an Open Source license on our GitHub public repository. Below are the links to access, follow or support us in this process.

Watch Star Fork Sponsor

Minimal System

To operate OIBus must be installed on an environment with the following minimum characteristics:

  • Windows Server version ≥ 10 and 64 bits
  • RAM : 4Go minimum (OIBus may require more RAM depending on the number of configured South applications)
  • Disk space: 200 GB for the application plus the space necessary to store cached data and logs (to be determined according to the volume of data processed and the configuration of the cache and logs)
  • Administrator rights on the environment to install the plugin and register it as a service
  • To ensure proper time synchronisation, ensure that the system is synchronised to a time service (NTP).
  • A modern web browser (IE not supported) to access the OIBus interface. The browser can be on the installation computer or on another, provided you have configured the necessary access.

Download files

Install OIBus

Install OIBus as a service

  1. Download the last version of OIBus.
  2. Create an OIBus directory with all of the files from the .zip archive. For example "C:\Program Files\OIBus".
  3. Create a directory for OIBus data (cache, configuration, logs…). For example "C:\OIBus". It’s a good practice (but not mandatory) to place this folder in a dedicated volume.
  4. Open the console as administrator
  5. Go to the directory where the oibus.exe executable is located cd "C:/Program Files\OIBus".
  6. Execute the command : install.bat "C:\OIBus" where the oibus.json file path is the folder created for OIBus data. Check that the configuration file (oibus.json) has been created in the specified directory.
  7. Check that OIBus has been launched as a Windows service. Open the windows services window and check for the presence of the OIBus service. If necessary start it.

To remove the service

  • Go to the directory where the oibus.exe executable is located
  • Execute the command : uninstall.bat

To run OIBus in the console (troubleshooting)

This execution mode facilitates debugging in the event of a service malfunction)

  • Delete the service (see above)
  • Go to the directory where the oibus.exe executable is located
  • Run the command: go.bat

The console will display information about the execution of OIBus, in particular the error logs. In the event of a problem, collect the logs and send them to us to facilitate the investigation.


Updating OIBus

The update process of OIBus requires to have administration permissions on the system. Here is the Windows procedure:

  • Download the latest version of OIBus.
  • Extract the .zip archive.
  • Open the Windows services window and stop the OIBus service.
  • Copy all the files to the directory where oibus.exe is located and replace the old files.
  • Restart the OIBus service.

If you use the same directory as the executable for configuration files, cache files and temporary files, be careful not to delete them.

Launch OIBus configuration interface

On the machine where OIBus is installed, open a browser (preferably the latest version of Chrome). Then go to localhost:2223 and you will reach the OIBus interface.

Integrated Help

For more details on the configuration, OIBus help is directly available in the interface.

Change Admin Password

By default, user is admin and password is pass.

For security reasons it is necessary to limit access to the administration. The first thing to do is to change the default password in the “Engine” section

Validate Configuration changes

Each time you modify something in the configuration, it is not immediately applied. To apply your modification you must go through the activation of your new configuration. For that, just click on the “Activation” menue, check your changes and click “Activate” button.

After that you will be prompted to restart OIBus server. Click “Confirm”.

Check OIBus status

You can have several information about OIBus operation by going to OIBus home page. On this screen you will get a synthesis of current OIBus operation. On the top you will have the status of the three layers of OIBus :

  • North : connexion to the different applications to which OIBus is sending data;
  • Engine : status of the engine managing the data grouping, data buffering and query orchestration;
  • South : connexion to the different data sources to which OIBus is connected.

You can also access to the detailed logs through the “Logs” menue.

Setting the South connexions

You can access and manage the south connexions through the “South” menue. You can directly access to the configuration of each source or add one to the list according to your needs.

Setting the North connexions

You can access and manage the north connexions through the “North” menue. You can directly access to the configuration of each application or add one to the list according to your needs.