Take the following steps to brand the driver using the GUI installer.
Note: For the Autonomous REST Connector: The branding described in this section requires the driver to be unlocked by the application. If the end users' application cannot be modified to pass the password, such as the case with a third-party application or BI tool, you may brand the driver by locking the API. See "Locking the Autonomous REST Connector to an API" for details.
Note: The MongoDB driver is used as an example in this topic. However, these instructions apply to all drivers listed in the introduction.
  1. Run the installer from the temporary installer directory.
    Important: The installer directory must include the supporting installation zip files.
    Important: If running the Java installer on Windows, you must either select a non-system directory as the installation directory or turn off User Account Controls.
    • Java installer: PROGRESS_DATADIRECT_JDBC_INSTALL.jar
    • Windows installer: PROGRESS_DATADIRECT_JDBC_INSTALL.exe
  2. The Introduction window appears. Click Next.
  3. The License Agreement window appears. Make sure that you read and understand the license agreement. To continue with the installation, select the I accept the terms in the License Agreement option; then, click Next.
  4. The Install Directory window appears. In the Where Would You Like to Install? field, type the path, including the drive letter, of the product installation directory or click the Choose button to browse to and select an installation directory. Verify the installation directory. Click Next to continue.
  5. Select the OEM or Licensed Installation option. Then, click Next to enter your product licensing information.
  6. Type the IPE key (or Control Number) in the IPE Key field, and click the Validate button. The drivers that you purchased appear in the Drivers box. Select the drivers you want to install, and then click Next.
    • If you are installing a 5.1 version of the product, skip to Step 9.
    • If you are installing a 6.0 version of the product, proceed to the next step.
  7. The OEM Installation Type window appears.
    • Select Branded Installation to specify a branded installation, and proceed to Step 9.
    • Select Unbranded Installation to specify an unbranded installation, and proceed to the next step.
  8. Enter the information in the fields provided.
    1. Type your name and company name into the corresponding fields.
    2. Type the serial number that was provided by Progress DataDirect.
    3. Verify that the I want to participate box is selected to allow the installer program to gather data for the Installer Customer Experience Improvement Program. Information collected for the program is used to improve our products by identifying trends or issues that impact the user experience. For details, refer to the Progress Privacy Policy.
    4. Click Next and skip to Step 10.
  9. Enter your product branding information as described in the following section.

    product branding window

    Provide the following information:

    Serial Number: Type the Serial Number provided by Progress DataDirect.

    User Name: Type your name.

    Company Name: Type the name of the company that has purchased the OEM license.

    File Prefix: Type the file prefix (maximum of 2 characters) you registered on the Progress DataDirect OEM Partner website. This prefix is added to DataDirect file names. For example, if dx is your file prefix for the MongoDB driver, the mongodb.jar becomes dxmongodb.jar.
    Note: The value dd is a reserved file prefix. Specifying this value returns an error.

    Package Prefix: Type a package prefix for the branded driver (maximum of 64 characters). To avoid package name conflicts, the package prefix should adhere to the package naming conventions defined in the Java Language Specification. The package prefix replaces the DataDirect prefix of com.ddtek in all the classes within the driver jar file when you brand a driver. For example, if com.xyzcompany.xyzdivision is your package prefix for a MongoDB driver, the MongoDB driver class:

    com.ddtek.jdbc.mongodb.MongoDBDriver

    becomes

    com.xyzcompany.xyzdivision.jdbc.mongodb.MongoDBDriver
    Note: The value com.ddtek is a reserved package prefix. Specifying com.ddtek as part of this value returns an error.

    Subprotocol Prefix: Progress DataDirect drivers are registered with a URL subprotocol of the form datadirect:drivername, for example, datadirect:mongodb. To replace datadirect in the subprotocol of a branded driver with your company name, type a prefix (maximum of 32 characters) in this field. For example, if xyzcompany is your subprotocol prefix for a MongoDB driver, the URL:

    jdbc:datadirect:mongodb://server1:27017

    becomes:

    jdbc:xyzcompany:mongodb://server1:27017
    Note: Contact Oracle to register JDBC subprotocol names.
    Note: The subprotocol cannot start with Progress DataDirect or contain datadirect. Specifying either of these reserved values returns an error.

    Message Prefix: Type a message prefix for the branded drivers (maximum of 32 characters). After branding, driver error messages are displayed with this prefix. For example, if xyzcompany is your message prefix for a MongoDB driver, the driver error message:

    [DataDirect][MongoDB JDBC Driver] Object has been closed

    becomes:

    [xyzcompany][MongoDB JDBC Driver] Object has been closed
    Note: The message prefix cannot start with Progress DataDirect or contain datadirect. Specifying either of these reserved values returns an error.

    Password: Type the password you registered on the Progress DataDirect OEM Partner website (maximum of 128 characters). The password is case-sensitive. This password is locked into the branded drivers to prevent unauthorized applications from using the branded drivers.

  10. The Pre-Installation Summary window appears. Review the installation information. Click Previous to revise selections; or click Install to begin the installation.
  11. When the installation finishes, the Install Complete window appears. Click Done to exit the installer program.

Refer to the installation log file for a record of any problems that may have occurred during the installation. See Installation Log File for details.