Configuring Database Settings using Management Console for TopTeam Application Server

Overview

Setting up the database connectivity is an important and mandatory step in configuring TopTeam Application Server.
TopTeam Application Server’s Windows Service will not start if TopTeam Application Server is not able to connect to the database due to either incorrect database connection settings or as the database server is down.

This article describes the procedure for configuring the database connection using Management Console for TopTeam Application Server.

Who should read this?

  • TopTeam Administrators
  • Database Administrators
  • IT Support

Preparations

1. Ensure that the corresponding TopTeam Database is installed on the database server that you are using.

2. Ensure that you have the required client library and connection string setup on the TopTeam Application Server’s computer for connecting to TopTeam Database.

  • For TopTeam Application Server for Oracle, ensure that the required Oracle client library is installed on the computer. Also ensure that you have the required TopTeam DB User’s Username, Password and Host String for connecting to Oracle Database Server.
  • For TopTeam Application Server for SQL Server, ensure that the required SQL Server client library is installed. Also ensure that you have the required Username, Password and the Database Server Name for connecting to SQL Server.
  • For TopTeam Application Server for Firebird, ensure that the Firebird client library is installed. Also ensure that you have the required Username, Password and the Database File Path for connecting to Firebird Database Server. NOTE: TopTeam Application Server for Firebird Database has been retired.

Consult your database administrator for the above information.
For detailed information, refer to the article Database Requirements for TopTeam Repository.

3. Ensure TopTeam Application Server is installed as a Windows Service.
To ensure that TopTeam Application Server is installed as a Windows Service, refer to the article Determining whether TopTeam Application Server is installed as a Windows Application or as Windows Service.
To install TopTeam Application Server as a Windows Service, refer to the article Installing TopTeam Application Server as a Windows Service.

Prerequisites

1. Start the database server, if not already started.
2. Login to the Windows Operating System as a Windows Administrator. Windows Administrator privileges are required for starting and stopping the TopTeam Application Server service.

Step 1. Stop TopTeam Application Server Service

Step 2. Navigate to the “Database Settings” tab

wpid19716-media_1282137893811.png

Step 3. Specify Database Connection Settings for User DB Schema

wpid19717-media_1282197819791.png

Specify settings for connecting to TopTeam User Database Schema.

Database connection settings for Firebird, Oracle and SQL Server databases differ from each other.
Refer to one of these steps below based on the database server you are using.

If TopTeam Application Server is running on the same computer, Management Console will automatically pick up the database settings.

SQL Server Database Connection Settings

wpid19719-media_1282198410349.png

1. Specify Database Connection Settings:

  • Specify whether or not you want to use SQL Server’s Native Authentication or Windows Authentication for connecting to a database. NOTE: We recommend that you use Native Authentication.
  • Specify the Database Username and Password. NOTE: This is not required if you are using Windows Authentication.
  • Specify the name of the TopTeam User Database.
  • Specify the SQL Server Instance to use. Click Populate SQL Servers to load all the SQL Server instances available on your local network. If you are not finding the required SQL Server instance, you can directly enter the name of the SQL Server instance.

2. Click Test for verifying the connectivity to the database using the Connection Settings specified.

If the database connection test fails, re-verify the Database Connection Settings.
Verify that you are able to connect to TopTeam Database using the same Database Connection Settings from this computer, through SQL Management Studio.

Oracle Database Connection Settings

wpid19715-media_1282199031974.png

1. Specify Database Connection Settings:

  • Specify TopTeam Schema user’s Username and Password.
  • Choose the Oracle Database Host String from the drop-down list. If the database drop-down list does not contain the database name that you are looking for, you can directly enter the name of the database you want to connect to.

Consult your Database Administrator to obtain the above information.

2. Click Test to verify the connectivity to the database using the Connection Settings specified.

  • If the database connection test fails, re-verify the Database Connection Settings.
  • Verify that you are able to connect to TopTeam Database Schema using the same Database Connection Settings from this computer, through other Oracle utilities like SQL* Plus.

Firebird Database Connection Settings

wpid19718-media_1282202408233.png

NOTE: TopTeam Application Server for Firebird Database has been retired.

1. Specify Database Connection Settings:

  • Specify the database Username and Password. By default, the Firebird engine shipped with the TopTeam Application Server installer has Username as sysdba and Password as masterkey. For more information, refer to the article Installing TopTeam Application Server for Firebird Database.
  • Choose TopTeam User Database from the drop-down list. If the database is not available on the list, you will need to define it. Click Define to define the database connections.

2. Click Test to verify the connectivity to the database using the Connection Settings specified. If the database connection test fails, re-verify the Database Connection Settings.

Step 4. Apply the Database Settings and start the Server Service

wpid19720-media_1282203414483.png

Step 4. Verify the running status of TopTeam Application Server’s Windows Service

TopTeam Application Server’s Windows Service will automatically shutdown if it is not connected to TopTeam Database.

Check whether or not TopTeam Application Server is running to ensure that Windows Service is able to connect to the database. For more information, refer to the article Determining the running status of TopTeam Application Server and its Utility Services when Application Server is installed as Windows Service.

Revised: March 16th, 2020