You can install FairCom from a Windows Installer file (.msi) or from a compressed file (.zip). Using the Windows installer automatically starts FairCom as a Windows service.
This installation process takes approximately five minutes, depending on the download speed of your Internet connection.
Microsoft Windows supports background processes known as services. Services may be configured to start automatically at system startup or to be started manually by a user. They have no user interface and can continue to run even when no users are logged on to the system. Windows automatically terminates services at system shutdown, or a user can manually terminate them.
Install using the Windows Installer
- Download the FairCom server as a .msi file.
- Run the downloaded .msi file.
- When the Setup window appears, click Next.
- After reading the license agreement select I accept the terms in the License Agreement and click Next.
- In the Select Installation Folder window, select the installation location and click Next.
- The software can be installed in any folder with at least 600 MB of disk space. The default and recommended location is the C: drive in the FairCom folder.
- Click Install to install the FairCom server.
- Click Yes when Windows asks permission to install the server.
- Observe the progress of the installation in the Setup Wizard.
- Installation typically takes about one minute.
- When the installation is complete in the Setup window, select the View readme file checkbox and click Finish.
- Selecting the View readme file checkbox will cause the readme file to open in a web browser after clicking Finish.
- View the opened readme file.
Install using a zip file
- Download the FairCom server as a .zip file.
- Unzip the downloaded file into a root <faircom> folder — for example, c:\faircom\.
- FairCom recommends using 7-Zip because other zip utilities have limitations on the number of files and paths that they can unzip.
- Run <faircom>/server/faircom.exe.
Important
The evaluation version of the product times out after three hours and shuts down the server. Therefore, the server needs to be restarted every three hours.
Note
Each time you restart your computer, you need to run faircom.exe to load the server.
This is ideal for an evaluation environment where you want full control over the server.
For a production environment, consider using the Windows installer to install FairCom as a Windows service that automatically loads the FairCom server each time the computer restarts.
Access the UI browser apps
Make sure the FairCom server is installed and running before attempting to access these FairCom browser-based graphical user interface apps.
- Open FairCom's browser-based service in a Chrome-based web browser. If the FairCom server is not configured with a security certificate, the following is displayed:
Note: You must use https in the URL because FairCom products require the secure HTTPS protocol. For more information, see Enable HTTP on port 8080 and Manage certificate warnings
- If you see the warning, click the Advanced button, then click the Proceed to localhost (unsafe) link to access FairCom's browser apps. The FairCom browser apps menu will appear, so you can use the apps to manage the server.
Manage a FairCom server as a Windows service
Configure a FairCom server as a Windows Service using FairCom's setup.bat file.
Use the Windows Services Manager to start or stop a FairCom server that is configured as a Windows service.
Configure FairCom to run as a Windows service
- In Windows Explorer, navigate to the <faircom> installation folder.
- Run the setup.bat file to open the FairCom Setup window.
- The setup.bat file runs the <faircom>/tools/Setup/FairComConfig.exe file in a console window, which you will need to close later.
- Optionally, change the FairCom Installation Directory to the location of the product you want to configure.
- Select the desired checkboxes under Select features to install or configure.
- For information on features to install or uninstall, see Configure installed features using FairComConfig.exe.
- Click Configure. A Setup process completed successfully... message is displayed.
- If the configuration was unsuccessful, contact FairCom support.
- Click OK.
Run the Windows Services manager
- Open the Windows Start menu.
- Search by typing services.
- Press Enter. The Windows Services manager window opens
Use Windows Services Manager to start or stop a FairCom Windows Service
- In the Windows Services Manager, locate and double-click the FairCom service in the list of services.
- In the Service Properties window, click Start to start the service or Stop to stop it.
- Click OK or Apply.
- For more information on starting the FairCom server, see Start the FairCom server.
- If you stop the service, the FairCom server stops running, but is still registered as a Windows Service.
Specify when Windows will run a FairCom server as a service
- In the Windows Services Manager, locate and double-click the FairCom service in the list of services.
- In the General tab of the Properties window, make a selection from the Startup type: dropdown menu.
- Automatic (Delayed Start)
Windows runs the FairCom service automatically at startup with a delay. - Automatic
Windows runs the FairCom service automatically at startup. - Manual
Windows does not run the FairCom service automatically. You must manually use the Windows Services Manager to start or stop a FairCom Windows Service. - Disabled
Windows prevents the FairCom service from running.
- Automatic (Delayed Start)
- Click OK or Apply.
Remove FairCom as a Windows service
- In Windows Explorer, navigate to the FairCom installation folder.
- Run the setup.bat file to open the FairCom Server Setup window.
- Optionally, change the FairCom Installation Directory to the location of the product you want to remove.
- Click Remove. A Removal process completed successfully... message displays.
- If removal was unsuccessful, contact FairCom support.
- Click OK.
- FairCom is still installed on your system. To uninstall, see Uninstall the server.
Uninstall the FairCom server
If you have installed the FairCom server using the Microsoft Installer, you can uninstall it using the Windows built-in Uninstaller.
Note: To uninstall a FairCom product that you copied from a zip file, simply delete the folder that contains the version of the FairCom product.
- Open the Windows Start menu.
- Search Add or remove programs.
- Under Apps & features, in the textbox, search for faircom.
- Click Uninstall for the FairCom app.
Note: The uninstaller removes the server but leaves the data files you created. If you no longer need the data, you can manually delete the contents of the FairCom folder.
Start or stop the FairCom server
Start the FairCom server as a Windows service
Start the FairCom server as a service using either the Microsoft sc.exe command or the Windows Services Control Panel applet.
- Open the Control Panel.
- Select the Services applet.
- Select the name of the FairCom service from the list of installed services.
- Click Start to start the service.
Installing the FairCom server using the Windows Installer automatically makes it available to run as a Windows service. However, if you installed it by unzipping it into a folder, you will need to manually configure the FairCom server to run as a service.
Stop the FairCom Windows service
The FairCom service can be stopped by using either the Microsoft sc.exe command or the Windows Services Control Panel applet, or the net stop command.
- The service stops automatically when Windows signals the operating system itself is shutting down. A clean shutdown of Windows should result in a clean shutdown of the faircom server. However, since Windows only allows a 20 second delay for service shutdown, FairCom recommends all files be maintained under transaction processing to allow automatic recovery if cache cannot be safely flushed to prevent data corruption. The default 20-second delay can be adjusted using the
WaitToKillServiceTimeoutregistry key, found inHKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\, when present. - Windows Vista and later allow a new Service PRESHUTDOWN notification, which gives the service extra time to complete its shutdown. This can help to avoid a lengthy auto-recovery if the server has too many cache pages to flush within the SHUTDOWN limit.
See Start for information about scripting the startup and shutdown operations on Linux.
Stop a service
| Service | Command |
|---|---|
| FairCom DB | sc stop FairCom-DB |
| FairCom EDGE | sc stop FairCom-EDGE |
| FairCom MQ | sc stop FairCom-MQ |
| c-treeRTG | sc stop ctreeRTG |
Manually start the FairCom server on Windows
If the FairCom server is not configured to run as a Windows service, there are multiple ways to start and stop it and to detect if it is currently running.
- The FairCom server opens and runs the Control Window. Observe the name of your FairCom server at the top of this window.
- To start the FairCom server, double-click on the server executable in Windows Explorer: <faircom>\server\faircom.exe.
When the FairCom server is running manually (not as a service), an icon is displayed in the Windows taskbar. Double-clicking this icon brings up the FairCom console window.
- The FairCom console window provides troubleshooting information about the FairCom server.
When connecting through a network, be aware that the local firewall may block the TCP/IP port used to communicate with the FairCom server. If you cannot connect to a running instance of the FairCom server, a firewall could be blocking communication. If so, you may need to unblock the FairCom server port, which defaults to 6597. For more details, see Configure ports and services.
If you close this window, the FairCom server continues to run and the window is minimized to the taskbar.
- Open the Message Monitor window.
- Open the Function Monitor window.
Message Monitor window
The message window shows console messages.
The startup messages tell you information such as TCP/IP ports for applications to communicate with the FairCom server, license information such as the maximum allowed connections, and notice if the server is in DEMO mode, which shuts down automatically every three hours.
Function Monitor window
The function monitor (View > Function Monitor Window) is for basic troubleshooting. It displays a message each time an application calls a FairCom function.
When the Function Monitor window is open, it significantly slows down the performance of the FairCom server so it can show you each function an application calls.
Start the FairCom server from the Windows command-line
- To run the FairCom server in the console tray without displaying the Control Window, find the TOOL_TRAY keyword in the
ctsrvr.cfgfile and disable it by putting a semicolon at the beginning of the line.
;CONSOLE TOOL_TRAY - Run the FairCom server from the command line.
C:\server> faircom ^& - Observe that the FairCom server is running in the tool tray without displaying the user interface.
It is a best practice for production deployments on Windows to run the FairCom server as a Windows Service. This ensures Windows keeps it running, and it allows administrators to easily manage the service remotely.
Tool tray interface
When the server configuration file contains the CONSOLE TOOL_TRAY keyword, the FairCom server starts in the background, displaying only a FairCom DB icon in the Windows tool tray. This feature is especially nice for simple user sites, with no system administrative expert. Although more sophisticated sites will prefer running the FairCom server as a service, this feature gives a similar service-like background effect, without the user needing to learn Windows service administration.
- Navigate to and open the
ctsrvr.cfgfile. - Add the keyword
CONSOLE TOOL_TRAY.
This keyword is not supported when the server is running as a service.
Example 2. Launch the server in background-tool-tray mode
The FairCom server for Windows accepts the & symbol, or the ^& for Windows server, as a command line parameter to execute in CONSOLE TOOL_TRAY mode.
C:\server> ctreeace &
or
C:\server> ctsrvr &
Stop
If replication is running, it is advisable to stop replication before stopping the server. If replication is running, you may see error 792 (External server shutdown disabled), although replication should be able to handle an unexpected server shutdown.
- Windows service
If the FairCom server is configured to run as a service on your machine, you can stop the service using the Windows Service Administrator or by issuing thenet stop...command in a Command Prompt window. - Windows taskbar
If the FairCom server was launched manually, a FairCom icon (
) appears in your taskbar. Right-click on the icon and select the appropriate shutdown option.
This approach is normally used in demonstrations and some development environments. In production environments, the FairCom server runs as a Windows service. - FairCom console
Exit the console application via the menu or the standard Windows "X" in the corner. If the FairCom server was launched manually, the console window can be displayed by double-clicking on the tool tray icon. Use the console window’s Control menu to shut down the database engine.
This approach is normally used in demonstrations and some development environments. In production environments, the FairCom server runs as a Windows service. -
ctadmn
Thectadmncommand-line utility provides an option to shut down the server. It works both when the server is running as a service and when it’s been launched manually. This tool only runs when supplied with an administrator username and password. -
ctstop
The stop utility can be used to shut down the server from the command line or in a batch file. It can be used when the server is running as a service and when it’s been launched manually. This tool only runs when supplied with an administrator username and password.