Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

setupDatabase properties and arguments

Updated on April 5, 2022

The properties in the 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

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 [email protected]. 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. The full path and file name to the IBM Db2 for z/OS file.

For information about the upgrade properties see your Upgrade Guide.

  • Previous topic Populating properties by using a direct connection to the database
  • Next topic Example column populator configurations

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us