The Hybrid Data Pipeline server must be installed before the On-Premises Connector can be installed.

During installation of the Hybrid Data Pipeline server, four configuration and certificate files are generated. For a non-Docker, non-load balancer deployment, these files are written to the Hybrid Data Pipeline installation directory <install_dir>/redist. For load balancer and Docker deployments, these files are written to the redist directory of the shared file location. These files must be copied to the directory from which the On-Premises Connector installation program will be run. The files are:

  • config.properties
  • OnPremise.properties
  • ddcloud.pem
  • ddcloudTrustStore.jks

Note:

  • The On-Premises Connector uses an embedded JRE at runtime. However, you can integrate an external JRE during the installation or upgrade of the connector. See also JRE support and integration.
  • By default, the installation program installs the On-Premises Connector in the Program Files system directory. If you are installing the On-Premises Connector in a system directory other than the Program Files directory, you must turn off User Account Controls to run the installation program.

Take the following steps to proceed with an installation of the Hybrid Data Pipeline On-Premises Connector.

  1. Download the On-Premises Connector installation program to a temporary directory on the Windows machine on which you want to install it.
  2. Copy the four configuration and certificate files generated during the installation of the Hybrid Data Pipeline server into the same directory from which you will run the On-Premises Connector installation program.
  3. Run the installation program.
  4. The Introduction window appears. Click Next to continue.

    If an existing installation is detected, you will be prompted to choose whether to install a new instance or upgrade an existing instance.

    • If you are installing a new instance of the connector, proceed to Step 5.
    • If you are upgrading an instance of the connector, proceed to Step 6.
  5. In the Where Would You Like to Install? field, specify the installation directory. Then click Next and skip to Step 7.
  6. Take the following steps to upgrade a current installation. Then, proceed to Step 12.
    1. From the drop down menu, select the installation that you want to upgrade. Then, click Next.
    2. Select the desired Java configuration.
      Note: Further steps may be required to integrate an external JRE. See JRE support and integration for details.
      • Select Use default Java if you will be using the embedded JRE installed with the server.
      • Select Java home directory and provide the path to an external JRE if you will be using a JRE not installed with the server.
    3. Select whether you will be using a MySQL Community Edition data store.
      • If you are not using a MySQL Community Edition data store, click Next and proceed to Step 12.
      • If you are using a MySQL Community Edition data store, provide the name and location of the MySQL Community Edition driver jar file. Then, click Next and proceed to Step 12.
    Note: You will not be prompted to enter Microsoft CRM or proxy connection settings when performing an upgrade. If these settings need to be changed, you should change them with the On-Premises Configuration Tool.
  7. Select the desired Java configuration.
    Note: Further steps may be required to integrate an external JRE. See JRE support and integration for details.
    • Select Use default Java if you will be using the embedded JRE installed with the server.
    • Select Java home directory and provide the path to an external JRE if you will be using a JRE not installed with the server.
  8. Select the type of installation.
    • If your installation does not need modification, select Standard and continue at Step 11.
    • If you need to customize the installation, select Advanced Installation, and then select either or both of the following options.
      • The On-Premises Connector must communicate with the Hybrid Data Pipeline service using the Internet. If your network environment requires a proxy to access the public Internet, select Proxy Connection and continue at Step 9.
      • If you need to enable support for MySQL Community Edition, select MySQL Community Edition. Continue at Step 10.
  9. Provide your proxy connection information and the type of proxy authentication you want to use. (You can change this information later using the Hybrid Data Pipeline On-Premises Connector Configuration Tool.)
    1. Type the proxy connection information.

      Hostname specifies the Host name and, optionally, the domain of the proxy server. The value can be a host name, a fully qualified domain name, or an IPv4 or IPv6 address.

      Port Number specifies port number where the proxy server is listening.

      User Name specifies the user name needed to connect to the proxy server if you are using HTTP Basic or NTLM authentication. If NTLM Proxy Authentication is selected, the user name must be in the form Domain\User.

      Password specifies the password needed to connect to the proxy server if you are using HTTP Basic or NTLM authentication.

    2. From the Proxy Authentication drop-down list, select the type of proxy authentication needed in your environment.
      • Select No Proxy Authentication if your proxy server does not require authentication.
      • Select HTTP Proxy Authentication if the proxy server requires that all requests be authenticated using the HTTP Basic authentication protocol.
      • Select NTML Proxy Authentication if the proxy server requires that all requests be authenticated using the NTLM authentication protocol.
    3. Proceed to the next appropriate step.
      • If you plan to connect to a MySQL Community Edition data store, click Next and continue at Step 10.
      • If you do not plan to connect to a MySQL Community Edition data store, click Next and continue at Step 11.
  10. In the jar path field, provide the name and location of the MySQL Community Edition driver jar file. Then, click Next.
  11. Provide the user ID and password for your Hybrid Data Pipeline account. If desired, you can change the default connector label. Click Next.
    The installation program validates your Hybrid Data Pipeline account credentials.
  12. Review the Pre-Installation Summary window. To install the connector, click Install.
  13. Click Done to exit the installation program.
  14. After the installation program closes, the On-Premises Connector Configuration Tool opens and verifies access to the Hybrid Data Pipeline service.
    • Close the Configuration Tool to complete the installation process.
    • Use the Configuration Tool to further configure the On-Premises Connector. For details, see Configuring the On-Premises Connector