Exporting products, applications, or branches from the command line

Use the prpcServiceUtils command-line tool to export an archive. One request can export one archive file from one system.

You can export in one of the following ways:

• By product
• By application
• By branch

To export archive files, follow these steps:

1. Configure the common properties in 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. Specify the archive file name and whether to export in asynchronous mode:

   Property name	Action
   export.archiveName	Enter the name of the archive file to export.
   export.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.

3. Optional: To export by product, specify the product name and version:

   Property name	Action
   export.productName	If you are exporting a product, enter the name of the product to export.
   export.productVersion	If you are exporting a product, enter the version of the product to export.

4. Optional: To export by application, specify a application name and version:

   Property name	Action
   export.applicationVersion	If you are exporting an application, enter the version of the application to export.
   export.applicationName	If you are exporting an application, enter the name of the application to export.

5. Optional: To export by branch, specify a branch name and application context:

   Property name	Action
   export.branchName	Enter the name of the branch to export.
   export.branchAppContext	Enter the application context of the branch ruleset to export. For example: PegaRULES:07.10

6. Save and close the prpcServiceUtils.properties file.

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

   prpcServiceUtils.bat export

   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.

The system downloads the exported archive file and saves the export log files to the logs directory.

Open topic with navigation