This section describes the steps your installer must take for the driver to support running the SQL engine server in server mode.
Important: Your installer does not need to perform these steps if the SQL engine server for your driver will run in only broker mode or direct mode.

To install the SQL engine server, your installer must perform the following steps:

  1. Execute the following command:

    sql_engine_filename.exe /install

    For example, for the 32-bit MongoDB driver, execute the following command:

    mongodbserver32.exe /install

  2. Write the following default values to the 32-bit Windows Registry:
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Progress Software
Corporation\messagePrefix\datasource\Services\datasource SQL Engine version bitness
"Args"=""
"DatabaseRepositoryPath"="dir_for_temp_application_data"
"JavaPath"=path_to_java.exe
"JVMArgs"="-Xmx256m"
"JVMClasspath"="path_to_driver.jar"
"JVMPort"="port"
"ProxyHost"=""
"ProxyPassword"=""
"ProxyPort"=""
"ProxyUser"=""

    where:

    messagePrefix
    is the message prefix you specified when branding the drivers.
    datasource
    is the name of the data source. For example, MongoDB.
    version
    is the major and minor version of your driver. For example, 08.01.
    bitness
    is the bitness of your driver. For example, 32.
    path_to_driver.jar
    is the fully qualified path to the driver's jar file. For example, c:\install_dir\java\lib\mongodb.jar.
    path_to_java.exe
    is the fully qualified path to a supported JVM executable.

    For the latest support information, visit the DataDirect Product Compatibility Guide.

    dir_for_temp_application_data
    is the fully qualified path to the database repository directory. For example, C:\Users\smith\AppData or C:\Documents and Settings\smith\Application Data.
    port
    is the port number used by the JVM to listen for application requests. Do not use the following port numbers when installing the respective drivers; they are reserved.
    • Aha!
      • 19950 (32-bit)
      • 19949 (64-bit)
    • Apache Cassandra
      • 19934 (32-bit)
      • 19933 (64-bit)
    • Autonomous REST Connector
      • 19942 (32-bit)
      • 19941 (64-bit)
    • GitHub
      • 19956 (32-bit)
      • 19955 (64-bit)
    • Google Analytics 4
      • 19972 (32-bit)
      • 19971 (64-bit)
    • Google BigQuery
      • 19946 (32-bit)
      • 19945 (64-bit)
    • HubSpot
      • 19962 (32-bit)
      • 19961 (64-bit)
    • Microsoft Dynamics 365
      • 19952 (32-bit)
      • 19951 (64-bit)
    • Microsoft SharePoint
      • 19964 (32-bit)
      • 19963 (64-bit)
    • MongoDB
      • 19968 (32-bit)
      • 19967 (64-bit)
    • Oracle Service Cloud
      • 19929 (32 and 64-bit)
    • Salesforce
      • 19938 (32-bit)
      • 19937 (64-bit)
    • SAP S/4HANA
      • 19954 (32-bit)
      • 19953 (64-bit)
    • Snowflake
      • 19948 (32-bit)
      • 19947 (64-bit)
    • TeamCity
      • 19958 (32-bit)
      • 19957 (64-bit)
  3. For drivers that use the Configuration Manager, install the service.properties file into the install_dir\install. The file must contain an entry that specifies the service using the following syntax:

    driver.service.name=service_name

    For example, an entry for the 64-bit version of the 8.0 MongoDB driver would take the following form:

    mongodb.service.name=Progress DataDirect MongoDB SQL Engine 08.01 32

    Note that installer program places a copy of the service.properties file with entries in the install_dir\install directory during the installation and branding processes.
    Note: The following drivers currently use both the Configuration Manager and SQL engine server: Aha!, Autonomous REST Connector, GitHub, Google Analytics 4, HubSpot, MongoDB, Microsoft Dynamics 365, Microsoft SharePoint, SAP S/4HANA, and TeamCity.
  4. Verify that the default directory specified for the DatabaseRepositoryPath here exists.