Omnis Studio 11 36251 INSTALL.TXT Date: March 2024 NOTE: Please note that you should install Omnis Studio 11 36251 into a new folder. *********** IMPORTANT NOTE ABOUT CONVERSION ********** IN ALL CASES, YOU SHOULD MAKE A SECURE BACKUP of all existing Omnis Studio 11 libraries BEFORE OPENING THEM in Omnis Studio 11 Revision 36251. IN ADDITION, OMNIS STUDIO 11 WILL CONVERT EXISTING VERSION 10.2.X, 10.1.X, 10.0.X, 8.x, 6.x OR EARLIER LIBRARIES - THE CONVERSION PROCESS IS IRREVERSIBLE. IN ALL CASES, YOU SHOULD MAKE A SECURE BACKUP OF ALL LIBRARIES AND OMNIS DATAFILES BEFORE OPENING THEM IN OMNIS STUDIO 11. ***************************************************** DISCLAIMER: OMNIS SOFTWARE LTD. DISCLAIMS ANY RESPONSIBILITY FOR, OR LIABILITY RELATED TO, SOFTWARE OBTAINED THROUGH ANY CHANNEL. IN NO EVENT WILL OMNIS SOFTWARE BE LIABLE FOR ANY INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES HOWEVER THEY MAY ARISE AND EVEN IF WE HAVE BEEN PREVIOUSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. ***************************************************** Please see the Readme.txt for information about this release, including any new features and for last-minute release notes. Contents:- 1. System Requirements 2. Installing the Omnis Studio SDK 3. Installing the Omnis Server 4. Unattended Installation of Omnis Studio 5. Omnis Serialization & Activation 1. System Requirements ====================== The minimum requirements for developing applications in Omnis Studio 11 are as follows: 1.1 Windows ----------- Intel system, 2GB RAM, and 250 MB free hard disk space, Windows 10 or above, including Windows 11. Specifically, support for SVG requires the Windows 10 Creators Update (1703) or later. 1.2 macOS --------- Intel / Apple Silicon, 8 GB RAM and 1.5 GB free hard disk space. Omnis Studio 11 64-bit is certified to run against a minimum of macOS version 10.15 (Catalina) or higher, including macOS 11, 12, 13 and 14 (Sonoma). Omnis may continue to run on 10.14 (Mojave), but this version is no longer certified and any issues specific to this version of the OS will not be addressed. The Omnis Studio 64-bit application will check the version of macOS and will not run if it is older than 10.14 (Mojave). In this case, Omnis Studio will be marked with a disabled icon. 1.3 JavaScript Client Web Browser Support ----------------------------------------- The following are the minimum versions of Web Browsers required to run the Omnis JavaScript Client: Chrome 60 Firefox 60 Edge 109 Safari 10 The Omnis JavaScript Client does not support Internet Explorer. 1.4 Deployment -------------- You can deploy Omnis Studio applications under Windows, macOS, and Linux. The Omnis App Server, for running Omnis web and mobile applications (using the Omnis JavaScript Client), will run under Windows, macOS, or Linux. The minimum requirements for deploying applications in Omnis Studio 11 are as follows: 1.4.1 Windows ------------- Intel system, 2GB RAM, and 250 MB free hard disk space, Windows Server 2019. Specifically, support for SVG requires the Windows 10 Creators Update (1703) or later. Omnis Studio is likely to run with earlier Windows operating systems, however these are not tested configurations. 1.4.2 macOS ----------- Intel / Apple Silicon, 8 GB RAM and 1.5 GB free hard disk space. Omnis Studio 11 64-bit is certified to run against a minimum of macOS version 10.15 (Catalina) or higher, including macOS 11, 12, 13 and 14 (Sonoma). Omnis may continue to run on 10.14 (Mojave), but this version is no longer certified and any issues specific to this version of the OS will not be addressed. The Omnis Studio 64-bit application will check the version of macOS and will not run if it is older than 10.14 (Mojave). In this case, Omnis Studio will be marked with a disabled icon. 1.4.3 Linux ----------- Intel system, 2GB RAM and 250MB free hard disk space. Minimum system software: Ubuntu 21.10, CentOS 9, RHEL 9.2, Fedora 35, or Debian 12.1. CentOS requires that pango and cups are installed. Omnis Studio is likely to run without OS updates, however these are not tested configurations. Omnis Studio is likely to run with earlier Linux operating systems, however these are not tested configurations. Contact your local sales office for further details about Omnis Studio development and deployment licenses. 2. Installing the Omnis Studio SDK ================================== NOTE: Please note that you should install Omnis Studio 11 into a new folder, not over the top of your existing Omnis folder. 2.1 Anti virus software ----------------------- Anti virus software can in certain circumstances stop the Omnis Studio installer from running. If your installation fails to run you may need to temporarily disable your anti virus software prior to running the Omnis Studio installer: please enable your anti virus software immediately after installing Omnis Studio. 2.2 Installing Omnis Studio under Windows ----------------------------------------- Run the Omnis Studio 11 installer and follow the instructions provided. Please note that you should install Omnis Studio 11 into a new folder, not over the top of your existing Omnis folder. Note for Runtime/Server: If all files are installed to Program Files then the User would have to run Studio as an Administrator (Run as administrator on the omnis.exe). Otherwise, if run as a Standard User then error messages will be generated indicating that files/folders cannot be created in the Program Files directory. 2.3 Installing Omnis Studio for macOS ------------------------------------- Open the Omnis Studio 11 package and follow the instructions provided. Please note that you should install Omnis Studio 11 into a new folder, not over the top of your existing Omnis folder. Under macOS you should note that Omnis Studio will not run correctly if you install it into a folder with a name that has over 31 characters. This restriction applies to any folder within the entire path to the Omnis application. Note that for installation of the Unicode version of Studio for macOS, the path can contain non-ascii characters. 2.3.1 Firstruninstall and Application Support folders ----------------------------------------------------- Any files that are updated by Omnis must be stored as user application data located in the user's home directory, that is, in the Application Support folder: ~/Library/Application Support/Omnis/ To do this, when Omnis starts up it will check for the existence of a folder called 'firstruninstall' in the macOS folder in the Omnis package. Any items which are contained in this folder are copied by default to a folder in Application Support with the same name as the Omnis package, e.g.: ~/Library/Application Support/Omnis/Omnis Studio 11 The copy will not occur if the destination folder already exists, therefore avoiding any files being overwritten. This provides a mechanism to place all data folders and their contents into the 'firstruninstall' folder, e.g. icons, studio, startup. Once copied into Application Support they are only updated in that location and leave the original macOS folder unchanged and its signature valid. 2.3.2 Prevent App Nap on macOS ------------------------------ The Omnis Studio installer on macOS enables the 'Prevent App Nap' property to stop the App Nap feature working on Omnis Studio. (Note the installer will only enable this option for the current user.) See the Readme.txt and the Apple website for more information. 2.4 Installing Omnis Studio for Linux ------------------------------------- Note there is no development version for Omnis Studio for Linux. The following notes apply to installing the server version of Omnis Studio for Linux only. Extract the Omnis Studio 11 tarball or run the installer file. Please note that you should install Omnis Studio 11 into a new folder, not over the top of your existing Omnis folder. 2.4.1 hal and openssl packages ------------------------------ Omnis Studio 11 executable for Linux no longer depends on HAL or OpenSSL, as in previous versions. However if you want to use the OW3 Workers you need to install OpenSSL. 2.4.2 Installing on 64 bit Linux platforms ------------------------------------------ In order to install & run Omnis Studio on 64 bit Linux platforms, you must first install the 32 bit shared libraries for your distribution prior to installing Omnis. 2.4.3 Running Omnis on a Linux machine with a multi-core processor ------------------------------------------------------------------ You may experience problems running Omnis on a Linux machine with a multi-core processor. One solution to this problem is to remove libc6-i686 which provides the lic6 libraries with thread local storage which are located in /lib/tls. See the Omnis Tech notes for further information about installing and running Omnis Studio under Linux: http://developer.omnis.net/technotes 2.5 Omnis Serialization ----------------------- Omnis Studio 11 is pre-serialized and does not prompt you for any serialization information. 3. Installing the Omnis Server ============================== Installers for the 64-bit version of the Omnis Server are available for Windows and macOS. An installer for the 32-bit version of the Omnis Server is available for Windows only. In addition there is a Headless version of the Omnis Server for Linux. 3.1 Omnis Server configuration during installation -------------------------------------------------- The following is for Windows and Linux Headless Server. The Omnis Server installer allows you to enter the Omnis Server and Web Services plug-in serial numbers as well as certain Server configuration settings. Note the configuration settings are optional during installation and can be set after the Omnis Server is installed under the File>>Server Configuration menu option, or by editing the config.json file in the server tree. After entering the serial number(s) you can enter the following Server configuration information (optional): - Server Port: the port or service name that your Omnis Server will listen on - Stacks: the number of method stacks (threads) on the Omnis App Server - Timeslice: the duration (in 1/60th second units) of the execution time slice for a server thread - Start Service: Allows you to start the Omnis Server as a service by default (only appears for Windows) - Name: Service name (only appears for Windows) - Display Name: Service display name (only appears for Windows) - Description: Service description (only appears for Windows) - Program: Executable name (only appears for Windows) - Start Type: 2 Automatic 3 Manual 4 Disabled (only appears for Windows) On the next page of the installer you can enter the following Server information (optional). The first set of fields applies to WSDL-based web services only: - Web Service URL: usually http://address/pluginurl, where address is the domain name or IP address of the Web Server, and pluginurl is the path to the Web Server plug-in on your Web Server (for web server based web services) - Web Service Connection: tells the Web Server plug-in how to connect to Omnis in the form [POOL,][IPADDRESS:][PORT] (for web server based web services) - WSDL Service Log: On/Off - Max Log Records: default 100 - Strict WSDL: On/Off The second set of fields applies to REST-based web services only: - RESTful URL: The base URL used to call Omnis RESTful Web Services, e.g. http://www.test.com/scripts/omnisrestisapi.dll - RESTful Connection: Controls how the Omnis RESTful Web Server plugin connects to Omnis in the form [POOL,][IPADDR:][PORT]. 3.2 Installing the Omnis Server under Windows --------------------------------------------- A Windows 64-bit and 32-bit Server installer is available for this release. Some files will be installed into the AppData folder. Choose Admin account to install under, required for install to Program Files. Run service as the local system account or add credentials for Admin above to run as Admin account. There is a check box on the Omnis Server installation dialog to run the Omnis Server as a service by default. Once installed the service is running. 3.3 Installing the Headless Server (Linux) ------------------------------------------ This Headless installer assumes you are running as Root or using sudo. Update your version of Linux using the commands below that correspond to your distribution of linux: Centos/redhat: sudo yum update Suse: sudo zypper update Ubuntu/debian: sudo apt-get update Once updated, you will need to install the dependencies that Omnis requires to run, which are as follows: - Centos/redhat: cups, pango - Suse/Debian: Runs out of box - Ubuntu: cups, libpango1.0 Once these are installed you can extract the tarball or run the installer file. Create a serial.txt in the root of the tree with the line SN=[serial number] using your Server serial number. For Centos 7 and redhat the service will not automatically start after a reboot, you will need to manually add Omnis (or whatever you called your service) to the service autostart list using the following lines: Sudo /sbin/chkconfig --add homnis Sudo /sbin/chkconfig --list homnis (This line is to show that you have added homnis correctly) Sudo /sbin/chkconfig homnis on You can now configure the Headless server using the Admin tool, as below. To summarize the steps for each platform: CENTOS7 & REDHAT Required commands for Omnis to run on Centos: Sudo yum update Sudo yum install cups Sudo yum install pango Sudo /sbin/chkconfig --add homnis Sudo /sbin/chkconfig --list homnis Sudo /sbin/chkconfig homnis on SUSE The Headless Server should work out of the box on SUSE, but we would recommend an update just in case: sudo zypper update Ubuntu 16.04, 17.04 & DEBIAN 9 sudo apt-get update sudo apt-get install sudo apt-get install libpango1.0 sudo apt-get install cups 4. Unattended Installation of Omnis Studio ========================================== You can run the Omnis Studio Windows or Linux installers unattended or "silently" without user interaction. Replace the version number of Omnis Studio as appropriate in the following examples. 4.1 Unattended Installation under Windows ----------------------------------------- Under Windows Vista/7 UAC will prompt user interaction; you must be the Administrator user to run the installer unattended. To do this: In Command Prompt navigate to the exe and type the following:- Omnis-Studio-11.x.exe --mode unattended Installs to the default installation directory without progress bar. To uninstall in unattended mode, in Command Prompt type:- [installed directory]\uninstall.exe --mode unattended Uninstalls without progress bar. e.g. C:\Program Files\Omnis Software\OS11.x\uninstall.exe --mode unattended 4.1.1 Additional Parameters for Unattended Installation ------------------------------------------------------- There are a number of additional parameters which you can use with any of the installers:- --unattendedmodeui minimal Installs to the default installation directory with progress bar. e.g. Omnis-Studio-11.x.exe --mode unattended --unattendedmodeui minimal --installdir "[install path]" Installs to a Custom installation directory. e.g. Omnis-Studio-11.x.exe --mode unattended --installdir "C:\Program Files\Custom\OS11.x" --installlocation [standard/single/firstruninstall] (Runtime and Server only) Installs writeable files to AppData (standard) or all files to single location (single). Installs writeable files in to firstruninstall directory (firstruninstall). (Runtime only) e.g. Omnis-Studio-11.x.exe --mode unattended --installlocation single --installscope [user/allusers] Installs for Current User only or All Users (Vista onwards). e.g. Omnis-Studio-11.x.exe --mode unattended --installscope allusers The following Windows example uses the various parameters:- Omnis-Studio-11.x.exe --mode unattended --unattendedmodeui minimal --installdir "C:\Program Files\Custom\OS11.x" --installscope allusers 4.1.2 Parameters for Unattended Installation of the Omnis Server ---------------------------------------------------------------- The following parameters are all for the Omnis Server installers (Windows only). They match the configuration options in the Omnis Server installer dialog. --serialno Serial No: --serverport Server Port: --serverstacks Stacks: Default: 5 --timeslice Timeslice: Default: 20 --startservice Start Service: Default: 0 --ntname Name: Default: OMNISServer --ntdisplayname Display Name: Default: OMNIS Server --ntdescription Description: Default: Omnis Web App Server --ntprogram Program: Default: OMNIS.EXE --ntstarttype Start Type: Default: 2 Allowed: 2 3 4 --webserviceurl Web Service URL: --webserviceconnection Web Service Connection: --wsdlservicelogging WSDL Service Log: Default: off Allowed: off faults full --maxlogrecords Max Log Records: Default: 100 --strictwsdl Strict WSDL: Default: true --restfulurl RESTful URL: --restfulconnection RESTful Connection: --adminaccount Administrator --adminpassword Admin Password 4.2 Unattended Installation under Linux --------------------------------------- In order to run an unattended installation, you can pass the unattended flag to the run file like so: ./omnis_hsvr.run unattended This will start the unattended installation. In order to have a successful unattended installation, a serial number is the minimum required. This can be supplied via serial flag like so (no spaces allowed for serial number): ./omnis_hsvr.run unattended serial SERIALNUMBER In the above case, settings such as the server port will be assigned to the default. The following is a list of all available switches for an unattended installation and the values they may need: unattended : does not take a value. Required in order to start unattended installation. serial : takes serial number which must not contain any spaces. Required in order to have a successful installation as Omnis will not start unless serialized. stacks : takes the number of stacks. If not passed, will use default value. timeslice : takes the number of timeslice. If not passed, will use default value. port : takes the port number to set as the server port. If not passed, will use default value. install-dependencies : does not take a value. If passed, will attempt to install dependencies. ws-url : takes the web service URL. If not passed, will use default value. ws-connection : takes the web service connection. If not passed, will use default value. ws-logging : takes the web service logging value (off, faults, full). If not passed, will use default value. ws-maxlog : takes the maximum number of web service log records. If not passed, will use default value. ws-strict-wsdl-off : does not take a value. If passed, will disable strict WSDL for the web service. rest-url : takes the URL for RESTful. If not passed, will use default value. rest-connection : takes the connection for RESTful. If not passed, will use default value. destination-dir : takes the absolute path for the destination directory of installation. If not passed, will use default value. service : takes the name of the service to create. If using service, the name of the service must be passed, otherwise a service with the default name will be created. owner : takes the name of the user that should own the installation directory and Omnis tree directory. Please note that this will take effect only when running the installer as root. [END OF FILE]