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

Use the prpcUtils tool to import rules and data by connecting directly to the database. This is most commonly done for a stopped instance.

Before you begin:

Before you import an archive, review the content of the archive to better understand the potential issues associated with any uncapped ruleset versions.
Your access group must have the SchemaImport privilege and the dynamic system setting database/AutoDBSchemaChanges must be true.
If your access group does not have the SchemaImport privilege or the dynamic system setting database/AutoDBSchemaChanges is false, the system does not apply the schema changes and the failure response indicates the reason for failure.

Note: Do not import an archive into an active runtime instance of Pega Platform.

For IBM Db2 for z/OS, configure the import properties.

If you are importing an application with schema changes and a separate DB-Admin-DB-Name and you are using IBM Db2 for z/OS, configure the import parameters before you import the application, or the import will fail. For more information about configuring the import parameters, see IBM Db2 for z/OS: Preparing to import an application with schema changes and a separate DB-Admin-DB-Name. For more information about your application, see your database administrator.

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.

Configure the required properties of the prpcUtils.properties file.

Property name	Value
`import.archive.path`	The relative path to the archive from the \utils\ folder or the full path to the archive. If the path is a folder, the tool processes all archive files in that folder.
`import.mode`	The import mode: `import`: (Default) Update existing instances and remove duplicates. Use the `import.existing.instances` property to override this setting. `install`: Import new instances. Do not import or update existing instances. The log file includes an exception message for each instance that already exists. hotfix : Update existing instances and remove duplicates. If the archive time stamp is older than the existing instance, skip updating the instance or inserting the duplicate.
`import.existing.instances`	How the import action handles existing instances: `skip`: (Default) Skip instances that already exist in different rulesets or versions. `override`: Replace instances that already exist in different rulesets or versions.
`import.codesetName`	The name of the code set to receive the Java .class files.
`import.codeset.version`	The code set version to receive the Java .class files, for example: `01-01-01`

Optional: Configure the optional properties of the prpcUtils.properties file.

Property name	Value
`import.nofailonerror`	Specify whether to continue the import after a failure and skip instances that fail to import. The default is `true`. Set to `false` to stop the import if any import action fails. The default is `false` , which will fail on error.
`import.commit.count`	The number of data instances processed with each database commit to balance memory usage and performance. The default of 100 is sufficient for most environments.
`import.compile.libraries`	Specify whether to compile libraries after import. The default is `true`.
`import.allowImportWithMissingDependencies`	Specify whether to allow the import to continue even if the archive is dependent on missing products. The default is `false`.
`import.preserveOrder`	Specify whether to import archives in the order specified in the import file. The default is `false`, which does not enforce any order.
`import.bypassSchema`	Specify whether to apply database schema changes during the import. The default is `false`. If you have already applied the schema changes manually, set this to `true`.
`import.skipBackup`	Specify whether to bypass saving history points and creating restore points during import. As a best practice, leave this set to the default, `false`, to save history points and create restore points.
`import.enable.defaultcontext`	Specify whether to allow triggers for Pega Platform to run while performing command-line imports. The default is `false`. To allow triggers to run during imports, uncomment this property and set to `true`.
`import.insecureOperators`	As a best practice, and by default, new operators are disabled on import and existing operators are not updated. Setting `import.insecureOperators` to `true` does not disable new operators and allows updates of existing operators.
`import.allow.inherited.connections`	Specify whether to import inherited database name instances. The default setting is `false`.
`import.bypass.column.population`	If an import adds columns to existing tables, specify whether to bypass automatically exposing and populating the new columns during the import. The default setting is `false`.
`import.bypass.schema.changes.to.descendant.tables`	Optional. If an import changes an existing class, specify whether to bypass automatically making changes to descendent tables. The default setting is `false`.

Save and close the prpcUtils.properties file.

Run the prpcUtils.bat or prpcUtils.sh script with the import option, for example:

prpcUtils.bat import

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`, and `scan`.
`rulesSchema`	The rules schema.
`dataSchema`	The data schema.
`noFailOnError`	Set to `true` or `false`. 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.