Branded Installation Response File Template
- Last Updated: July 11, 2023
- 3 minute read
Use the following template to create a response file for a branded installation.
Note: The MongoDB driver is used as an example in this topic. However, these
instructions apply to all drivers listed in the introduction.
#EULA
#----
ACCEPT_LICENSE_AGREEMENT=true
#Choose Install Folder
#---------------------
USER_INSTALL_DIR=install_dir
#Install Type
#------------
INSTALL_TYPE_OEM=true
#Product Branding
#----------------
LICENSED=1
COMPANYNAME=company
USERNAME=user
OEM=true
SERIALNUMBER=xxxxxxx
KEYLIST=yyyyyyy
PREFIX=aa
PACKAGEPREFIX=bb
SUBPROTOCOLPREFIX=cc
MESSAGEPREFIX=dd
PASSWORD=ee
where:
ACCEPT_LICENSE_AGREEMENT=true- indicates that the license agreement has been accepted
install_dir- specifies your product installation directory.Note: If coding a path on Windows to an installation directory using the Universal Naming Convention (UNC), you must escape the double backslash (\\) and the single backslash with a Java escape character. For example:
\\\\server1\\Progress\\DataDirect\\JDBC. INSTALL_TYPE_OEM=true- indicates you are performing an OEM branded installation.
1- indicates you are installing a licensed copy of the driver(s).
company- specifies your company name.
user- specifies your user name.
OEM=true- indicates an OEM branded installation.
- xxxxxxx
- is your product serial number.
yyyyyyy- is your IPE key (or Control Number). If specifying multiple keys, separate
them using a space, for example,
KEYLIST=3333333 5555555 7777777. - aa
- is 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
dxis your file prefix for the MongoDB driver,mongodb.jarbecomesdxmongodb.jar.Note: The valueddis a reserved file prefix. Specifying this value returns an error. - bb
- is the 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.ddtekin all the classes within the driver jar file when you brand a driver. For example, ifcom.xyzcompany.xyzdivisionis your package prefix for the MongoDB driver, the MongoDB driver class:com.ddtek.jdbc.mongodb.MongoDBDriverbecomes:
com.xyzcompany.xyzdivision.jdbc.mongodb.MongoDBDriverNote: The valuecom.ddtekis a reserved package prefix. Specifyingcom.ddtekas part of this value returns an error.
- cc
- is the vendor subprotocol prefix. Progress DataDirect drivers are
registered with a URL subprotocol of the form
datadirect:drivername, for example,datadirect:mongodb. To replacedatadirectin the subprotocol of a branded driver with your company name, type a prefix (maximum of 32 characters) in this field. For example, ifxyzcompanyis your subprotocol prefix for the MongoDB driver, the URL:jdbc:datadirect:mongodb://server1:27017becomes:
jdbc:xyzcompany:mongodb://server1:27017
- dd
- is the message prefix for the branded drivers (maximum of 32 characters).
After branding, driver error messages are displayed with this prefix. For
example, if
xyzcompanyis your message prefix for the MongoDB driver, the driver error message:[DataDirect][MongoDB JDBC Driver] Object has been closedbecomes:
[xyzcompany][MongoDB JDBC Driver] Object has been closedNote: The message prefix cannot start withProgress DataDirector containdatadirect. Specifying either of these reserved values returns an error.
- ee
- is the password (maximum of 128 characters) you registered on the Progress DataDirect OEM Partner website. The password is case-sensitive. This password is locked into the branded drivers to prevent unauthorized applications from using the branded drivers.
See Performing the Silent Installation for instructions on running the response file.