1️⃣ Installing Omni

Knowledge base

What is Omni?

Omni is a specialized documentation tool to help TM1 developers have better model traceability, drastically reducing debugging time and safeguarding model accuracy and stability through automated dependency visibility and efficient change management.

This installation guide provided for administrators to install Omni on-premise to be used as a service within their organization.

System Requirements

To ensure optimal performance and stability, the following minimum configuration is recommended for running Omni:

  • πŸ–₯️ Operating System: Windows Server 2019 or later

  • πŸ’Ύ Memory: 16 GB RAM minimum

  • πŸ“¦ Storage: 50 GB of available hard disk space

  • πŸ—„οΈ Database: SQL Server 2019 or later (Express or Standard editions)

Installation

The following are the installation procedures:

  1. Locate the installation drive or folder, right-click on Omni.exe file and run it as an administrator.

image.png

  1. If you do not have SQL Server on the machine that you will be installing Omni in, the following pre-requisites window will pop-out. Click β€œNext”.

image.png

  1. The installer will help to trigger an SQL Express Installer should you not have SQL Server on your machine.

image.png

  1. However, should you want to use an SQL Server that does not sit on the same machine as Omni, uncheck the box. This will allow you to skip the installation of SQL Express on your machine. Thereafter, click β€œNext”.

image.png

  1. Review License terms and conditions. Then click β€œNext” to review the End User License Agreement.

image.png

image.png

  1. Configure SQL Connection. Note that SQL configurations on whether your SQL database is hosted on the same server. This dropdown display SQL Server hosted on the same server Omni will be installed in.

However, if the SQL Server is hosted on a separate server, manually key in the SQL Server address in the β€œServer” box.

image.png

  1. You can test connection with the SQL Server via Windows Authentication or SQL Authentication, depending on how Omni is expected to authenticate with your SQL Server. This connection string will be used for Omni’s authentication with your SQL Server.

image.png

image.png

  1. Configure port Omni will be using. The default port for Omni is 8080. Thereafter, proceed to click β€œInstall”.

image.png

  1. Omni will be installed in your target installation directory.

image.png

  1. The installation will create a new service on the server.

image.png

image.png

  1. DB migrations will also be carried out during the installation into your target database.

image.png

  1. Once installation is complete, you should see this dialog box.

image.png

Jay

1 month ago