Skip to main content

setupDatabase properties and arguments

Suggest edit Updated on November 30, 2021

The properties in the setupDatabase.properties file configure the behavior of several command-line scripts:

  • Deployment scripts
  • Schema migration scripts
  • DDL-generation scripts
  • User-defined function scripts

Many of these property settings can be overridden by command-line arguments at run time. The following tables include the property name and, when applicable, the associated script argument.

Database connection properties

Script argumentPropertyDescription
--driverJARpega.jdbc.driver.jar

Path and file name of the JDBC driver.

IBM Db2 for z/OS requires the following JAR files: db2jcc4.jar and db2jcc_license_cisuz.jar

--driverClasspega.jdbc.driver.classClass of the JDBC driver
--dbTypepega.database.typeDatabase vendor type. Enter one of the following values:

IBM Db2 for Linux, UNIX, and Windows: udb

Microsoft SQL Server: mssql

Oracle: oracledate

PostgreSQL: postgres

IBM Db2 for z/OS: db2zos

--dbURLpega.jdbc.urlThe database JDBC URL.

For more information, see your deployment guide.

--dbUserpega.jdbc.usernameUser name of the Deployment user.
--dbPasswordpega.jdbc.passwordPassword of the Deployment user. For encrypted passwords, leave this blank.
--adminPassword pega.admin.passwordFor new installations only. The initial password for administrator@pega.com. If you do not set this password before you install, the installation fails.
--connPropertiesjdbc.custom.connection.propertiesOptional: Semicolon-delimited list of custom JDBC properties for installations.

(for example: prop1=value;prop2=value;prop3=value)

--rulesSchemarules.schema.nameIn a single schema environment, sets rules schema and data schema.

In a split-schema configuration, sets the rules schema only.

--dataSchemadata.schema.nameFor split-schema configurations only, sets the data schema name.
--customerDataSchemacustomerdata.schema.nameAn optional customer data schema separate from the default Pega data schema.
--tempDiruser.temp.dirOptional: The location of the temp directory. Set this location to any accessible location.

For example, C:\TEMP.

pega.zos.properties The full path and file name to the IBM Db2 for z/OS DB2SiteSpecific.properties file.

For information about the upgrade properties see your Upgrade Guide.

Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us