Prerequisites

Deployment Options

On Premise: Can be deployed on local virtual machine or local server
On OpsHub Cloud: Can be deployed on Azure environment provided by OpsHub. This will come at an additional cost, which can be discussed with your point of contact in the support or sales team.
On Customer Cloud: Can be deployed on cloud service hosted by customer. Supported cloud service on which it can be deployed are:
- Amazon EC2
- Azure

Following are the Operating System (OS) and hardware pre-requisites for server or VM where OpsHub Integration Manager is installed.

Supported Operating Systems

Windows

Windows Server 2008 R2 and above (64 bit)
For Windows specific configuration, refer Windows specific configuration

Linux

RHEL 5.2 and above (64 bit)
- RHEL includes Cent OS and Fedora
Ubuntu 22.04 and above

Hardware Prerequisites

RAM - 8 GB & above
Disk space - 50 GB (Recommended)
Database Disk Space - 15 GB (Recommended)
Cores - Quadcore (Recommended)

Database Prerequisites

OpsHub Integration Manager can be deployed with an embedded database; however, for production deployment or anything other than functional testing, our experts highly recommend using an external database. OpsHub Integration Manager supports the following database.

1. MySQL Server

Supported versions: From 5.7.18 or above
Wait time for connection pool should be set to 8 hours.

User permission pre-requisites list:

Privileges

Context

Installation

Upgradation

Running

Alter

Tables

Yes

Alter Routine

Stored routines

Yes

Create

Databases, tables, or indexes

Yes

Create routine

Stored routines

Yes

Create tablespace

Server administration

Yes

Create temporary tables

Tables

Yes

Create view

Views

Yes

Delete

Tables

Yes

Drop

Databases, tables, or views

Yes

Execute

Stored routines

Yes

File

File access on server host

Yes

Grant option

Databases, tables, or stored routines

Yes

Index

Tables

Yes

Insert

Tables or columns

Yes

Lock tables

Databases

Yes

References

Databases or tables

Yes

Select

Tables or columns

Yes

Show view

Views

Yes

Update

Tables or columns

Yes

Once the installation/up-gradation is complete for normal running of OIM, permissions required only for installation and upgradation can be revoked.

SQL script to grant/validate/revoke User permission:

Operation

When OIM installation/upgaradation is responsible for database creation

When database is created manually

Grant

GRANT ALTER, ALTER ROUTINE, CREATE, CREATE ROUTINE, CREATE TEMPORARY TABLES ,CREATE TABLESPACE, FILE, CREATE VIEW, DELETE, DROP, EXECUTE, GRANT OPTION, INDEX, INSERT, LOCK TABLES, REFERENCES, SELECT, SHOW VIEW, UPDATE ON *.* TO 'username'@'localhost'; GRANT CREATE TABLESPACE, FILE ON *.* TO 'username'@'localhost';

GRANT ALTER, ALTER ROUTINE, CREATE, CREATE ROUTINE, CREATE TEMPORARY TABLES, CREATE VIEW, DELETE, DROP, EXECUTE, GRANT OPTION, INDEX, INSERT, LOCK TABLES, REFERENCES, SELECT, SHOW VIEW, UPDATE ON database_name.* TO 'username'@'localhost'; GRANT CREATE TABLESPACE, FILE ON *.* TO 'username'@'localhost';

Validate

SHOW GRANTS FOR 'username'@'localhost';

Revoke

REVOKE ALTER, ALTER ROUTINE, CREATE, CREATE ROUTINE, CREATE TEMPORARY TABLES, CREATE TABLESPACE, FILE, CREATE VIEW, DROP, GRANT OPTION, INDEX, REFERENCES ON *.* FROM 'username'@'localhost';

REVOKE ALTER, ALTER ROUTINE, CREATE, CREATE ROUTINE, CREATE TEMPORARY TABLES, CREATE VIEW, DROP, GRANT OPTION, INDEX, REFERENCES ON database_name.* FROM 'username'@'localhost'; REVOKE CREATE TABLESPACE, FILE ON *.* FROM 'username'@'localhost';

2. MS SQL/Azure SQL Server

Note: Azure SQL is an alias for MS SQL on cloud.

Supported versions: 2012 or above
MS SQL version should support TLS v1.2 protocol or above, as it is recommended to use MS SQL with TLSv1.2 enabled. Refer this link to upgrade MS SQL server to enable support for TLSv1.2 or above.
Enable Client protocols TCP/IP and Named pipes on MSSQLSERVER instance

User permission pre-requisites list:

Db operation

Privilege

Installation

Upgradation

Running

Create Database/Schema

Create Database, Create Schema

Yes

Update Database/Schema

Alter Database, Alter Schema or Alter

Yes

Create Table

CREATE TABLE

Yes

Select in Table

SELECT

Yes

Insert in Table

INSERT

Yes

Update table data

UPDATE

Yes

Delete table data

DELETE

Yes

Alter Table

ALTER

Yes

Drop Table

ALTER

Yes

Create View

CREATE VIEW

Yes

Read View

SELECT

Yes

Alter View

ALTER

Yes

Drop View

ALTER

Yes

Create References

REFERENCES

Yes

Update References

REFERENCES

Yes

Drop References

REFERENCES

Yes

Create Procedure

CREATE PROCEDURE

Yes

Update/Alter Procedure

ALTER

Yes

Execute Procedure

EXECUTE

Yes

Drop Procedure

ALTER

Yes

Note: ALTER privilege also required along with other privileges for operation such as create table, create view, drop table/view/procedure, references, etc.

Once the installation/up-gradation is complete for normal running of OIM, permissions required only for installation and upgradation can be revoked.

SQL script to grant/validate/revoke User permission:

Operation

When OIM installation/upgaradation is responsible for database creation

When database is created manually

Grant

USE master; grant Create Database, Create Schema, ALTER, CREATE TABLE, SELECT, INSERT, UPDATE, DELETE, CREATE VIEW, REFERENCES, CREATE PROCEDURE, EXECUTE to username;

USE database_name; GRANT Create Schema, ALTER, CREATE TABLE, SELECT, INSERT, UPDATE, DELETE, CREATE VIEW, REFERENCES, CREATE PROCEDURE, EXECUTE TO username;

Validate

USE master; SELECT pr.principal_id, pr.name , pr.type_desc, pe.state_desc, pe.permission_name FROM sys.database_principals AS pr JOIN sys.database_permissions AS pe ON pe.grantee_principal_id = pr.principal_id WHERE pr.name='username';

USE database_name; SELECT pr.principal_id, pr.name , pr.type_desc, pe.state_desc, pe.permission_name FROM sys.database_principals AS pr JOIN sys.database_permissions AS pe ON pe.grantee_principal_id = pr.principal_id WHERE pr.name='username';

Revoke

USE master; REVOKE Create Database, Create Schema, CREATE TABLE, CREATE VIEW, REFERENCES, CREATE PROCEDURE FROM username;

USE database_name; REVOKE Create Schema, CREATE TABLE, CREATE VIEW, REFERENCES, CREATE PROCEDURE FROM username;

3. Oracle

Supported versions: 11g (Release 2), 12c and 19c

User permission pre-requisites list:

System Privilege

Privilege

Installation

Upgrading

Running

CREATE SESSION

Yes [WITH ADMIN OPTION]

Yes

EXECUTE ANY TYPE

Yes [WITH ADMIN OPTION]

Yes

CREATE ANY PROCEDURE

Yes [WITH ADMIN OPTION]

Yes

CREATE USER

Yes

CREATE ANY TABLE

Yes [WITH ADMIN OPTION]

Yes

CREATE ANY VIEW

Yes [WITH ADMIN OPTION]

Yes

QUERY REWRITE

Yes [WITH ADMIN OPTION]

Yes

SELECT ANY TABLE

Yes [WITH ADMIN OPTION]

Yes

GLOBAL QUERY REWRITE

Yes [WITH ADMIN OPTION]

Yes

ALTER ANY TABLE

Yes [WITH ADMIN OPTION]

Yes

DROP ANY TABLE

Yes [WITH ADMIN OPTION]

Yes

CREATE ANY INDEX

Yes

INSERT ANY TABLE

Yes

UPDATE ANY TABLE

Yes

DELETE ANY TABLE

Yes

DROP ANY VIEW

Yes [WITH ADMIN OPTION]

Yes

ALTER ANY PROCEDURE

Yes [WITH ADMIN OPTION]

Yes

LOCK ANY TABLE

Yes

DROP ANY INDEX

Yes

DROP ANY PROCEDURE

Yes [WITH ADMIN OPTION]

Yes

CREATE ANY DIRECTORY

Yes [WITH ADMIN OPTION]

Yes

For seamless running of OpsHub Integration Manager, the permissions mentioned for installation and upgrade only can be revoked.
The default installation of OpsHub Integration Manager with Oracle:
- Two users are created by OpsHub Integration Manager: opshub and reportsdb.
- The user through which the database is connected will perform the following:
  - Create these users. Hence, CREATE USER permission is required at the installation time.
  - Grant certain permissions to these users (opshub and reportsdb) to connect with their database and create the required data in their database. Hence, WITH ADMIN OPTION is required.
  - Perform certain operations on the resources of these two users. Hence, it requires ANY* permissions.
In the advanced installation, if OpsHub Integration Manager is going to be installed with the option of the manual creation of the database, then:
- One of the users (opshub or reportsdb) can be used to connect with the Oracle database and perform all the operations.
- In this case, CREATE USER privilege can be omitted, and only SELECT ANY TABLE privilege would require WITH ADMIN OPTION during installation.
It is recommended to create a database manually for a high-security environment. The credentials are used as input to create two new users during the installation, so CREATE USER permission is required. If any permission regarding creating a user is missing, then OpsHub Integration Manager will print the password through SQL query. 'Create schema' approach was considered, but as Oracle doesn't allow creating schemas alone, we have to go with the 'Create User' approach.
If installation is to be done in the cdb$root container of CDB instance, then the connection user should have the commonly granted CREATE USER permission. To achieve this, the container=ALL clause needs to be used while granting the permission. The sample query for creating the user:
CREATE USER c##username IDENTIFIED BY password container=ALL;
After the user is created, the permission should be verified with the following query: SELECT * FROM USER_SYS_PRIVS;
Find the below screenshot which shows correct permission for CREATE USER privilege:

SQL script to grant/validate/revoke User permission:

Operation

SQL Queries

Grant

GRANT CREATE SESSION, EXECUTE ANY TYPE, CREATE ANY PROCEDURE, CREATE ANY TABLE, CREATE ANY VIEW, QUERY REWRITE, SELECT ANY TABLE, GLOBAL QUERY REWRITE, ALTER ANY TABLE, DROP ANY TABLE, DROP ANY VIEW, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY DIRECTORY TO username WITH ADMIN OPTION; GRANT CREATE USER, CREATE ANY INDEX, INSERT ANY TABLE, UPDATE ANY TABLE, DELETE ANY TABLE, LOCK ANY TABLE, DROP ANY INDEX TO username;

Validate

SELECT * FROM USER_SYS_PRIVS;

Revoke

REVOKE CREATE ANY PROCEDURE, CREATE USER, CREATE ANY TABLE, CREATE ANY VIEW, ALTER ANY TABLE, DROP ANY TABLE, CREATE ANY INDEX, DROP ANY VIEW, ALTER ANY PROCEDURE, LOCK ANY TABLE, DROP ANY INDEX, DROP ANY PROCEDURE, CREATE ANY DIRECTORY FROM username;

4. PostgreSQL Server

Supported versions: From 15 or above
The user must have CREATEDB permission for creating database.

In the advanced installation, if OpsHub Integration Manager is installed with the option of the manual creation of the database, then:

The user must have permission for CREATE ON SCHEMA for both the schemas (opshub and reportsdb) for creating tables, index, references, and views.
The manually created database and schema should only contain lowercase alphanumeric characters, with $, _ and no spaces.

Note: If default connection timeout parameter is changed for any database server, then it must be confirmed that sufficient connection timeout has been set. For example, for MySQL the default server-side connection timeout is 8 hours. If it is changed and set to, say, 5 minutes, then the default server-side connection timeout must be updated accordingly. OpsHub Integration Manager maintains connection pools that keep connections alive for 8 hours. Based on the need, this parameter can be tuned at both the application and database-server levels.Generally, the recommended timeout is between 6-8 hours.

Download Database Connector jar

Database Type

Database Version

Download Link

MySQL

All

MySQL Connector/J

MSSQL

2012 and lower

Download Link

2014 onward

Release Notes

Oracle

11g

Oracle JDBC 11g

12c

Oracle JDBC 12c

19c

Oracle JDBC 19c

PostgreSQL

All

PostgreSQL JDBC

HostName for OpsHub Integration Manager

If machine/instance where OpsHub Integration Manager deployed is binded with any hostname (Net, Host, Gateway, or Domain name) then please make sure the hostname (Net, Host, Gateway, or Domain name) is a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-), and period (.). Note that periods are only allowed when they serve to delimit components of "domain style names". For more details, read the memo RFC-921 and RFC-952.

Once you have downloaded the application and configured the pre-requisite, click Installation Steps to see how to get started.

Port Prerequisites

For successful installation/upgradation of OpsHub Integration Manager, following ports are required to be available as per the chosen configuration and database.

Http Port

8989: If you are installing OpsHub Integration Manager with HTTP.
8443: If you are installing OpsHub Integration Manager with HTTPS.

Database Port

9001: If you are installing OpsHub Integration Manager with HSQL database.

Note: Apart from the above ports, some connectors require certain ports to be available. Please refer the Connectors section to check ports used by specific connectors.

Appendix

Windows specific configuration

During the installation of OpsHub Integration Manager, few temporary files are placed/copied in the TEMP directory [i.e., the path which is specified in TEMP environment variable]. This directory path should not contain ";" as well as none of the directory/folder names should end with "!" in this path.

Example: "C:\Users\xyz!\AppData\Local\Temp" or "C:\Users\xy;z\AppData\Local\Temp" as Temp environment variable value/path is not allowed.
In such case, the installation will fail with error. Please refer here for more details on this error and steps for its resolution. To check how to set TEMP environment variable, please refer below.

Setup environment variable

Open "Edit the system environment variables" from Start.
Click the "Environment Variables" button.
Click on environment variable required to be edited.
Click on Edit button and change the path.

PreviousGetting OpsHub Integration Manager NextInstallation

Last updated 3 hours ago