Application Installation Guide

Getting Started

This documentation will assist with installing the major components of the Progeny 10 software package and provide basic options for customizing the installation. As always, Progeny Support is available to assist should users have any questions about the application installation or if your network has special/non-standard configurations that require additional consideration.

A note about Progeny Downloads and Updates

Progeny no longer ships physical media for its software – installation and update files are delivered via digital download. Use the credentials from the introductory email along with hyperlinks from this document/hyperlinks from a Progeny representative to download the various components of Progeny 10. When updates are issued, Progeny will send an email notification containing a hyperlink to the update and release notes.

• Updates to the Progeny Desktop Client are provided in the form of a .exe file which is downloaded and run on the end user’s PC.
• Progeny Desktop Client update notices will be sent to anyone on our email notification list.
  • If you would like to sign up for the email notification list, please visit http://maillist.progenygenetics.com
  • Updated versions are also available from the login screen of the Progeny Desktop client via the Acct Info… and Update… buttons.

Progeny Desktop Client Installation

Before Installing the Progeny Desktop Client

Log into the desktop computer with a user account that has LOCAL ADMINISTRATIVE rights. Without LOCAL ADMINISTRATIVE rights, users will not be able to complete the installation of the desktop client.

BEFORE GOING ANY FURTHER – make sure to create a backup of all active databases. The conversion from Progeny 8 or 9 to Progeny 10 CANNOT BE REVERSED. From the database server, make manual backups of BOTH the database file and the transaction log file for each database that will be upgraded to Progeny 10.

Before installing any of the Progeny software, verify the computer configuration meets the System Requirements.

To look up the computer’s configuration, use the following options based on the operating system version:

• Windows 7 – Open Control Panel, click on System and Security and click System.
• Windows 8 – Hold down the Windows key and press X on the keyboard (WIN+X) and choose System from the menu that appears.
• Windows 10 – Type in the windows search bar, at the bottom left of the taskbar, System and choose System when it appears.

Once that is confirmed, then you can proceed to download the Progeny Desktop Client.

NOTE: This requires your Customer Number. If you do not know this number, reach out to Progeny Support for assistance.

Running the Progeny Desktop Client Installation

1. Double-click the .exe file to launch the installation utility.
2. Click Next to proceed to the Software License Agreement.
3. Please take a moment to read through the License Agreement (or print a copy). When ready to proceed, select the I accept the terms in the license agreement radio button and click Next.
   
4. Click Next to save Progeny 10 to the default directory C:\Program Files (x86)\Progeny Software\Progeny 10:
   
5. Click Install to continue the installation process.
   NOTE: If using Windows 7, Windows 8, or Windows 10, users may encounter a Windows UAC (User Account Control) prompt after clicking the Install button. Click Yes on the UAC prompt to continue the installation.
6. The installation process usually takes between 30 seconds to 2 minutes depending on the computer. When a successful confirmation message is displayed, click the Finish button to complete the installation and close the installer window.

Licensing the Desktop Installation (Registration)

1. Launch the Progeny application from the desktop:
2. Input the License ID provided in the introductory email.
3. Click Verify.
4. Click OK.
   For the Progeny client and web software to be licensed, a connection to and from the Progeny Licensing Server must be allowed.
   Please review the GLS Introduction or contact Progeny Support for assistance.

Connect the Progeny Desktop Client to a Database

From the Progeny login screen, there are two options for connecting to a database: Local Database and Network Connection.

Local Database Connections

A Local Database connection is used for Progeny databases stored on the user’s desktop or on a network share. When the Progeny Desktop Client is installed, the Progeny Template Demo database is automatically installed to the user’s Documents\Progeny 10 folder. Local connections allow only one user to be connected to the database at a time.

To connect to this or another database stored on the computer or a network share (NOT a database hosted by the Progeny Server application), choose the Local Database radio button from the login screen then click Browse:

The next pop-up window allows users to browse to the database file. Once located, select the database file, click the Open button to return to the login screen with the selected database. Enter the username and password for the database, then click the Login button to log into the database.

Network Database Connections

A Network Connection is used for Progeny databases hosted on the network using the Progeny Server application.

To connect to a network database, click the Network Connection radio button on the Desktop Client Login screen, then click the Manage button:

The Network Connections window opens, click New. Then fill in the connection parameters for the network database:

Network Connection Information Description

Option	Description
Connection Name	This is the database name that will appear in the Network Connection drop-down list on the login screen. Choose any name that can be easily distinguishable between databases.
Database Service	This is the broadcast name of the network Database Service. It must match the broadcast name EXACTLY in both spelling and case. It is the value of the –n parameter in the service configuration of the database in SQL Anywhere.
Database Name	While both the Database Name and Host Address parameters are considered optional, the Database Name parameter is the only one that is truly not required. This is necessary if multiple databases are running off the same Database Service.
Host Address	This will be either the database server’s IP address, hostname, or FQDN (Fully Qualified Domain Name) followed by a colon (:) and the port number that the Database Service is using.

Once all the required information is entered in the new Network Connections, click the Save button in the bottom-right corner then click the red X in the top-right corner to close the Network Connections window and return to the login screen.

Back on the login screen, click the drop-down menu below the Network Connection radio button and choose the new database connection from the list. Enter the Username and Password, then click Login to connect to the database.

Database Server Installation

Installing the Database Server

Installing the Progeny Database Server application is a straightforward process which should take no more than 10-15 minutes. First, download the Progeny 10 Server installation file and run the installer:

http://www.progenygenetics.com/software/server/current.html

1. Double-click the .exe to launch the installation utility.
2. Click Next to proceed to the Software License Agreement.
   
3. Please take a moment to read through the License Agreement (or print a copy). When ready to proceed, select the I accept the terms in the license agreement radio button and click Next.
   
4. Click Next to save Progeny 10 Server to the default directory C:\Program Files (x86)\Progeny Software\Progeny 10\Server:
5. Click Install to continue the installation process.
   NOTE: If using Windows 7, Windows 8, or Windows 10, users may encounter a Windows UAC (User Account Control) prompt after clicking the Install button. Click Yes on the UAC prompt to continue the installation.
6. The installation process usually takes between 30 seconds to 2 minutes depending on the computer. When a successful confirmation message is displayed, click the Finish button to complete the installation and close the installer window.

Creating the Network Database Service

1. Once the Progeny 10 Server is installed, launch the Progeny 10 Server Configuration Utility:
   
2. Double click on SQL Anywhere 17:
3. Select the Services tab:
4. Right-click on a blank area in the Services list, and choose New > Service:
   
5. This will open the Create Service Wizard. On the first window, choose a name for the service which will be displayed within the Progeny 10 Server application. This name cannot contain any spaces, slashes, or backslashes. The name entered in this step is a “friendly name” that is local to the application and is not connected to the actual service. This is also, typically, the same as the Connection Name parameter in the desktop client Network Connections After the service is named, click Next:
6. On the next window, define the type of Database Service to be created. Keep the default-selected option Network Database Server then click Next:
   
7. On the next window, define the server executable to use for the service. Keep the default path C:\Program Files (x86)\Progeny Software\Progeny 10\Server\Bin64\dbsrv17.exe and then click Next:
   
8. On the Specify Parameters window, create a connection string that defines what database is being hosted, the port it will be broadcasted on, and any miscellaneous optional configuration settings. Reference an example of the default connection string format below:-x tcpip(port=####) -n $$$$ “%PATH%”
   

   Specify Parameters Descriptions

   Option	Description
   ####	The server port dedicated to the database service
   $$$$	The broadcast name of database service. This can be the same as the first window when naming the service.
   %PATH%	The path to the database file. Ensure it includes the .db extension and is encapsulated in quotation marks.

   
   Once the connection parameters are entered, click Next.

9. In the Select an Account window, keep the default-selected option Local system account unless your organization’s IT policy requires otherwise. Click Next to continue.
   
10. The Startup Type on the following window should always be set to Automatic during normal operation as this will start the service should the server be restarted without needing to prompt you. Click Next:
    
11. Finally, DO NOT select the checkbox on the Start the Service window – if you made any mistakes during the service creation process this option will cause the application to hang for 10-15 minutes then crash. Click Finish:
    
12. The Services list will now include the newly created database service with an icon to its left showing a yellow cog with a red square. Right-click the service name and choose Start:
    
13. The database service will start when the red square changes to a green triangle:
    If starting the Database Service fails, please contact Progeny Support for assistance.

NOTE: If you already have Progeny 9 Server (Sybase SQL Anywhere 12) installed, after you install Progeny 10 Server (Sybase SQL Anywhere 17), you will need to edit each existing database service by double-clicking the service, selecting the Configuration tab, and pointing the File name: to the Progeny 10 Server dbsrv17.exe file. The default path is C:\Program Files (x86)\Progeny Software\Progeny 10\Server\BIN64\dbsrv17.exe.

Also, if you are using a 32-bit operating system, change “BIN64” in this path to “BIN32”.

Web Server Installation

Web Server Components and Installation Requirements

The Progeny Web Server consists of the following components:

• Java Runtime Version 8
• Apache Tomcat 9
• Progeny Web Application (ROOT.war file)

For web browser system requirements, see the System Requirements.

Installing the Web Server

Java Runtime and Apache Tomcat

1. The first step is to install the Java Runtime installer as the Apache Tomcat install will reference Java during its own installation; you will have the opportunity to uninstall any unused older versions of Java, resulting in a more secure server. Once complete, launch the Apache Tomcat Setup (.exe).
   NOTE: Ensure that the 64-bit version of Java is installed. Progeny is NOT compatible with the 32-bit version.
2. Click through the Apache Tomcat Setup welcome and licensing pages. On the Choose Components page, click the + (expansion button) next to the Tomcat item to reveal this additional options. Check only the Service Startup option. Click Next to continue.
   
3. On the Apache Tomcat Setup: Configuration Options window, configure the following:
   

   Option	Description
   Server Shutdown Port	8005 (Default)
   HTTP/1.1 Connector Port	Use port 80 if possible. Port 8080 works if 80 is unavailable.
   AJP/1.3 Connector Port	8009 (Default)
   Windows Service Name	Tomcat8 (Default)

   Once the desired modifications are made, click Next.

   

4. Define the file path where the Java Virtual Machine is located – therefore, Java should be installed first. The Tomcat installation will automatically identify the best-possible Java Runtime location available. After the appropriate Java location is detected, click Next:
   
5. On the Choose Install Location dialog box, define the installation directory. The default location is C:\Program Files\Apache Software Foundation\Tomcat 9.0 for ease of management, however, based on your institution’s preference, a different location may be used. Once the desired installation directory is chosen, click Install:
   
6. When the installation process has completed, deselect the Run Apache Tomcat and Show Readme checkboxes and click Finish:
   

Progeny Web Application (ROOT.war file)

When Apache Tomcat is installed, a default ROOT folder is automatically created with the default Tomcat settings. This will be deleted and replaced with the Progeny Web application (ROOT.war file). Follow the next section in this guide for instructions on how to replace the default ROOT folder with the Progeny ROOT.war file before starting the Apache Tomcat service.

Download and copy the most recent ROOT.war file before starting the Apache Tomcat service. To begin, access the Progeny 10 Web Update here: http://www.progenygenetics.com/updates/web

1. 1. Select DOWNLOAD WEB 10.X.X.X.
   2. A new page is displayed, input the Customer Number.
   3. Click Download (make a note of where the file is downloaded).Depending on the network settings, the ROOT.war file may download as ROOT.zip – if this happens, simply change the extension to .war (disregard the warning that may pop up saying the file may become unusable):
      
   4. Open Windows Explorer and navigate to the Apache Tomcat installation directory C:\Progeny Files\Apache Software Foundation\Tomcat 9.0\ and open the ‘webapps’ folder.
   5. Delete the existing ROOT folder.
   6. Copy and paste the ROOT.war that was just downloaded into the same Files\Apache Software Foundation\Tomcat 9.0\webapps
   7. Navigate to the Apache Tomcat installation directory C:\Program Files\Apache Software Foundation\Tomcat 9.0 and open the ‘bin’ folder. Double-click to open ‘Tomcat9w.exe’.
   8. On the Java tab, check the Use default checkbox to automatically use the default Java and add the following parameters AT THE END of the Java Options text area:

-XX:+UseConcMarkSweepGC
-XX:+UseParNewGC
-XX:+CMSParallelRemarkEnabled
-XX:+UseGCOverheadLimit
-Djdk.tls.rejectClientInitiatedRenegotiation=true
-Dsun.security.ssl.allowUnsafeRenegotiation=false
-Dsun.security.ssl.allowLegacyHelloMessages=false
-Djavax.net.ssl.SSLParameters.setUseCipherSuitesOrder(true)
-Djdk.tls.ephemeralDHKeySize=2048

In the Initial memory pool and Maximum memory pool, enter the correct amount of memory based on the calculation below. For Thread stack size, enter 2048.

The 4096 in the parameters above refers to the initial and maximum memory pool. About 50% of the workstation’s memory should be used. For example, it is recommended for a server with 8 GB of memory to allocate 4 GB. To convert GB to MB, multiply by 1024.
Ex. 4 * 1024 = 4096 MB.Click OK to save the changes.

Start the Apache Tomcat 9 service via Task Manager or the Services program.

When the service starts, within the ‘webapps’ folder, a new ROOT folder will automatically be created. Tomcat recognizes .war files as application packages and will automatically deploy it as an application folder – this may take  2-10 minutes as the WAR file needs to fully unpack the new ‘ROOT’ folder.

Firewall Rules

Firewall rules are created to allow a computer to send traffic to or receive traffic from specific services, programs, computers, or users. For Progeny to work properly, Inbound firewall rules need to be added for dbsrv17.exe and Tomcat9.exe.

Progeny Database Server Rule

1. Open Windows Firewall with Advanced Security:
   
2. Select Inbound Rules.
3. Select New Rule…
4. Choose the radio button for Program and select Next.
5. Browse to find the program path C:\Program Files (x86)\Progeny Software\Progeny 10\Server\BIN64\dbsrv17.exe and select it then click Next.
   
6. Choose the radio button Allow the connection and select Next.
7. Select Next on this window or configure according to local network policy.
8. Name the new rule, Progeny Database – Sybase SQL Central and click Finish:
   

Tomcat9 Rule

1. Within the same Windows Firewall program, select New Rule…:
   
2. Choose the radio button for Program and select Next:
3. Browse to find the program path Tomcat9.exe in the bin folder (default C:\Program Files\Apache Software Foundation\Tomcat 9.0\bin\Tomcat9.exe) and select it, then click Next.
4. Choose the radio button Allow the connection and click Next.
5. Click Next on this window or configure according to local network policy.
6. Name the new rule Progeny Web – Apache Tomcat and click Finish:
   

Licensing and Configuring the Progeny Web Application (New Installation)

1. Open a web browser and navigate to either
   http://localhost OR http://localhost:8080, depending on how Apache Tomcat was configured earlier in the installation.The page will then redirect and append the configuration string below:/CONFIG?id=162d2827-d57f-45c3-b385-49060d087fa0&UTYPE=INTERNALThe completed configuration URL will appear like:http://localhost/CONFIG?id=162d2827-d57f-45c3-b385-49060d087fa0&UTYPE=INTERNALIf the setup to this point has been successful, a login page like the following should display.

If this login page does not display, please review the installation steps or contact Progeny Support for assistance.

2. Standard user credentials will not work on this page. To access this configuration page, log in with the following credentials:
   Username: config
   Password: internal

Derby Configuration Database

Once logged in, you are automatically directed to the Derby Configuration Database within the Progeny Configuration Window. Derby is a service that installs as soon as the ROOT.war web application is deployed. This small service contains the entire web application configuration.

This Derby service is contained in the following directory and contains the web configuration:
Progeny 10: C:\Program Files\Apache Software Foundation\Tomcat 9.0\progenyConfig\conf
Progeny 9: C:\Program Files\Progeny Software\Progeny 9\web\conf

Connect Derby to a Local Database

To connect Derby to a local database, select the Connect to Local Database radio button and enter the required specifications:

1. Enter the Local server port number. Note: By default, this port is set to 1527.
2. Use the default configuration password. This password is “internal”.
   Note: This password may have been changed by your organization.
3. Click Start & Connect.
4. A message confirms, Configuration was successfully changed.
   
5. Refresh the page (F5) and log in again with the configuration username and password.

Connect Derby to Network Database

This option allows users to connect to a Derby service that is running on a separate machine. Configuration changes made on the parent server will reflect on the child. This gives the option to share Derby; as a result, the two web clients will have an identical configuration.

To connect to Derby remotely, select the Connect to Network Database radio button and enter the required specifications:

1. Enter the Server host. This could either be the hostname or IP address of the remote machine already running Derby.
2. Enter the Server port number. This is the port used on the remote Derby.
3. Use the default configuration password. This password is “internal”.
   Note: This password may have been changed by your organization.
4. Click Connect.
5. A message confirms Configuration was successfully changed.
6. Refresh the page (F5) and log in again with the configuration username and password.

Security Management – Global License Server Setup

After logging back into the Progeny Configuration, users are directed to the Security Management window.

1. To begin the Global License Server Setup, enter the License ID – XXXXXXX (7-digit customer number) XXX (3-digit license code); Example 1234567123

1. Note: The license code may vary depending on the product purchased. If you are unsure of your License ID, please contact Progeny Support.
2. Click Generate to create a Client Serial ID.
3. Click Verify License.
4. A message confirms License successfully validated.
   For the Progeny client and web software to be licensed, a connection to and from the Progeny Licensing Server must be allowed.
   Please review the GLS Introduction or contact Progeny Support for assistance.

Database Connection Configuration

1. Click the Database Connection Configuration navigation button.
2. Click the New button and enter the following information.

Option	Description
Connection Name	This is the database name that will appear in the Network Connection drop-down list on the login screen. Choose any name that can be easily distinguishable between databases.
Service Name	This is the broadcast name of the network Database Service. It must match the broadcast name EXACTLY in both spelling and case. It is the value of the –n parameter in the service configuration of the database in SQL Anywhere.
Database Name	The Database Name parameter is not required. This is necessary if multiple databases are running off the same Database Service.
Host Address	This will be either the database server’s IP address, hostname, or FQDN (Fully Qualified Domain Name).
Db Port	This is the port on the database server that the Database Service is using for communication.

When all items are entered, click Save. Use the Test Connection button to verify that the Web application can communicate with the Database Service. This function will prompt for the Admin password – ‘progeny’.

Note: This password may have been changed by your organization.

 

The Progeny Web Server should now be fully operational – Congratulations!