Configure Microsoft SQL Server

To configure SQL Server for your Web Help Desk deployment, use the SQL Server Configuration Manager to enable TCP/IP on SQL Server. When completed, use SQL Server Management Studio for SQL Server to create and configure SQL Server to the Web Help Desk database instance.

Enable TCP/IP on SQL Server

Configure the following settings in the SQL Server Configuration Manager.

Setting Value
TCP/IP Protocol Enabled in SQL Server Network Configuration > Protocols for SQL 20xx
IP Address

127.0.0.1 (if installed on the Web Help Desk server)

Server IP address (if installed on a separate server)

TCP Port 1433
IPAll
TCP Dynamic Ports Blank
TCP Port 1433

Create and configure your SQL Server database

Configure the following settings in the SQL Server Management Studio for SQL Server to create and configure SQL Server to the Web Help Desk database instance.

Setting Value
SQL Server and Windows
Authentication Mode
Enabled
Login Name whd
SQL Server Authentication:
Password
Enabled and configured
SQL Server Authentication: 
Enforce password policy
Disabled
SQL Server Authentication: 
Enforce password expiration
Disabled
SQL Server Authentication: 
User must change password
at next login
Disabled
Database name whd
Database owner whd

(Optional) Enable SSL encryption

Perform the following steps to set up SSL encryption for a supported Microsoft SQL Server database connected to Web Help Desk.

Set up the SSL connection

  1. Follow the steps in Encrypting Connections to SQL Server on the Microsoft Docs website to set up the SSL connection on the SQL Server database.

    When the ForceEncryption option for the database engine is set to Yes, all client/server communication is encrypted. This option denies access to clients that cannot support encryption.

  2. Start the database server with SSL enabled.

Enable SSL encryption for a new Web Help Desk installation

If you are upgrading Web Help Desk or installing the software for the first time, perform the following steps:

  1. Download and run the Web Help Desk installer.
  2. Follow the steps in the Getting Started Wizard.
  3. In the Select your Web Help Desk database window, add the database information.
  4. Select Use custom SQL Server database (advanced).
  5. In the Database Name field, enter:

    whd?ssl=true

  6. Complete the wizard.

    SSL is enabled.

Enable SSL encryption for an existing Web Help Desk installation

If you are configuring SSL encryption for an existing WHD installation, perform the following steps:

  1. Stop Web Help Desk.
  2. Navigate to the extensions directory based on your operating system.

    Microsoft Windows: \Program Files\WebHelpDesk\bin\jre\lib\ext

    macOS: /Library/Java/Extensions

    Linux: /usr/local/webhelpdesk/bin/jre/lib/ext

  3. Open the conf directory.
  4. Open the .whd.properties file in a text editor.
  5. Edit the following properties:
    • whd.db.port=1433
    • whd.db.sid=
    • whd.db.customUrl=
    • whd.db.subprotocol=microsoft
    • whd.db.password={DES}B/cdbZvGZws\=
    • whd.db.host=<server_name>
    • whd.db.useCustomUrl=NO
    • whd.db.name=whd:encrypt=true #
    • whd.db.username=whd
    • whd.db.embedded=NO
  6. Open the Web Help Desk home directory.

    • macOS: /Library/WebHelpDesk
    • Microsoft Windows: \Program Files\WebHelpDesk
    • Red Hat/CentOS/Fedora Linux: /usr/local/webhelpdesk
  7. Locate the Portecle application at:

    <WebHelpDesk>/bin/Portecle.jar

  8. Using Portecle, import the certificates to the following location:

    <WebHelpDesk>/bin/jre/lib/security/cacerts/<webhelpdesk_home>

  9. Start Web Help Desk.

If you are unable to connect to the SQL Server database, ensure that:

  • The appropriate certificate was imported into the cacerts directory.
  • The path to the Web Help Desk home directory is correct.

If you still cannot connect to the SQL Server database, collect the log files and contact Technical Support.