Importing rules and data by submitting a request to an active instance
Import archive files that contain an application, product, branch, or ruleset to one or multiple target systems by submitting a request to an active instance of Pega Platform from a web service.
- Your access group must have the SchemaImport privilege and the
dynamic system setting
database/AutoDBSchemaChangesmust be true.
- If your access group does not have the SchemaImport privilege or
the dynamic system setting
database/AutoDBSchemaChangesis false, the system does not apply the schema changes and the failure response indicates the reason for failure.
Use the REST service URL to configure one or multiple targets to receive an imported archive file.
Check that the following resources are available to you:
- A running Pega Platform instance
- Permission to do database changes
- The archive file that is accessible from the client system
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
Property name Value
The URL for the REST service, specified in the following format:
The operator name on the target system with access to REST services.
The password of the specified operator.
The host name of the REST proxy server. Do not use localhost as the host name.
The port for the REST proxy server.
The operator name on the REST proxy server with import and export access.
The password of the REST proxy operator.
The domain of the REST proxy server.
The workstation ID for the REST proxy server.
The REST response type, either
json. The default value is
json. Rollback, restore point, and update access group operations support only
Enter the full path to the temporary directory. Leave this blank to use the default temporary directory. For more information about temporary directories, see Temporary files and temporary files directories .
Configure the import properties.
Property name Value
When importing from a file system, 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.
The import mode:
import: (Default) Update existing instances and remove duplicates. Use the
import.existingInstancesproperty 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.
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.
Specify whether to continue the import after a failure and skip instances that fail to import. The default is
true. Set to
falseto stop the import if any import action fails.
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.
Specify whether to compile libraries after import. The default is
Specify whether to allow the import to continue even if the archive is dependent on missing products. The default is
Specify whether to import archives in the order specified in the import file. The default is
false, which does not enforce any order.
The name of the code set to receive the Java .class files.
The code set version.
Specifies whether to run the process in asynchronous mode or synchronous mode. The default,
true, is asynchronous, which returns a job ID that you can use later to check the job status. When this value is
false, the process starts immediately and waits until completion. The choice of synchronous or asynchronous depends on the type of script you are writing.
Indicates whether to bypass creating a restore point during an import. It is a best practice to create restore points. To maintain best practices, keep
import.skipBackupat the default setting,
Indicates whether to import from a repository. The default is
false, which imports from a file system. To import from a repository, set this to
When importing from a repository, the name of the repository. The repository name is case sensitive.
When importing from a repository, the artifact type you are importing. The supported types are
application, product, branch, component, rulesetversion.
When importing from a repository, the full path to the archive file. The archive path is case sensitive, for example:
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
As a best practice, and by default, new operators are disabled on import and existing operators are not updated. Setting this to true does not disable new operators and allows updates of existing operators.
Allow importing inherited database name instances. The default setting is
If an import adds columns to existing tables, bypass automatically exposing and populating the new columns during the import. The default setting is
If an import changes an existing class, bypass automatically making changes to descendent tables. The default setting is
Save and close the
prpcServiceUtils.batscript or the
prpcServiceUtils.shscript with the import option, for example:
Pass one or more arguments.
prpcServiceUtils script argument Value
The full path to the output file location, for those functions that generate output. The default is the
The full path to the
serviceConnection.propertiesfile that includes information for multiple targets.
The thread pool size. The default is 5.
The number of seconds the system waits for a response before failing with a time-out error. The default is 300 seconds.
The path to the job IDs file that is generated by the asynchronous operation.
The property file name, to override the default prpcServiceUtils.properties file.
Specify the operation that generated the job ID for getStatus: