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

  • Stop the service (Windows services manager)
  • Open the console with administrator rights
  • Go to the directory where the oibus.exe executable is located cd "c:\Program Files\OIBus"
  • Execute 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.

OIBus Security

It is important to consider a few points regarding the security of the installation. OIBus is usually installed on a dedicated machine (which can be a virtual machine) located at the customer site. The OIBus behavior is fully managed by the OIBus configuration file (oibus.json by default).

It is important to consider several aspects to protect OIBus:

  • Access to the machine
  • Access to the OIBus administration interface
  • Protection of passwords, secret keys, etc …

Access to the OIBus machine

Of course, local or remote access (using RDP or disk sharing for example) to the machine where OIBus is installed is a risk to consider. Indeed, a local user could delete OIBus files or directly modify the configuration file.

It is important to limit access to the OIBus machine so that no one can access it except the OIBus administrator.

Access to the OIBus Administration Interface

The OIBus administration interface is a web-based interface that can be launched locally or from any remote PC with a web browser. We recommend that you use the interface using the URL localhost:2223.

interface administration oibus

To use it from a remote PC, you must configure the “Filters” section of the OIBus engine. Access to the administration interface also requires a user/password.

The default username is admin

The default password is pass

The password must be changed by the user at the first launch.

Forgotten password :

The administrator with access to the OIBus configuration file can use a text editor to delete the “password” line in the “Engine” section of the OIBus configuration file. The password will then be restored to its default value (“pass”).

OIBus uses the basic authentication method in addition to the HTTP protocol supported by most web browsers. This method does not provide any privacy protection for the transmitted credentials sent in the header for each HTTP request. The OIBus engine’s “filters” can mitigate this risk by limiting the allowed IP addresses, but this is not a 100% guaranteed protection as impersonating another computer system with a fake IP address is not difficult for hackers.

Therefore, remote access to the OIBus administration interface should be limited to insidethe customer’s LAN and should not be accessible over the Internet.

Protection of passwords, secret keys, etc.

OIBus needs access to multiple sources of information (Histories, DCS, LIMS, MES, Databases, etc.). Many of these sources require a username/password pair or a secret key to access these systems.

This information is also stored in the OIBus configuration file, but it is all encrypted. This adds a level of protection that prevents anyone from reading this information in the clear.This encryption uses public/private keys stored in the OIBus cache folder. These keys are created automatically at each startup if they do not already exist.

If these keys are deleted, it will be impossible for OIBus to decrypt the passwords or secret keys. A new key pair will be generated when OIBus is restarted. In this case it will be necessary to use the administration interface and re-enter all passwords.