Exporting rules and data by using a direct connection to the database
To automate exporting rules and data by connecting directly to the database, complete the following steps. This method is most commonly done for a stopped instance.
-
Configure the common properties of the
prpcUtils.properties
file.
Property name Value pega.jdbc.driver.jar
Path to the database driver .jar file. pega.jdbc.driver.class
The database driver class. pega.database.type
Database vendor type. pega.jdbc.url
URL of your database. pega.jdbc.username
Database user name. pega.jdbc.password
Database password. rules.schema.name
If you use a split schema, the value for the rules schema name. If you do not use a split schema, the value for the schema name. data.schema.name
If you use a split schema, the value for the data schema name. - Specify the values for your export method:
-
To export by product, specify the
pzInsKey
of the Rule-Admin-Product:
Property name Value export.archive.productKey
The pzInsKey of the product rule ( Rule-Admin-Product ) to be exported. export.product.dataOnly
true
orfalse
. The default value,false
, exports rules, data, and database changes (DDL). Set this totrue
to export only the data. -
To export by application, specify the application name and version:
Property name Value export.application.context
The application name and version to export, for example: PegaRULES!07.10
-
To export by class name, specify these values:
Property name Value export.classes.included
A comma-separated list of the classes to be included. To export by classes, you must specify either export.classes.included
orexport.keys.file
; you cannot specify both.export.included.descendent
Optional: true
orfalse
. The default value,true
, exports the class and its descendants. Set this tofalse
to export only the parent class.export.classes.excluded
Optional: A comma-separated list of classes that you want to exclude. export.excluded.descendent
Optional: true
orfalse
. The default value,true
, exports the class and its descendants. Set this tofalse
to export only the parent class.export.startVersion
Optional: For rule-resolved instances of Rule-, the minimum ruleset version. For example, 07-10
export.endVersion
Optional: For rule-resolved instances of Rule-, the maximum ruleset version. For example, 07-10-31
export.keys.file
The full path to the file name specifying the values of pzInsKey to be exported, containing one pzInsKey per line. You must specify either export.classes.included
orexport.keys.file
; you cannot specify both.
-
To export by product, specify the
pzInsKey
of the Rule-Admin-Product:
- Save and close the prpcUtils.properties file.
- Run the prpcUtils.bat script or the
prpcUtils.sh script with the export or exportRAP option. Optionally, include the:
- If not exporting by product, enter this option:
prpcUtils.bat export
- If exporting by product, enter this option:
prpcUtils.bat exportRAP
Optional: Pass one or more arguments.
prpcUtils script argument Value connPropFile
The full path to the connection.properties file that includes information for multiple targets. driverClass
Your JDBC driver class (example: oracle.jdbc.OracleDriver). driverJAR
Location of your JDBC .jar file. dbType
Database vendor type (mssql, udb, oracledate, postgres, db2zos). dbURL
JDBC URL to the database. dbUser
Database user name. dbPassword
Database password. archivePath
Full path to the archive to be imported or exported. propFile
The full path to the properties file, to override the default prpcUtils.properties. hfixAction
If manageHotfixes is selected, sets the hotfix operation. Valid values are commit
,rollback
,generateDDL
,install
, andscan
.rulesSchema
The rules schema. dataSchema
The data schema. noFailOnError
Set to true
orfalse
. When enabled, instances that fail to import are skipped and import continues instead of failing.U
Pega user name. P
Pega password. accessGroup
AccessGroup in which the Rule-Declare-Index of the classes being exposed exists. Applicable for the expose utility if --U or --P are not provided. - If not exporting by product, enter this option: