Technical Requirements for Omni Installation

Knowledge base

Server Requirements

Hardware Specifications:

  • CPU: Minimum 4 cores, recommended 8 cores
  • RAM: Minimum 16GB, recommended 32GB (for the entire server)
  • Storage: Minimum 5GB available disk space for Omni installation and data

Operating System:

  • Windows Server 2019 or later

Software Requirements

Database:

  • Microsoft SQL Server 2016 or later (Express, Standard, or Enterprise)
  • SQL Server database for Omni metadata storage
  • Database size estimate: 1-5GB depending on model complexity
  • SQL Server authentication or Windows authentication supported

Prerequisites:

  • Windows service installation requires temporary Windows Administrator privileges

Network & Connectivity Requirements

TM1 Integration:

  • HTTP/HTTPS access to TM1 REST API
  • Default TM1 HTTP port(s) for TM1 instances and Admin Host port 5898 (as configured in tm1s.cfg HTTPPortNumber)
  • Omni can be installed on the same server as TM1 or a separate server
  • If on separate server: firewall rules must allow outbound connections to TM1 server

Access for your Omni Users:

  • Inbound port for web interface: Default 8080 (configurable)
  • Protocol: HTTP or HTTPS
  • Firewall rules must allow inbound connections from user network segments

SSL/TLS Requirements:

  • SSL certificate required for HTTPS (recommended)
  • Certificate can be:
    • Domain-validated certificate
    • Self-signed certificate (for internal use)
    • Wildcard certificate

Security Requirements

Service Account:

  • Windows service account (local or domain)
  • Account needs:
    • "Log on as a service" permission
    • Read/write access to Omni installation directory
    • Database connection permissions

TM1 Authentication:

  • TM1 user account (typically a service account) with appropriate read permissions to all cubes/dimensions)
  • Supports most TM1 authentication modes (Mode 1, 2, 4, 5)
  • CAM/LDAP authentication supported

Architecture Options

Deployment Scenarios:

  1. Same Server as TM1:

    • Simplified architecture
    • No additional firewall rules needed
    • Shared resources consideration (Omni is very light on resources though)
  2. Separate Server:

    • Dedicated resources
    • Requires network connectivity to TM1
    • Better for load distribution

Monitoring & Maintenance

Logging:

  • Application logs stored locally

TM1 Impact:

  • Read-only access to TM1 REST API
  • Minimal performance impact on TM1 server
  • No changes to TM1 data or structures

Pre-Installation Checklist

  • Windows Server 2019+ available
  • Windows account with Administrator access for installation
  • SQL Server instance available
  • SQL account with database creation permissions
  • TM1 REST API accessible from the server we're installing Omni on
  • TM1 user credentials ready (so we can login)
  • SSL certificate procured (if using HTTPS)
  • Target URL/hostname decided
  • Network team notified for port openings (if required)

This comprehensive list should help IT teams prepare for installation and address common security and architecture questions upfront.

Jay

2 weeks ago