Use an active instance of the Pega 7 Platform with a command-line script to import or export an archive file, manage hotfixes, or expose a (top-level Single Value) property as a database column, and have the system populate the newly exposed column automatically. Service-enabled system management allows asynchronous workflows and faster operations.
The prpcServiceUtils.bat or prpcServiceUtils.sh script enables you to use a REST service to import and export applications, products, or rulesets, and manage hotfixes for remote system management on multiple targets. You can also use this tool to expose columns and populate data.
Configure the script actions in the prpcServiceUtils.properties file. After you run the prpcServiceUtils.bat or prpcServiceUtils.sh script, the system returns a response with status and log information, or a job ID if the operation is asynchronous. Use a connection.properties file to specify 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.
This feature supports both synchronous and asynchronous exports:
Synchronous exports automatically download the archive file to the client system after the export is complete in the target system.
Asynchronous exports download the archive file when you query the status of the job ID.
One request can export one archive file from one system. The archive file can contain a product, application, or ruleset.
You can roll back or commit data that has been imported using the import tool with the import.trackData property set to true.The tool lets you commit imported data, or roll back all non-committed data instances to their state immediately prior to when they were imported. The tool only tracks and supports rolling back data instances that do not belong to the PegaRULES database name (Data-Admin-DB-Name).
You can expose a property as a database column and have the system populate the newly exposed column automatically, or extract a property value from the Storage Stream or pzInskey (BLOB) column into a newly added table column. The prpcServiceUtils.bat or prpcServiceUtils.sh script can also rebuild Index- instances that are defined by Declare Index rules.
This improves performance when you have a running instance of the Pega 7 Platform in comparison with performing the same process using the Database Column Populator utility, which requires a connection to the database.
You can manage hotfixes on multiple Pega 7 Platform clusters simultaneously to reduce your maintenance window. You can manage the following hotfix operations: scan, install, rollback, commit, and generateDDL.
If you import or export asynchronously, the system generates a job ID. Use this job ID to check the status of the import or export and determine whether the job was successful.
The log files include information about whether a job was successful and include detailed information about job errors and warnings. The log files are stored in the client file system temp directory:
Configure the prpcServiceUtils.bat or prpcServiceUtils.sh script actions in the prpcServiceUtils.properties file. You can also pass arguments to the prpcServiceUtils.bat or prpcServiceUtils.sh script to override settings in the prpcServiceUtils.properties file.
Use the properties file to set property values for reuse to minimize errors in entering commands.
Use the script arguments to augment or override certain values in the property file, for example to customize one script action.