EnterpriseEditionInstallation IG v2021EE
EnterpriseEditionInstallation IG v2021EE
Enterprise Edition
Installation Guide
QAD Enterprise Edition
78-0950-2021EE
QAD Enterprise Edition 2021
September 2021
This document contains proprietary information that is protected by copyright and other intellectual
property laws. No part of this document may be reproduced, translated, or modified without the
prior written consent of QAD Inc. The information contained in this document is subject to change
without notice.
QAD Inc. provides this material as is and makes no warranty of any kind, expressed or implied,
including, but not limited to, the implied warranties of merchantability and fitness for a particular
purpose. QAD Inc. shall not be liable for errors contained herein or for incidental or consequential
damages (including lost profits) in connection with the furnishing, performance, or use of this
material whether based on warranty, contract, or other legal theory.
This document contains trademarks owned by QAD Inc. and other companies.
EnterpriseEditionInstallation_IG_v2021EE.pdf/b3s
QAD Inc.
100 Innovation Place
Santa Barbara, California 93108
Phone (805) 566-6000
https://www.qad.com
Contents
Enterprise Edition Installation Change Summary . . . . . . . . . . . . . . . . .v
Starting in September 2019, the new name for QAD’s complete portfolio of products is QAD
Adaptive Applications. Additionally, QAD Adaptive ERP is the new name for QAD’s flagship
ERP solution. QAD Adaptive ERP includes the functionality previously associated with QAD
Cloud ERP and QAD Enterprise Applications - Enterprise Edition, plus the QAD Enterprise
Platform and Adaptive UX which resulted from the Channel Islands program. Going forward, the
terms QAD Enterprise Applications, QAD Cloud ERP, and Channel Islands will be deprecated but
will remain in previous documentation and training materials. QAD’s intention is to—as soon as
possible—eliminate the use of the deprecated terms going forward.
Change Summary
The following table summarizes significant differences between this document and previous
versions.
Date/Version Description Reference
September 2021/2021EE Updated software requirements. page 4
Added information about hosting the QRF server on a Linux machine. page 5 and
page 15
Updated the QAD .NET UI client installation steps. page 22
Removed the Reporting Service chapter to reflect the functionality’s --
removal from QAD Financials.
September 2020/2020EE Updated software requirements. page 3
September 2019/2019EE Updated software prerequisites. page 3
Update installer prompts, adding new prompts for Namespace and page 10
Default App.
Removed requirements for installing on a Windows server. ---
October 2018/2018EE Updated installation steps to reflect occasional need to extract the page 10
Enterprise Edition zip file twice.
September 2018/2018EE Updated the required version of OpenEdge to 11.7.3. page 4
Updated the required version of Java SE Development Toolkit to 8. page 4
Added information about updating Tomcat-specific parameters for --
Windows installations.
March 2018/2017EE-Rev 1 Updated Appendix B to remove Routrek Granados and clarify the page 37
default SSH settings.
vi QAD Enterprise Edition Installation Guide
Comments? Go to goo.gl/MfwKHm
viii QAD Enterprise Edition Installation Guide
Installation Summary 2
System Components 2
Supported Installations 3
General Prerequisites 3
Overview
The following sections describe the QAD Enterprise Edition installation prerequisites and
configuration considerations.
Installation Summary
This installation guide describes the installation process in a standard Linux environment.
Configuration settings can vary across different operating systems and configurations. Appendix
A, “Operating System-Dependent Settings,” on page 35 outlines some of these settings and
explains how to define them.
Fig. 1.1
QAD Enterprise Edition Installation Process
YAB
QAD Enterprise Edition is installed using the QAD Enterprise Edition installer and is managed
using the QAD YAB console.YAB is the deployment and management toolset that covers all
products installed into an Enterprise Edition environment. It is updated independently of QAD
Enterprise Edition. When you install QAD Enterprise Edition, the YAB client is installed into the
build/client directory and the Enterprise Edition installer creates a shell script named yab in
the installation directory to run the client. You do not need to take any steps to install the YAB
client. For detailed information, see QAD Enterprise Edition Configuration and Administration
Guide.
System Components
A QAD Enterprise Edition system consists of server components installed on a UNIX host and the
QAD .NET UI client installed on Windows hosts.
Supported Installations
YAB supports installing all server components on a single host. It currently does not support a
distributed solution.
General Prerequisites
Before installing QAD Enterprise Edition, you should have:
• The QAD Enterprise Edition media or product download
• A valid QAD product license key for each module you have purchased
• A Progress database administrator who can manage Progress client processes
• A UNIX administrator for UNIX/Linux installs
• A 100 Mbps or faster network
• Easy access to this guide
Operating System
QAD Enterprise Edition requires one of the following operating systems.
• Red Hat Linux version 7, with version 7.4 or higher recommended
• CentOS Linux version 7, with version 7.4 or higher recommended
Comments? Go to goo.gl/MfwKHm
4 QAD Enterprise Edition Installation Guide
OpenEdge 11.7.9
QAD Enterprise Edition requires OpenEdge 11.7.9. Consult the Progress documentation for the
complete requirements for Progress components. When you install Progress components, always
select a Complete installation, not a Typical or Custom installation.
Note It is recommended that you disable OpenEdge Fathom to avoid conflicts if multiple
instances of an EE environment are installed on the same host. In the directory where Progress is
installed, open the fathom.init.params file and change the value of the “fathomEnabled”
property to false:
fathomEnabled=false
Python 2.7
QAD Enterprise Edition supports Python 2.7. Install Python using documentation provided by
your operating system vendor or download the software from https://www.python.org.
OpenSSL Libraries
For enhanced security, QAD Enterprise Edition generates an access token during login. The token
is signed using the OpenSSL library to verify its authenticity.
Note The Enterprise Edition installer validates your system’s OpenSSL library during
installation. If you do not have the appropriate OpenSSL library, the install will fail and you will
be directed to this section of the installation guide. You can choose to validate your OpenSSL
library prior to launching the Enterprise Edition installer by following the steps for your OS
outlined in this section, or you can return here if the installer identifies OpenSSL as the reason
your install failed.
Follow the steps for your OS to install or update OpenSSL.
Linux/UNIX
b If OpenSSL is not installed, download and install it. See your OS vendor for the most up-
to-date version.
Note Ensure that you download the appropriate OpenSSL version for your OpenEdge
installation. If you have 32-bit OpenEdge, you must install 32-bit OpenSSL, and if you have
64-bit OpenEdge, you must install 64-bit OpenSSL.
2 Once OpenSSL is installed, find the libcrypto.so file. It is recommended that you begin
your search in /usr/lib or /usr/lib64, depending on your OpenEdge installation. The file
name may be a variation of libcrypto.so, with, for example, the version number added to
the file name: libcrypto.so.0.9.3e.
Note You may have to extract libcrypto.so from the libcrypto.a archive.
Comments? Go to goo.gl/MfwKHm
6 QAD Enterprise Edition Installation Guide
Wine and Virtual X Windows Server are required for systems running QRF on a Linux server and
both must be installed prior to running the Enterprise Edition installer. If you do not plan to install
QRF on Linux, you can skip these two requirements.
Wine (32-bit)
Wine is a compatibility layer that can run Windows applications on Linux and which translates
Windows API calls into POSIX calls on-the-fly. For compatibility with the QAD Reporting
Framework, you must install the 32-bit version of Wine.
Consult Wine documentation, including the WineHQ FAQ, for complete requirements and
installation recommendations. The following installation information is given as guidance and is
not intended to cover every company’s individual circumstances.
> wget https://raw.githubusercontent.com/zma/usefulscripts/master/script/install-wine-
5.0-centos7.sh
> chmod a+x install-wine-5.0-centos7.sh
> sudo ./install-wine-5.0-centos7.sh
Note The entire install can take around 30 minutes. At times the installation may seem
unresponsive and at other times it may be verbose. Do not submit a premature Ctrl-C.
The Virtual X Windows Server, Xvfb, is a display server that performs all graphical operations in
virtual memory without showing any screen output. Install Xvfb with the following command:
> sudo yum install Xvfb -y
• Customized database structure files. See Appendix C, “Customized Database Structure Files,”
on page 39.
Delayed Installation
A delayed installation provides an opportunity to review and adjust your system configuration
using YAB before creating Enterprise Edition. You include the argument -install-
update:false when executing the install script to initialize the environment but postpone the
creation of Enterprise Edition.
> ./install.py -install-update:false
After you review and adjust your system configuration, complete the Enterprise Edition creation
by entering:
yab update
Comments? Go to goo.gl/MfwKHm
8 QAD Enterprise Edition Installation Guide
Overview
QAD Enterprise Edition is installed using the Enterprise Edition installer.
3 If the extracted zip file contains a data.zip file, extract that second zip file. If there is not a
data.zip file in the subdirectory, continue with step 4.
4 If the new directory contains a data.zip file, mount that second zip file. If there is not a
data.zip file in the directory, take no action and continue with “Start the Enterprise Edition
Installer.”
2 The Enterprise Edition installer starts. Press Enter to proceed with the installation.
Note The installer has a command mode that allows you to go back to previous questions,
proceed to the next question, quit the installation, or return to interactive mode. You can move to
command mode at any prompt by entering an exclamation point, !.
Fig. 2.1
Installer Welcome
3 Read and accept the software license agreement to proceed. If you do not accept the license
agreement, the installation stops.
Comments? Go to goo.gl/MfwKHm
12 QAD Enterprise Edition Installation Guide
Fig. 2.2
License Agreement
Fig. 2.5
Java Location
8 Specify the OS account that should be used by application components that start terminal
sessions. For more information, see “Operating System Account” on page 5.
Fig. 2.7
OS Account
10 Enter the list of languages for your installation. You must enter at least one language before
you can continue. English is “us.”
Comments? Go to goo.gl/MfwKHm
14 QAD Enterprise Edition Installation Guide
Table 2.1
Available Languages in Enterprise Edition
Language Option
Chinese (simplified) ch
Chinese (traditional) tw
Czech cz
Dutch du
English us
French fr
German ge
Italian it
Japanese jp
Korean ko
Polish pl
Portuguese po
Spanish (Castilian) cs
Spanish (Latin) ls
Fig. 2.9
Optional Languages to Install
11 Enter the Namespace of the environment into which you are installing. This Namespace is
used to distinguish between QAD data and customized data. Use the same Namespace when
installing into multiple environments (for example Dev, Test, and Production).
Fig. 2.10
Namespace
12 Enter the default app to create. This app is used for future platform development.
Fig. 2.11
Default App
13 Select the features to install. An X next to a feature indicates that it will be included in the
installation. To add or remove an X, type the number that corresponds to the feature and press
Enter. Enterprise Edition is always part of the installation and its selection cannot be removed.
Demo data is sample data you can install for use in a test environment. An installation with
demo data takes considerably longer than an installation without the additional data.
Important Do not install demo data into an environment that is to be used for a conversion. If
you have already installed demo data, you must remove it. See the “Using Demo Data” section
of the QAD Administration and Configuration Guide for YAB 1.13 on the QAD Document
Library.
The QAD Reporting Framework (QRF) is installed on a Windows server by default. You can
choose to install it on the Linux server by selecting the QRF on Linux option.
Note For the QRF on Linux option, you must have Wine and Virtual X Windows Server
installed prior to Enterprise Edition installation, as explained in Software and Hardware
Prerequisites on page 5. If you do not have Wine installed, the Enterprise Edition install will
fail. For detailed instructions on setting up and working with the QAD Reporting Framework
Service, see the QAD Reporting Framework User Guide on the QAD Document Library.
Fig. 2.12
Features
14 The installer prompts you to start Enterprise Edition installation. Enter y to begin the install.
Fig. 2.13
Start Enterprise Edition Installation?
15 The installation begins. Status messages appear that show the progress of the installation.
Note Some install actions take several minutes to complete.
Comments? Go to goo.gl/MfwKHm
16 QAD Enterprise Edition Installation Guide
Fig. 2.14
Enterprise Edition Installation Successful
l
Fig. 2.15
Services Started
Review the status list to ensure that required services display STARTED. Daemon processes read
STOPPED after initial installation, as illustrated in Figure 2.15, and will remain stopped until they
are configured. Daemon setup is described in the QAD System Administration Guide, available on
the QAD Document Library. If other services are stopped or for more information, see
“Troubleshooting” on page 31.
Comments? Go to goo.gl/MfwKHm
18 QAD Enterprise Edition Installation Guide
6 In the Add Product screen, complete the License Code fields by entering the codes from the
license code sheet included with your release media. Select OK.
Fig. 2.18
Add Product
7 In the Add Authorized Users screen, enter All for User and press enter.
Fig. 2.19
Add Authorized Users
8 In the User Selector screen, press the <F1> key. At the “Is all information correct” prompt,
enter y for yes and press enter.
Fig. 2.20
User Selector
9 The Registered Products screen reappears with a list of the license codes you have added.
Fig. 2.21
Registered Products
10 Repeat step 5 through step 9 for additional license codes. Select OK when all codes have been
entered.
11 Reload the character client as described in step 2 to verify that license setup was successful.
Comments? Go to goo.gl/MfwKHm
20 QAD Enterprise Edition Installation Guide
Overview
Once you have installed Enterprise Edition on a UNIX machine, you can install the QAD .NET UI
on multiple Windows computers.
3 Under USER INTERFACES, find the Windows listing and copy or note the URL.
USER INTERFACES
Web <URL>
Windows <URL>
Character scripts/client-[LANG]
Fig. 3.1
QAD Enterprise Application Client Download
4 The .exe file may launch automatically after the download is complete or you may need to
click the downloaded file.
2 Choose whether to install a new instance of the QAD .NET UI or upgrade an existing instance.
Click Next.
Comments? Go to goo.gl/MfwKHm
24 QAD Enterprise Edition Installation Guide
Fig. 3.3
Install an Instance
3 You are now ready to install an instance of the QAD .NET UI. Click Install.
Fig. 3.4
Ready to Install
4 The setup wizard displays the installation progress, and then the Setup Wizard Complete
screen appears. Click Finish.
5 The QAD Enterprise Applications shortcut appears on your desktop and is ready to launch.
2 Click OK.
3 The QAD .NET UI appears, indicating that the install was successful.
Comments? Go to goo.gl/MfwKHm
26 QAD Enterprise Edition Installation Guide
Overview
Enterprise Edition supports multiple add-on products to expand and enhance your ERP
environment. For additional information on which add-on products are compatible with this
release of Enterprise Edition, refer to the Product Compatibility Guide in the QAD Store and to the
individual add-on installation guides.
For detailed pre-installation requirements, see the installation guide for your specific add-on
product. Ensure that those requirements are met before proceeding with the installation.
5 For post-installation requirements and configuration information, see the installation guide for
your specific add-on product.
Comments? Go to goo.gl/MfwKHm
30 QAD Enterprise Edition Installation Guide
Troubleshooting
This chapter addresses troubleshooting topics.
Overview 32
General 32
Installation 33
32 QAD Enterprise Edition Installation Guide
Overview
This chapter introduces troubleshooting techniques to use during Enterprise Edition installation.
The information is divided into two sections.
• General – Information you can use during both installation and administration.
• Installation – Information specific to installation.
General
The troubleshooting techniques detailed in this section can apply to both installation and
administration questions.
Diagnosis
Log Threshold
The default log threshold is DEBUG, which records detailed information in the install and
administration log files. You can change the logging level to TRACE using the -log-level
option, which will print more verbose information to help diagnose a problem.
-log-level:[OFF|FATAL|ERROR|INFO|DEBUG|TRACE]
Temporary Files
Temporary files are files that are created while servicing a request and deleted after the request is
serviced. In some cases, the key to diagnosing a problem is to be in a position to view these files.
To retain temporary files created in subsequent requests, define the following environment
variable:
> export KEEP_TEMP_FILES=true
By default temporary files are written into the /tmp directory. YAB can be configured to write
temporary files into a different directory by configuring the YAB_JAVA_OPTS environment
variable:
> export YAB_JAVA_OPTS=-Djava.io.tmpdir=PATH
Errors
If you do not have a Java Runtime configured you will see the following error when you execute
the installer:
> ./install.py
/qad/sandbox/user/qadee/image/packages/yab-client/1/11/0/22/yab: line 38:
java: command not found
If you have an incorrect version of the Java Runtime configured, you will see the following error
when you execute the installer:
> ./install.py
Exception in thread "main" java.lang.UnsupportedClassVersionError: Bad version
number in .class file
Enterprise Edition requires Java 1.8, which is also supported by the YAB administration tool and
the installer.
The following command prints the version of the Java Runtime resolved from the PATH.
> java -version
java version "1.8.0_202"
Java(TM) SE Runtime Environment (build 1.8.0_202-b08)
Java HotSpot(TM) 64-Bit Server VM (build 25.202-b08, mixed mode)
If the JAVA_HOME environment variable is set, it will take precedence over the Java Runtime
located by the PATH environment. You can check the setting of the JAVA_HOME environment
variable and unset it if necessary.
> echo $JAVA_HOME
/usr/java/jdk1.5
> unset JAVA_HOME
> echo $JAVA_HOME
Installation
The troubleshooting techniques detailed in this section are specific to the installation process.
Diagnosis
Log File
The Enterprise Edition installer records detailed information in the log file. The default log file
location is:
/tmp/install.[USER].log
If an error occurs while installing the product, you should review the log file. It may contain
information that was not displayed on the console.
Comments? Go to goo.gl/MfwKHm
34 QAD Enterprise Edition Installation Guide
If the installation fails before the update command has started (Starting update... in the following
code text), the install should be executed again after the problem has been resolved.
Validating OK
Initializing instance OK
Reconfiguring instance OK
Resolving and copying packages OK
Starting update...
update (282 tasks)
----------------------------------------------------------------------------
1/282 qad-rd-permissions-mkdirs OK (0.032 s)
2/282 qxtend-stage OK (54.844 s)
3/282 adminserver-script OK (0.023 s)
4/282 nameserver-script OK (0.017 s)
...
If the installation fails during the update command, it will be more efficient to diagnose the
problem using the techniques outlined in the QAD Enterprise Edition Configuration and
Administration Guide and to execute the update command directly when the problem is resolved.
> yab update
Install Failed
If the install fails, it displays INSTALL FAILED, with limited information on the cause of the
failure. Review the log files and contact QAD Support if further guidance is required.
Operating System-Dependent
Settings
This appendix addresses operating system-dependent settings.
Dependent Settings 36
Dependent Settings
The following settings can differ depending on the operating system:
netui.connmgr.loginprompt
netui.connmgr.passwordprompt
netui.connmgr.serverprompt
These settings can be defined in the install.conf file before installing QAD Enterprise Edition
or by editing the configuration.properties file in an existing environment.
The following example outlines how to define the server prompt setting. This process also can be
followed to define the login and password prompts.
Install.conf File
To set the server prompt before installing, add the following to the install.conf file:
netui.connmgr.serverprompt=>
Configuration.properties File
To determine the server prompt used in an existing environment, use yab config:
> yab config netui.connmgr.serverprompt
netui.connmgr.serverprompt=$
Depending on the default shell, these settings also may need to be changed.
Telnet 38
38 QAD Enterprise Edition Installation Guide
SSH
By default, a QAD Enterprise Edition environment is configured to use SSH protocol for
Connection Manager and terminal sessions. The default settings in
configuration.properties are:
netui.connmgr.protocol=ssh
netui.telnet.protocol=ssh
netui.connmgr.port=22
netui.telnet.port=22
Telnet
The environment can be switched to use the Telnet protocol by configuring the following settings
in configuration.properties:
netui.connmgr.protocol=telnet
netui.telnet.protocol=telnet
netui.connmgr.port=23
netui.telnet.port=23
Note One database, arcdb, is not associated with a database structure file.
Copy the standard structure files into the new directory and create files for the database that is not
associated with a database structure file.
> cp build/work/st-files/*.st customizations/st-files
> cp customizations/st-files/rcddb.st customizations/st-files/arcdb.st
Note The names of the data areas in the structure files, such as MFG and MFG_IDX, are
important because they correspond to the schema files that you will load into the databases when
you create the environment.
Comments? Go to goo.gl/MfwKHm
42 QAD Enterprise Edition Installation Guide
*Log-in required
44 QAD Enterprise Edition Installation Guide