You are here: Reference > Tools, accelerators, and wizards > setupDatabase properties and arguments

setupDatabase properties and arguments

The properties in the setupDatabase.properties file configure the behavior of several command-line 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 argument Property Description
--driverJar pega.jdbc.driver.jar
ClosedPath and file name of the JDBC driver jar file:

  • IBM DB2 for z/OS: db2jcc4.jar and db2jcc_license_cisuz.jar

  • IBM DB2 for Linux, UNIX and Windows: db2jcc4.jar

  • Microsoft SQL Server

    • Java 6: sqldbc4.jar

    • Java 7 or Java 8: sqldbc.jar

  • Oracle

    • Java 6: ojdbc6.jar

    • Java 7 or Java 8: ojdbc7.jar

  • PostgreSQL
    • PostgreSQL 9.1: postgresql-9.1.903.jdbc4.jar
    • PostgreSQL 9.3: postgresql-9.3.1103.jdbc3.jar
    • PostgreSQL 9.4: postgresql-9.4.1207.jre6.jar, postgresql-9.4.1207.jre7.jar, or postgresql-9.4.1207.jar
--driverClass pega.jdbc.driver.class
ClosedClass of the JDBC driver:
  • IBM DB2 for Linux, UNIX, and Windows and IBM DB2 for z/OS: com.ibm.db2.jcc.DB2Driver
  • Microsoft SQL: com.microsoft.sqlserver.jdbc.SQLServerDriver
  • Oracle: oracle.jdbc.OracleDriver
  • PostgreSQL: org.postgresql.Driver
--dbType pega.database.type
ClosedDatabase vendor type:
  • IBM DB2 for Linux, UNIX, and Windows: udb
  • Microsoft SQL Server: mssql
  • Oracle: oracledate
  • PostgreSQL or Enterprise DB: postgres
  • IBM DB2 for z/OS: db2zos
--dburl pega.jdbc.url
ClosedThe database JDBC URL:
  • Oracle: jdbc:oracle:thin:@//localhost:port/service-name-or-SID
  • Microsoft SQL Server: url="jdbc:sqlserver://server:port;DatabaseName=database;selectMethod=cursor; sendStringParametersAsUnicode=false"
  • IBM DB2: jdbc:db2://server:port/database
  • PostgreSQL: jdbc:postgresql://server:port/database

  • IBM DB2 for z/OS: jdbc:db2://host:port/database
--dbuser pega.jdbc.username

User name of the Deployment user.
--dbpassword pega.jdbc.password

Password of the Deployment user.

no script argument available pega.platform.userids.issecure

For new installations, specifies whether to deploy in secured mode. For more information, see your deployment guide.
--dbSchema rules.schema.name

In a single schema environment, sets rules schema and data schema.

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

--dbDataSchema data.schema.name For split-schema configurations only, sets the data schema name.
--tempdir user.temp.dir Optional: The location of the temp directory. Set this location to any accessible location, for example, C:\TEMP.
--mtSystem multitenant.system

Specifies whether this a multitenant system.

IBM DB2 for z/OS does not support multitenant systems.
pega.zos.properties

z/OS site specific properties file.

 IBM for z/OS only: The full path and file name to the DB2SiteSpecific.propertiesfile.
--connProperties jdbc.custom.connection.properties

Optional: Semicolon-delimited list of custom JDBC properties.

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

Additional upgrade and update properties

These properties have no corresponding command-line arguments.

Property Description
db2zos.udf.wlm Workload manager to load user-defined functions into IBM DB2 for z/OS.
bypass.pega.schema To bypass both creating a temporary schema and automatically generating the user-defined functions, set bypass.pega.schema to true. This implies that the DDL is already applied. To create a temporary schema and automatically generate the UDFs, leave this property blank or set it to false.
bypass.udf.generation If you set bypass.pega.schema to false to create the temporary schema, but still want to bypass automatically generating the user-defined functions, set bypass.udf.generation to true.
rebuild.indexes Rebuilds database rules indexes after the rules load to improve database access performance. If rebuild.indexes=false, you can rebuild the indexes later by running the stored procedure SPPR_REBUILD_INDEXES. The amount of time this process adds to the upgrade depends on the size of your database.
update.existing.applications For upgrades and updates from Pega 7.x, specifies whether to run the Update Existing Application utility to ensure that your existing applications take advantage of new functionality in thePega Platform. The default setting is false.
update.applications.schema

Specifies whether to run the Update Applications Schema utility to update the cloned Rule, Data, Work and Work history tables with the schema changes in the latest base tables as part of the upgrade or update. You can also run this utility later from the prpcUtils.bat or prpcUtils.sh script, or from the Designer Studio. The default setting is false.

IBM-DB2 for z/OS does not support running the utility as part of the upgrade or update.
run.ruleset.cleanup Removes older rules. In most cases, removing older rules decreases the overall upgrade time. Running the cleanup script permanently removes rules older than the current version from which you are upgrading. For example, if you are upgrading from 6.2 SP2 (06-02-20), cleanup removes rules of version 06-01-99 and older.

reversal.schema.file.name

 Schema file name to be used for reversal.
automatic.resume If the upgrade or update fails, specifies whether the system restarts from the step where the failure occurred. The default value is true.

Open topic with navigation