skip to main content
Installing and upgrading the Hybrid Data Pipeline server : Installing the Hybrid Data Pipeline server : GUI mode installation : Standalone installation (GUI mode)
  

Try Now
Standalone installation (GUI mode)
1. Depending on your environment, provide the appropriate SSL certificate information.
*Select Certificate file to specify a PEM file to be used by the server to establish SSL connections with ODBC and JDBC client applications. Type the full path to the PEM file, or click Choose... to browse to the location of the PEM file. Then, click Next.
Note: The PEM file must consist of a private key, a public key certificate issued by a certificate authority (CA), and additional certificates that make up the trust chain. See The PEM file for more information.
*Select Use existing Certificate to use the self-signed certificate included with the installation. Then, click Next.
Note: The self-signed certificate may be used in a test environment. However, for production, a PEM file with required information should be specified. See The PEM file for more information.
2. Select MySQL Community Edition if you plan to use MySQL Community Edition as an external system database or as a data source. Hybrid Data Pipeline does not provide a driver for MySQL Community Edition. However, you can use the MySQL Connector/J driver to use MySQL Community Edition as an external system database or as a data source. If you select MySQL Community Edition, enter the name and location of the MySQL Connector/J jar file in the Jar Path field. Then, click Next to continue.
For more information on the MySQL Connector/J driver, refer to the MySQL developer website at https://dev.mysql.com/.
3. Select the type of database you want to use to store system information.
*Select Internal Database (supplied by this install) to use the default internal database. Click Next to continue. Proceed to the next step.
*Select External Database to store the system information in an external database. Then, from the drop down box, choose your database vendor. Then, click Next.
*Select Oracle, and continue at Step 5.
*Select MySQLCommunity, and continue at Step 6.
*Select MSSQLServer, and continue at Step 7.
*Select PostgreSQL, and continue at Step 8.
Note: Users and data sources created in the internal database are specific to the internal database. They are not migrated to the external database if you subsequently modify the Hybrid Data Pipeline server to use an external database.
4. Enter the database port for the internal database. If your environment has already defined a function for the default port, the installer pops up a message so that you can specify a different port. Click Next, and continue at Step 10.
5. Provide the Oracle connection information.
a. Type the name of the host.
b. Type the port number.
c. Select the connection type. Do one of the following:
*If you connect using the Oracle System Identifier (SID), select Connect using SID, then type the SID.
*Select Connect using Service Name, then type the database service name that specifies the database that is used for the connection. The service name is a string that is the global database name. The global database name typically comprises the database name and domain name.
d. Optionally, in the Advanced Options field, specify additional connection parameters and their values to be included in the connection URL. Values should be entered as a semicolon-separated list of parameter=value. For example, you may enter to following options to configure SSL:
encryptionLevel=Required;encryptionTypes=(AES256);
dataIntegrityLevel=Required;dataIntegrityTypes=(SHA1);
encryptionMethod=SSL;keyStore=/common/Oracle/trustStore.jks;
keyStorePassword=secret;serverType=dedicated;authenticationMethod=ntlm;
hostNameInCertificate=oracle;editionName=hybrid
e. Click Next, and continue at Step 9.
6. Provide connection information for the MySQL Community Edition external database.
a. Type the name of the host.
b. Type the port number.
c. Type the database name.
d. Optionally, in the Advanced Options field, specify additional connection parameters and their values to be included the connection url. Values should be entered as an ampersand-separated list of parameter=value.
e. Click Next, and continue at Step 9.
7. Provide the SQL Server connection information.
a. Type the name of the host.
b. Type the port number.
c. Type the database name.
d. Type the name of the schema.
e. Optionally, in the Advanced Options field, specify additional connection parameters and their values to be included in the connection URL. Values should be entered as a semicolon-separated list of parameter=value.
f. Click Next, and continue at Step 9.
8. Provide the PostgreSQL connection information.
a. Type the name of the host.
b. Type the port number.
c. Type the database name.
d. Optionally, in the Advanced Options field, specify additional connection parameters and their values to be included in the connection URL. Values should be entered as a semicolon-separated list of parameter=value.
e. Click NextAdministrator credentials are only required at install, and continue at Step 9.
9. Provide the external database credential information.
Note: Administrator credentials are only required at install time to create the database schema. Administrator credentials are not used by the product at run time.
Note: If the installer is unable to validate, you are prompted to reenter credentials or skip validation. Skipping validation is often desired when performing a silent installation. See Silent installation process for details.
*In the Admin Username field, type the administrator user name. The administrator user must have certain privileges that are specific to the database vendor. For a list of required privileges, see External system databases.
*In the Admin Password field, type the password for an database administrator account.
*In the Username field, type a user name. The standard user must have certain privileges that are specific to the database vendor. For a list of required privileges, see External system databases.
*In the Password field, type the user password.
10. Review the Server Access Ports. A Server Access Port must be available to the end user across the firewall. Best security practices recommend using an HTTPS port.
Note: In most cases, the default ports work without problems. However, your environment might have already defined a function for one or more of the ports. If a default port is in use, the installer pops up a message so that you can make the necessary changes.
Access ports showing default values. If your environment has already defined one of these ports, a message window is displayed when you click Next.
Table 1. Server Access Ports
Name
Default
Description
HTTP Port
8080
Port that exposes Hybrid Data Pipeline
HTTPS Port
8443
SSL port that exposes Hybrid Data Pipeline
11. Select whether you are using the On-Premises Connector.
*If using the On-Premises Connector, select Enable On-Premises Connector. Click Next and continue to the next step.
*If not using the On-Premises Connector, leave the check box empty and click Next. Continue at Step 13.
12. Review the On-Premises Access Ports. The On-Premises Access Port and a Notification Server Port must be available across the firewall. Best security practices recommend using the SSL Notification Server Port.
Note: In most cases, the default ports work without problems. However, your environment might have already defined a function for one or more of the ports. If a default port is in use, the installer pops up a message so that you can make the necessary changes.
On-premises access ports with default values. If your environment has already defined one of these ports, a message window is displayed when you click Next.
Table 2. On-Premises Access Ports
Name
Default
Description
On-Premises Port
40501
Port for the On-Premises Connector
TCP Port
11280
Port for the Notification Server
SSL Port
11443
SSL port for the Notification Server
Message Queue Port
8282
Port for the message queue
13. Review the Server Internal Ports. A port for the internal API and the Shutdown Port must be opened. Best security practices recommend using the Internal API SSL Port.
Important: As a matter of best practice, the Shutdown Port should not be available outside the firewall of the Hybrid Data Pipeline instance.
Note: In most cases, the default ports work without problems. However, your environment might have already defined a function for one or more of the ports. If a default port is in use, the installer pops up a message so that you can make the necessary changes.
Server ports showing the default values. If your environment has already defined one of these ports, a message window is displayed when you click Next.
Table 3. Server Internal Ports
Name
Default
Description
Internal API Port
8190
Non-SSL port for the Internal API
Internal API SSL Port
8090
SSL port for the Internal API
Shutdown Port
8005
Shutdown port
14. Review the installation summary. If you are satisfied with your choices, click ENTER to install.
15. After the installation has finished, press ENTER to exit the installer.
16. Verify the installation by accessing the Hybrid Data Pipeline user interface from a browser. The login page should appear. For example:
https://<myserver>:8443/
where <myserver> is the fully qualified hostname of the machine where you installed Hybrid Data Pipeline.
After logging in, administrators can verify product version information by selecting About from the question mark drop-down menu. For more information on retrieving version information, refer to "Get Version Information" in the Progress DataDirect Hybrid Data Pipeline User's Guide.
Refer to installation log files for a record of any problems that may have occurred during the installation. See Server installation log files for details.
What to do next
During installation, the installer generates four configuration and certificate files. These files are located in the Hybrid Data Pipeline installation directory <install_dir>/redist. Before installing a component such as the ODBC driver, the JDBC driver, or the On-Premises Connector, these files must be copied to the installer directory of the component you are installing.
The four configuration and certificate files are:
*config.properties
*OnPremise.properties
*ddcloud.pem
*ddcloudTrustStore.jks