Skip to main content

Install OPNBI in Windows

This documentation contains the steps to install OPNBI in the windows system.

Objective​

  • Objective of this document is to guide the user in the installation process of OPNBI on a Windows machine.

Hardware requirements​

  • Operating System - Windows, Linux, Unix, Mac
  • RAM- Minimum 8 GB (16+ GB Recommended)
  • Disk Space - 15 GB of free disk space (additional space is required for repository and log folder)

Software Requirements​

  • Java - 8
  • Metadata Database - MySQL 5.5+, Oracle 11+, PostGreSql 9.1+
  • Browsers - Firefox 25+, Chrome 30+, Safari 9.0+, MS Edge
  • Application Server - Apache Tomcat 8.x
Note
  • Make sure that Software & Hardware requirement matches for running OPNBI error-free.

Setup OPNBI in Windows​

There are 2 ways the user can install OPNBI on the windows machine,

  1. Install OPNBI with default database [postgreSQL]

  2. Install OPNBI with existing database [MySQL / postgreSQL / Oracle]

1. Install OPNBI with default database [postgreSQL]​

This type of installation is preferred when there is no database installed on the windows machine or server. OPNBI setup comes with a default database i.e. PostgreSQL setup files. if the user does not have any database on his machine, he can install OPNBI without setting up a separate database on the windows machine. The user just needs to run the OPNBI setup and select the PostgreSQL option during the metadata selection step. That's it, OPNBI will be configured with PostgreSQL. no need to download any database to store metadata of OPNBI before running this setup.

Follow these steps to install OPNBI with PostgreSQL Database;

  1. Follow this link to download & install Java in your system. follow this link to set java in PATH system variable if you do not have it installed.

  2. Users need to download a Database to store Metadata if they are installing OPNBI using MySQL or Oracle.

  3. Go to OPNBI website and Download the OPNBI setup file. Extract OPNBI Installer in the respective drive.

  4. Locate and double-click the .exe file. (It will usually be in your Downloads folder or in your respective drive.)

  5. A dialog box will appear. Click on Next button & Follow the instructions to install the software:

    Docusaurus Slash Introduction

  6. Accept the agreement & Click on the Next button.

    Docusaurus Slash Introduction

  7. Click on OPNBI New installation checkbox, de-select Upgrade Existing OPNBI & Click on the Next button.

    Docusaurus Slash Introduction

  8. Select your respective Installation Directory & Click on the Next button.

    Tips & tricks

    You can Write a folder name that is not even available in your directory and the installer will create this folder for you. for example, D:\OPNBI5 in Installation Directory & Click on the Next button.

    In another way, the user can create the folder first and select created folder in this step to install OPNBI in the created folder.

    warning

    Folder names containing special characters will not be permitted. user needs to provide a folder name that does not contain any special characters otherwise setup will not continue

    Docusaurus Slash Introduction

  1. Installation files will start extracting as shown:

    Docusaurus Slash Introduction

  2. While performing the installation procedure it will ask the user for the update & local. If the user selects update option setup will check if any newer version is available on the server or not. If yes, It will fetch a new build from the server and then install OPNBI with an updated build.

    If the user select local option, setup will use files available with setup to install OPNBI.

    Select the preferred option & click on the Next button

    Docusaurus Slash Introduction

  3. Next window will ask the user to select Metadata Database.

info

Users can select Use existing Database if they already have a database in their system. we will see this option in a later section of this document

  1. Select the Install Postgresql Database option & Click on the Next button.

    Docusaurus Slash Introduction

  2. PostgreSQL Database installation will start.

    Docusaurus Slash Introduction

  3. After PostgreSQL is installed it will configure the database.

    Docusaurus Slash Introduction

  4. During installation one dialog box will appear asking regarding Visual C++ as shown:

    Docusaurus Slash Introduction

  5. Click on the Repair option.

    Docusaurus Slash Introduction

  6. User's setup is successful & Click on the Close button.

    Docusaurus Slash Introduction

  7. After this user's database will be cofigured & Final Review window will appear.

    Here you can see the connection status of the database installed. It shows Conection Sucessfull if a database connection is found. Click on the Next button.

    info

    If the database connection is not successful, you can see an error message in the Final Review window. If you found any error message, click back and try again to install the database.

    warning

    If you click on next with an error message Metadata will not be stored in the selected database and OPNBI will not run.

    Docusaurus Slash Introduction

  8. Setup is ready & OPNBI Installation will start in the system.

    Docusaurus Slash Introduction

    Docusaurus Slash Introduction

  9. Click on the Finish button after Installing OPNBI in the system.

    Docusaurus Slash Introduction

  10. OPNBI is downloaded & it will be seen in your local drive with provided folder name. ( In user's respective location & name selected at the start of the installation process).

2. Install OPNBI with existing database [MySQL / postgreSQL / Oracle]​

This type of installation is preferred when the user already has any database out of MySQL or PostgreSQL or oracle installed on his machine or server. Although OPNBI comes with the default database setup of PostgreSQL if the user has any out of the 3 listed databases then he can use this database to store metadata of OPNBI.

Follow these steps to install OPNBI with the existing Database;

  1. Download & Extract OPNBI Installer in the respective drive.

  2. Locate and double-click the .exe file. (It will usually be in your Downloads folder or in your respective drive.)

  3. A dialog box will appear asking for a License Agreement. Click on I accept the agreement radio button & Next button respectively.

    Docusaurus Slash Introduction

  4. Click on OPNBI New installation checkbox, de-select Upgrade Existing OPNBI & Click on the Next button.

    Docusaurus Slash Introduction

  5. Select Installation Directory, provide or select folder name & Click on the Next button.

    Tips & tricks

    You can Write a folder name that is not even available in your directory and the installer will create this folder for you. for example, D:\OPNBI5 in Installation Directory & Click on the Next button.

    In another way, the user can create the folder first and select created folder in this step to install OPNBI in the created folder.

    warning

    Folder names containing special characters will not be permitted. user needs to provide a folder name which does not contains any special characters otherwise setup will not continue

    Docusaurus Slash Introduction

  1. Installation files will start extracting as shown:

    Docusaurus Slash Introduction

  2. While performing the installation procedure it will ask the user for an update & local. If the user selects update option setup will check if any newer version is available on the server or not. If yes, It will fetch a new build from the server and then install OPNBI with an updated build.

    If the user select local option, setup will use files available with setup to install OPNBI.

    Select the preferred option & click on the Next button

    Docusaurus Slash Introduction

  3. Select the Use Existing Database radio button & Next button respectively.

    Docusaurus Slash Introduction

  4. A dialog box will open & it will ask the user to select Database from available options. Here we will set up OPNBI with MySQL database. Select MySQL & Next button respectively.

    Docusaurus Slash Introduction

  5. Here user needs to provide the database credential listed below;

    DB Server URL : localhost [provide database URL here]

    Database Name : opnbi [by default database name provided is open. if the user has a database already created then change the database name here ]

    DB User Name : root [provide username to connect with database]

    DB password : **** [provide valid password for provided username]

    DB Port : 3306 [provide database port information]

    Create database: this checkbox should be marked when the database mentioned in Database Name property is not yet created in the database. by marking this checkbox, setup will create a new database with the name provided in Database Name property and all metadata of OPNBI will be stored there.

    Docusaurus Slash Introduction

  6. Click on next and Validating DB Connection will start as shown:

    Docusaurus Slash Introduction

  7. After this user's database will be configured & Final Review window will appear.

    Here you can see the connection status of the database. It shows Connection Successful if database credentials are correct and a connection is found. Click on the Next button.

    info

    If the database connection is not successful, you can see an error message in the Final Review window. If you found any error message, click back and check the database credentials provided. change credential and click next to test database connection.

    warning

    If you click on next with an error message Metadata will not be stored in the selected database and OPNBI will not run.

    Docusaurus Slash Introduction

  8. Click on the Next button & below the dialog box will appear:

    Docusaurus Slash Introduction

  9. As the user clicks on the Next button shown in the last image, installing OPNBI files will take place.

    Docusaurus Slash Introduction

  10. After the installation of files is completed your OPNBI setup is completed.

    Docusaurus Slash Introduction

  11. Click on Finish shown in the last image, and your OPNBI software is ready to use.

  12. OPNBI is downloaded & it will be seen in your local drive with provided folder name. ( In user's respective location & name selected at the start of the installation process).

Note

Users can Install OPNBI with postgresql & oracle existing database with the same process shown with MySQL.

Request for OPNBI Liscense​

Note

The user needs to apply for a license to start working with OPNBI.

  1. Go into the directory where OPNBI is installed. you will see start_db.bat, start_opnbi.bat, stop_db.bat, stop_opnbi.bat files. Click on start_db to Start PostgreSQL if OPNBI is installed with PostgreSQL. In case OPNBI is installed with MySQL you will not find start_db.bat file. To start the application server double click and run start_opnbi.bat and wait for about 2 min till the tomcat server starts.

  2. When the user starts the Application server the first time one dialog box for Windows Security Alert will open as shown:

    Docusaurus Slash Introduction

  3. Click on Allow Access button. & Application Server will start in minutes.

    Docusaurus Slash Introduction

  4. User can see the port number in server ["http-nio-8080"] as shown above:

  5. Here 8080 is the port number of the server

  6. Go to the browser & paste http://localhost:8080/opnbi/.

  7. Wait for a few minutes & OPNBI Login screen will appear as below:

    Docusaurus Slash Introduction

  1. Enter your respective Id & Password & below screen will appear:

    info

    By default, userid is Admin and password is password

    Docusaurus Slash Introduction

  2. Fill in the Request License details & click on the Online Request button.

  3. One Registration Confirmation mail will appear in your mailbox.

  4. Click on the following link & Confirm your Registration.

  5. After a couple of minutes user will get a license file in the mail.

  6. Download the License file & save it in your directory.

  7. After getting the license file Click on the Upload License button, Select the License file & Click on the Open button.

  8. License will be uploaded & one pop-up message showing License Uploaded Successfully will be shown at the top of the screen.

  9. Now, OPNBI is ready to use. when you log in again, you will see a default dashboard page provided by OPNBI.