Importing archive files (service-enabled)

Use the prpcServiceUtils command-line tool to import an archive file containing an application, product, branch, or ruleset to one or multiple target systems.

Use the REST service URL to configure one or multiple targets to receive an imported archive file. This feature supports both synchronous and asynchronous imports.

• Synchronous imports are completely automatic.

• Asynchronous imports return a job ID that you can use to query the job status through another service.

You must have permissions to perform database changes and the archive file to import must be located on the client system. You can import multiple archive files into a system sequentially and you can use the expose feature to automate the provisioning of multiple applications.

To import an application, follow these steps:

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

   Property name	Action
   pega.rest.server.url	Enter the URL for the REST service in the following format: http://<hostname>:<port>/context/PRRestService/tenanthash Include the tenant hash only for multitenant systems.
   pega.rest.username	Enter the operator name on the target system with access to REST services.
   pega.rest.password	Enter the password of the specified operator.
   pega.rest.proxy.host	Optional. Enter the host name of the REST proxy server. Do not use localhost as the host name.
   pega.rest.proxy.port	Optional. Enter the port for the REST proxy server.
   pega.rest.proxy.username	Optional. Enter the operator name on the REST proxy server with import and export access.
   pega.rest.proxy.password	Optional. Enter the password of the REST proxy operator.
   pega.rest.proxy.domain	Optional. Enter the domain of the REST proxy server.
   pega.rest.proxy.workstation	Optional. Enter the workstation ID for the REST proxy server.
   pega.rest.response.type	Enter the REST response type, either xml or json. The default value is json.
   user.temp.dir	Optional: Enter the full path to the temporary directory. Leave this blank to use the default temporary directory.

2. Configure the import properties:

   Property name	Action
   import.archive.path	Enter 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	Enter the import mode: install: Import new instances. Do not import or update existing instances. The log file includes an exception message for each instance that already exists. import: (Default) Update existing instances and remove duplicates. Use the import.existingInstances property to override this setting. hotfix Update existing instances and remove duplicates. If the archive time stamp is older than the existing instance, either skip updating the instance or inserting the duplicate.
   import.existingInstances	Specify how the import action handles existing instances: override: Replace instances that already exist in different rulesets or versions. skip: (Default) Skip instances that already exist in different rulesets or versions.
   import.nofailonerror	Set to true to skip instances that fail to import and continue after an import failure. Set to false to stop the import if any import action fails.
   import.commitRate	Specify 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.compileLibraries	Specify whether to compile libraries after import. Default is true.
   import.allowImportWithMissingDependencies	Specify whether to allow the import to continue even if the archive is dependent on missing products. Default is false.
   import.enable.defaultcontext	Specify whether to allow triggers for the Pega Platform to run while performing command-line imports. Default is false. To allow triggers to run during imports, uncomment this property and set to true.
   import.codesetName	Optional: Enter the name of the code set to receive the Java .class files.
   import.codesetVersion	Optional: Enter the code set version.
   import.async	Specify whether to run the process in asynchronous mode and queue the jobs. Set to true (default) to return a job ID for each operation that you can use later to check the status.
   import.trackData	Specify whether to import only data, that is, anything that is not in PegaRULES. When set to true, data, including DDL changes, is imported and tracked. Use the manage tracked data tool to commit or roll back tracked data.

3. Save and close the prpcServiceUtils.properties file.

4. Run the prpcServiceUtils.bat or prpcServiceUtils.sh script. For example:

   prpcServiceUtils.bat import

   You can also pass one or more arguments:

   prpcServiceUtils script argument	Action
   artifactDir	Enter the full path to the output file location. The default is the /scripts/utils/logs directory.
   connPropFile	Enter the full path to the serviceConnection.properties file that includes information for multiple targets.
   poolSize	Enter the thread pool size. Default is 5.
   requestTimeOut	Specify how long the system waits for a response before failing with a timeout error. Default is 300 seconds.
   jobIdFile	Enter the path to the job IDs file that is generated by the asynchronous operation.

Open topic with navigation