Skip to main content


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

Exporting rules and data by using a direct connection to the database

Updated on May 11, 2022

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.

  1. Configure the common properties of the prpcUtils.properties file.

    Property name Value
    pega.jdbc.driver.jarPath to the database driver .jar file.
    pega.jdbc.driver.classThe database driver class.
    pega.database.typeDatabase vendor type.
    pega.jdbc.urlURL of your database.
    pega.jdbc.usernameDatabase user name.
    pega.jdbc.password Database password.
    rules.schema.nameIf 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.nameIf you use a split schema, the value for the data schema name.
  2. Specify the values for your export method:
    • To export by product, specify the pzInsKey of the Rule-Admin-Product:

      Property nameValue
      export.archive.productKeyThe pzInsKey of the product rule ( Rule-Admin-Product ) to be exported.
      export.product.dataOnlytrue or false. The default value, false, exports rules, data, and database changes (DDL). Set this to true 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 nameValue
      export.classes.includedA comma-separated list of the classes to be included. To export by classes, you must specify either export.classes.included or export.keys.file; you cannot specify both.
      export.included.descendent

      true or false. The default value, true, exports the class and its descendants. Set this to false to export only the parent class.

      export.classes.excluded

      A comma-separated list of classes that you want to exclude.

      export.excluded.descendent

      true or false. The default value, true, exports the class and its descendants. Set this to false to export only the parent class.

      export.startVersion

      For rule-resolved instances of Rule-, the minimum ruleset version. For example, 07-10

      export.endVersion

      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 or export.keys.file; you cannot specify both.
  3. Save and close the prpcUtils.properties file.
  4. 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
    connPropFileThe full path to the connection.properties file that includes information for multiple targets.
    driverClassYour JDBC driver class. For example, oracle.jdbc.OracleDriver.
    driverJARLocation of your JDBC .jar file.
    dbTypeDatabase vendor type, such as mssql, udb, oracledate, postgres, and db2zos.
    dbURLJDBC URL to the database.
    dbUserDatabase user name.
    dbPasswordDatabase password.
    archivePathFull path to the archive to be imported or exported.
    propFileThe full path to the properties file, to override the default prpcUtils.properties.
    hfixActionIf manageHotfixes is selected, sets the hotfix operation. Valid values are commit, rollback, generateDDL, install, and scan.
    rulesSchemaThe rules schema.
    dataSchemaThe data schema.
    noFailOnErrorSet to true or false. When enabled, instances that fail to import are skipped and import continues instead of failing.
    UPega user name.
    PPega password.
    accessGroupAccessGroup in which the Rule-Declare-Index of the classes being exposed exists. Applicable for the expose utility if --U or --P are not provided.
  • Previous topic Exporting rules and data by submitting a request to an active instance
  • Next topic Importing rules and data from the command line

Related articles

Moving applications between systems

Tags

Pega Platform 8.6 System Administration

Have a question? Get answers now.

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

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

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