setupDatabase properties and arguments
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 argument | Property | Description |
|---|---|---|
| --driverJAR | pega.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 |
| --driverClass | pega.jdbc.driver.class | Class of the JDBC driver |
| --dbType | pega.database.type | Database 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 |
| --dbURL | pega.jdbc.url | The database JDBC URL. For more information, see your deployment guide. |
| --dbUser | pega.jdbc.username | User name of the Deployment user. |
| --dbPassword | pega.jdbc.password | Password of the Deployment user. For encrypted passwords, leave this blank. |
| --adminPassword | pega.admin.password | For new installations only. The initial password for [email protected]. If you do not set this password before you install, the installation fails. |
| jdbc.custom.connection.properties | Optional: Semicolon-delimited list of custom JDBC properties for
installations. (for example: prop1=value;prop2=value;prop3=value) |
|
| --rulesSchema | rules.schema.name | In a single schema environment, sets rules schema and data schema. In a split-schema configuration, sets the rules schema only. |
| --dataSchema | data.schema.name | For split-schema configurations only, sets the data schema name. |
| --customerDataSchema | customerdata.schema.name | An optional customer data schema separate from the default Pega data schema. |
| user.temp.dir | Optional: 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. | |
| --mtSystem | multitenant.system | Specifies whether this a multitenant system. IBM Db2 for z/OS does not support multitenant systems. |
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 the upgrade schema and automatically generating the
user-defined functions, set bypass.pega.schema to
true. This implies that the upgrade DDL is already applied.
To create the upgrade 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 upgrade 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 | Set to true to run the Update Existing Applications utility. Run the Update Existing Application utility to ensure that your existing applications take advantage of new functionality in Pega. Run the utility first on your development system and test the changes. Then, run the utility again on the production system. The specific actions required for your application depend on your current version. You can also run this utility later from the Designer Studio. 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 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; set update.applications.schema to false and use the prpcUtils.bat or prpcUtils.sh script or the Designer Studio to run the Update Applications Schema utility after the upgrade or update. For more information, see the online help. |
| 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 PRPC 6.2 SP2 (06-02-20) to 7.4, 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 the upgrade or update from the step where the failure occurred. The default value is true. |